From 3d51ec79283e0f8e3ad4d5f42bedca6edc8f88ea Mon Sep 17 00:00:00 2001 From: Leslie Poff Date: Fri, 27 Jun 2025 14:12:24 -0400 Subject: [PATCH 1/3] LGP - added ModelCenter java api --- 2025R2/modelCenter_java_api/change_log.md | 4 + .../aserver/IPHXAlwaysWriteable.md | 13 + .../com/phoenix_int/aserver/IPHXAnalysis.md | 37 + .../com/phoenix_int/aserver/IPHXComponent.md | 44 + .../com/phoenix_int/aserver/IPHXDriver.md | 59 + .../aserver/IPHXHaltableComponent.md | 28 + .../phoenix_int/aserver/IPHXMonitorable.md | 56 + .../com/phoenix_int/aserver/IPHXRunQueue.md | 31 + .../phoenix_int/aserver/IPHXSelfManager.md | 110 + .../phoenix_int/aserver/IPHXSelfManager2.md | 68 + .../phoenix_int/aserver/IPHXSelfManager3.md | 50 + .../phoenix_int/aserver/IPHXSetupFromFile.md | 36 + .../phoenix_int/aserver/PHXComponentBranch.md | 150 ++ .../aserver/PHXComponentDescription.md | 251 ++ .../aserver/PHXComponentVersion.md | 73 + .../phoenix_int/aserver/PHXDFTException.md | 40 + .../com/phoenix_int/aserver/PHXGroup.md | 309 +++ .../aserver/PHXInvalidNameException.md | 78 + .../phoenix_int/aserver/PHXInvokeReturn.md | 94 + .../aserver/PHXMethodDescriptor.md | 120 + .../aserver/PHXNameAlreadyInUseException.md | 45 + .../aserver/PHXNoSuchObjectException.md | 69 + .../PHXNoSuchWriteableObjectException.md | 49 + .../aserver/PHXPropertyDescriptor.md | 267 ++ .../aserver/PHXRunShare.RunInfo.md | 58 + .../com/phoenix_int/aserver/PHXRunShare.md | 519 ++++ .../aserver/PHXSimpleSelfManager.md | 599 +++++ .../aserver/PHXSimpleSelfManager2.md | 52 + .../aserver/PHXSimpleSelfManager3.md | 104 + .../phoenix_int/aserver/PHXVariableInfo.md | 99 + .../aserver/ProcessHaltedException.md | 31 + .../client/IPHXAnalysisClientListener.md | 44 + .../aserver/client/PHXAnalysisClient.md | 2253 +++++++++++++++++ .../aserver/client/PHXAnalysisClientEvent.md | 56 + .../client/PHXAnalysisClientExceptionEvent.md | 55 + .../client/PHXNoSuchResponseException.md | 51 + .../aserver/client/PHXPropertyValue.md | 81 + .../PHXResponseTypeMismatchException.md | 52 + .../aserver/client/PHXServerSideException.md | 53 + .../aserver/client/package-summary.md | 31 + .../aserver/client/package-tree.md | 24 + .../aserver/client/v2/AnalysisServerClient.md | 1792 +++++++++++++ .../client/v2/AnalysisServerException.md | 75 + .../client/v2/AnalysisServerResponse.md | 329 +++ .../client/v2/AnalysisServerResponseType.md | 127 + .../client/v2/AnalysisServerVersion.md | 116 + .../client/v2/AnalysisServerWaitCallback.md | 107 + .../client/v2/AnalysisVariableValue.md | 111 + .../client/v2/IAnalysisServerCallback.md | 37 + .../aserver/client/v2/package-summary.md | 28 + .../aserver/client/v2/package-tree.md | 26 + .../aserver/library/IPHXFactory.md | 124 + .../aserver/library/IPHXLibrarian.md | 174 ++ .../aserver/library/IPHXVersionedLibrarian.md | 65 + .../library/IPHXVersionedLibrarian2.md | 48 + .../aserver/library/PHXCVSLibrarian.md | 414 +++ .../aserver/library/PHXDirectoryLibrarian.md | 348 +++ .../aserver/library/PHXLibrarianCombiner.md | 337 +++ .../aserver/library/PHXLibrarianMounter.md | 345 +++ .../library/PHXNoSuchAssociationException.md | 61 + .../library/PHXNoSuchCategoryException.md | 92 + .../aserver/library/PHXNoSuchIconException.md | 61 + .../aserver/library/PHXUserDirLibrarian.md | 300 +++ .../aserver/library/package-frame.md | 0 .../aserver/library/package-summary.md | 35 + .../aserver/library/package-tree.md | 23 + .../aserver/monitors/IPHXFileCallback.md | 39 + ...XFileMonitor.FileMonitorChangeException.md | 52 + .../aserver/monitors/PHXFileMonitor.md | 135 + .../PHXMonitorableStream.MonitorWriter.md | 76 + .../aserver/monitors/PHXMonitorableStream.md | 142 ++ .../aserver/monitors/package-frame.md | 0 .../aserver/monitors/package-summary.md | 20 + .../aserver/monitors/package-tree.md | 18 + .../phoenix_int/aserver/package-summary.md | 48 + .../com/phoenix_int/aserver/package-tree.md | 44 + .../aserver/types/IPHXDescription.md | 56 + .../phoenix_int/aserver/types/IPHXFormat.md | 62 + .../aserver/types/IPHXRefPropInfo.md | 130 + .../com/phoenix_int/aserver/types/IPHXType.md | 50 + .../aserver/types/IPHXType2.IVisitor.md | 158 ++ .../phoenix_int/aserver/types/IPHXType2.md | 82 + .../phoenix_int/aserver/types/IPHXUnits.md | 55 + .../aserver/types/PHXAppearance.md | 100 + .../phoenix_int/aserver/types/PHXBoolean.md | 246 ++ .../aserver/types/PHXBooleanArray.md | 259 ++ .../aserver/types/PHXDataCollector.md | 62 + .../phoenix_int/aserver/types/PHXDouble.md | 519 ++++ .../aserver/types/PHXDoubleArray.md | 537 ++++ .../com/phoenix_int/aserver/types/PHXFile.md | 289 +++ .../phoenix_int/aserver/types/PHXGeomInfo.md | 83 + .../phoenix_int/aserver/types/PHXGeometry.md | 249 ++ .../phoenix_int/aserver/types/PHXInteger.md | 487 ++++ .../aserver/types/PHXInvalidTypeException.md | 57 + .../com/phoenix_int/aserver/types/PHXLong.md | 492 ++++ .../phoenix_int/aserver/types/PHXLongArray.md | 561 ++++ .../aserver/types/PHXMassProperties.md | 176 ++ .../aserver/types/PHXNumberFormatException.md | 44 + .../aserver/types/PHXObjectArray.md | 235 ++ .../aserver/types/PHXOrientation.md | 144 ++ .../phoenix_int/aserver/types/PHXRawFile.md | 896 +++++++ .../aserver/types/PHXRawFileArray.md | 984 +++++++ .../aserver/types/PHXRefArrayProperty.md | 197 ++ .../aserver/types/PHXRefProperty.md | 219 ++ .../phoenix_int/aserver/types/PHXReference.md | 321 +++ .../aserver/types/PHXReferenceArray.md | 299 +++ .../aserver/types/PHXScriptObject.md | 1106 ++++++++ .../aserver/types/PHXSimpleArray.md | 861 +++++++ .../aserver/types/PHXSimpleType.md | 202 ++ .../phoenix_int/aserver/types/PHXString.md | 355 +++ .../aserver/types/PHXStringArray.md | 353 +++ .../aserver/types/PHXTypeFactory.md | 343 +++ .../aserver/types/PHXTypeMismatchException.md | 80 + .../aserver/types/package-frame.md | 0 .../aserver/types/package-summary.md | 90 + .../phoenix_int/aserver/types/package-tree.md | 48 + .../phoenix_int/aserver/util/IPHXLineStore.md | 49 + .../aserver/util/IPHXStringReplacer.md | 38 + .../aserver/util/PHXClassNotFoundException.md | 81 + .../phoenix_int/aserver/util/PHXFileLoader.md | 175 ++ .../phoenix_int/aserver/util/PHXFileName.md | 122 + .../phoenix_int/aserver/util/PHXFileParser.md | 1130 +++++++++ .../aserver/util/PHXGetByUrlException.md | 66 + .../com/phoenix_int/aserver/util/PHXIcon.md | 126 + .../aserver/util/PHXNameDivider.md | 88 + .../util/PHXNoSuchReplacementException.md | 54 + .../aserver/util/PHXNoSuchTokenException.md | 87 + .../phoenix_int/aserver/util/PHXProcess.md | 235 ++ .../aserver/util/PHXProcessInfo.md | 154 ++ .../phoenix_int/aserver/util/PHXRuntime.md | 143 ++ .../aserver/util/PHXStringBuffer.md | 419 +++ .../aserver/util/PHXStringReplacer.md | 78 + .../aserver/util/PHXStringTokenizer.md | 379 +++ .../phoenix_int/aserver/util/Parser.Mode.md | 183 ++ .../com/phoenix_int/aserver/util/Parser.md | 49 + .../aserver/util/package-summary.md | 40 + .../phoenix_int/aserver/util/package-tree.md | 39 + .../util/scriptwrapper/api/AbstractFile.md | 381 +++ .../util/scriptwrapper/api/CAEOutputFile.md | 188 ++ .../util/scriptwrapper/api/IPHXRange.md | 68 + .../api/IPHXRangeChangeListener.md | 31 + .../util/scriptwrapper/api/InputFile.md | 73 + .../util/scriptwrapper/api/OutputFile.md | 81 + .../util/scriptwrapper/api/OutputFile2.md | 50 + .../util/scriptwrapper/api/PHXBookmark.md | 120 + .../api/PHXBookmarkNotFoundException.md | 52 + .../util/scriptwrapper/api/PHXCAERange.md | 146 ++ .../util/scriptwrapper/api/PHXRowFieldFile.md | 1014 ++++++++ .../scriptwrapper/api/PHXRowFieldRange.md | 447 ++++ .../scriptwrapper/api/PHXRunShareContext.md | 66 + .../api/PHXScriptWrapperAPIException.md | 53 + .../api/PHXScriptWrapperObject.md | 467 ++++ .../util/scriptwrapper/api/PHXSection.md | 144 ++ .../api/PHXSectionNotFoundException.md | 52 + .../scriptwrapper/api/PHXVersionException.md | 56 + .../scriptwrapper/api/ParseableFile.Mode.md | 133 + .../util/scriptwrapper/api/ParseableFile.md | 127 + .../util/scriptwrapper/api/XPathFile.md | 327 +++ .../util/scriptwrapper/api/package-summary.md | 47 + .../util/scriptwrapper/api/package-tree.md | 39 + .../com/phoenix_int/pacz/api/Environment.md | 126 + .../phoenix_int/pacz/api/IComponentConfig.md | 260 ++ .../com/phoenix_int/pacz/api/IInstanceFile.md | 42 + .../phoenix_int/pacz/api/IRuntimeVariable.md | 294 +++ .../pacz/api/RunFolderPreference.md | 129 + .../phoenix_int/pacz/api/VariableDataType.md | 226 ++ .../phoenix_int/pacz/api/package-summary.md | 204 ++ .../com/phoenix_int/pacz/api/package-tree.md | 23 + .../phoenix_int/pacz/api/v2/Environment.md | 128 + .../pacz/api/v2/IComponentConfig.md | 356 +++ .../phoenix_int/pacz/api/v2/IInstanceFile.md | 42 + .../pacz/api/v2/IRuntimeVariable.md | 184 ++ .../pacz/api/v2/RunFolderPreference.md | 110 + .../pacz/api/v2/package-summary.md | 207 ++ .../phoenix_int/pacz/api/v2/package-tree.md | 29 + .../util/BufferedRandomAccessFile.md | 231 ++ .../com/phoenix_int/util/PHXBlocker.md | 156 ++ ...ternationalize.InternationalizedMessage.md | 38 + .../phoenix_int/util/PHXInternationalize.md | 110 + .../phoenix_int/util/PHXNewLineAddFilter.md | 94 + .../com/phoenix_int/util/PHXNewLineFilter.md | 92 + .../com/phoenix_int/util/package-summary.md | 15 + .../com/phoenix_int/util/package-tree.md | 17 + .../modelCenter_java_api/constant-values.md | 124 + .../modelCenter_java_api/deprecated-list.md | 67 + 2025R2/modelCenter_java_api/docfx.json | 13 + 2025R2/modelCenter_java_api/index-all.md | 2175 ++++++++++++++++ 2025R2/modelCenter_java_api/index.md | 87 + .../modelCenter_java_api/overview-summary.md | 22 + 2025R2/modelCenter_java_api/overview-tree.md | 201 ++ .../modelCenter_java_api/serialized-form.md | 286 +++ 2025R2/modelCenter_java_api/toc.yaml | 404 +++ 192 files changed, 37868 insertions(+) create mode 100644 2025R2/modelCenter_java_api/change_log.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXDFTException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNameAlreadyInUseException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXNoSuchResponseException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXPropertyValue.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXServerSideException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-frame.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-frame.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-frame.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXClassNotFoundException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileLoader.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileName.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXGetByUrlException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXIcon.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNameDivider.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcess.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringReplacer.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringTokenizer.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IInstanceFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/RunFolderPreference.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/BufferedRandomAccessFile.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineAddFilter.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md create mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md create mode 100644 2025R2/modelCenter_java_api/constant-values.md create mode 100644 2025R2/modelCenter_java_api/deprecated-list.md create mode 100644 2025R2/modelCenter_java_api/docfx.json create mode 100644 2025R2/modelCenter_java_api/index-all.md create mode 100644 2025R2/modelCenter_java_api/index.md create mode 100644 2025R2/modelCenter_java_api/overview-summary.md create mode 100644 2025R2/modelCenter_java_api/overview-tree.md create mode 100644 2025R2/modelCenter_java_api/serialized-form.md create mode 100644 2025R2/modelCenter_java_api/toc.yaml diff --git a/2025R2/modelCenter_java_api/change_log.md b/2025R2/modelCenter_java_api/change_log.md new file mode 100644 index 0000000000..95ce512130 --- /dev/null +++ b/2025R2/modelCenter_java_api/change_log.md @@ -0,0 +1,4 @@ +# Change Log + +## 2025 R2 +- added ModelCenter JAVA API to developer page \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md new file mode 100644 index 0000000000..e3c2a6a2f9 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md @@ -0,0 +1,13 @@ +# Interface: IPHXAlwaysWriteable + +**Package:** `com.phoenix_int.aserver` + +**Known Implementing Classes** +- `PHXReference`, `PHXReferenceArray` + +**Declaration** +```java +public interface IPHXAlwaysWriteable +``` + +This is a specialized interface for the ModelCenter Remote Execution. If an object implements this interface, its writeable properties will be writeable regardless of whether any parent properties are writeable or not. Normally a property is only writeable if it is writeable and all of its parent objects are also writeable. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md new file mode 100644 index 0000000000..16df9e73bf --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md @@ -0,0 +1,37 @@ +# Interface: IPHXAnalysis + +**Package:** `com.phoenix_int.aserver` + +**Superinterfaces** +- `IPHXComponent` + +**Declaration** +```java +public interface IPHXAnalysis + extends IPHXComponent +``` + +This is the interface that analyses managed by the ModelCenter Remote Execution must implement. + +If you also want to support Athena, you should extend `IPHXAthenaAnalysis` instead. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `execute()`
Executes the analysis. | + +### Methods inherited from interface `com.phoenix_int.aserver.IPHXComponent` +`end` + +## Method Detail + +### execute +```java +void execute() + throws java.lang.Exception +``` +Executes the analysis. If the analysis does not run successfully, e.g. the solution does not converge, then an exception should be thrown. + +**Throws:** +- `java.lang.Exception` - thrown if the function does not complete successfully \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md new file mode 100644 index 0000000000..75bcd842c6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md @@ -0,0 +1,44 @@ +# Interface: IPHXComponent + +**Package:** `com.phoenix_int.aserver` + +**Known Subinterfaces** +- `IPHXAnalysis`, `IPHXDriver` + +**Known Implementing Classes** +- `PHXSimpleSelfManager`, `PHXSimpleSelfManager2`, `PHXSimpleSelfManager3` + +**Declaration** +```java +public interface IPHXComponent +``` + +This is a common base interface for things served on the ModelCenter Remote Execution. + +In addition to the functions specified by this interface, the following static functions may also be defined to provide additional information about a component: +- `public static String getVersion()` — retrieves the version of the component. +- `public static String getAuthor()` — retrieves the author of the component. +- `public static String getDescription()` — retrieves a one-line description of the component. +- `public static String getHelpURL()` — retrieves a URL associated with the component. +- `public static String getKeywords()` — retrieves keywords associated with the component. +- `public static String getIconFile()` — retrieves the name of a 64x64 bmp file used to represent the component as an icon in graphical environments. + +The above functions are used by the "describe" command in the ModelCenter Remote Execution. If not defined, default values are used. The functions are all static so that they may be called without instantiating the component. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `end()`
Notifies the driver that it has ended. | + +## Method Detail + +### end +```java +void end() + throws java.lang.Exception +``` +Notifies the driver that it has ended. The driver should perform any necessary shutdown functions. + +**Throws:** +- `java.lang.Exception` - thrown if the function does not complete successfully \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md new file mode 100644 index 0000000000..98c7b86c57 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md @@ -0,0 +1,59 @@ +# Interface: IPHXDriver + +**Package:** `com.phoenix_int.aserver` + +**Superinterfaces** +- `IPHXComponent` + +**Declaration** +```java +public interface IPHXDriver + extends IPHXComponent +``` + +This is the interface that drivers managed by ModelCenter Remote Execution must implement. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `boolean` | `endIteration()`
Performs the second step for an iteration of a driver. | +| `void` | `initializeIterations()`
Initializes the driver to a starting state. | +| `void` | `startIteration()`
Performs the first step for an iteration of a driver. | + +### Methods inherited from interface `com.phoenix_int.aserver.IPHXComponent` +`end` + +## Method Detail + +### initializeIterations +```java +void initializeIterations() + throws java.lang.Exception +``` +Initializes the driver to a starting state. This function will be called once before a series of step() calls will be made. The function should reset things like iteration counts to initial values. + +**Throws:** +- `java.lang.Exception` - thrown if the function does not complete successfully + +### startIteration +```java +void startIteration() + throws java.lang.Exception +``` +Performs the first step for an iteration of a driver. The driver should set values for all output reference variables. The client application will load these values and compute new values for the input references. + +**Throws:** +- `java.lang.Exception` - thrown if the function does not complete successfully + +### endIteration +```java +boolean endIteration() + throws java.lang.Exception +``` +Performs the second step for an iteration of a driver. Prior to calling this function, the client application will have set values for all input reference variables. The driver should use these values to determine the next iteration, if any. + +Returns true if another iteration needs to be performed, false if the driver is complete. + +**Throws:** +- `java.lang.Exception` - thrown if the function does not complete successfully \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md new file mode 100644 index 0000000000..0b4b14642e --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md @@ -0,0 +1,28 @@ +# Interface: IPHXHaltableComponent + +**Package:** `com.phoenix_int.aserver` + +**Declaration** +```java +public interface IPHXHaltableComponent +``` + +This is a specialized interface for the ModelCenter Remote Execution. If a component implements this interface, the MCRE will call this method if a connection is lost prior to ending the component. The method is useful to halt components that are currently running when a connection is lost. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `halt()`
Notifies the component to stop doing whatever it is currently doing. | + +## Method Detail + +### halt +```java +void halt() + throws java.lang.Exception +``` +Notifies the component to stop doing whatever it is currently doing. + +**Throws:** +- `java.lang.Exception` - thrown if the function does not complete successfully \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md new file mode 100644 index 0000000000..812558e8d2 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md @@ -0,0 +1,56 @@ +# Interface: IPHXMonitorable + +**Package:** `com.phoenix_int.aserver` + +**Known Implementing Classes** +- `PHXRunShare`, `PHXRunShareContext` + +**Declaration** +```java +public interface IPHXMonitorable +``` + +This is the interface that analyses which provide information about running processes should implement. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.Object` | `getMonitor(java.lang.String monitorName)`
Gets a specified monitor. | +| `java.lang.String[]` | `listMonitorableFiles()`
Lists all items that may be monitored for output as a component is running. | +| `PHXProcessInfo[]` | `listProcesses()`
Lists all the running processes associated with a component. | + +## Method Detail + +### listProcesses +```java +PHXProcessInfo[] listProcesses() + throws java.io.IOException +``` +Lists all the running processes associated with a component. + +**Throws:** +- `java.io.IOException` - If there was a problem reading information about running processes + +### listMonitorableFiles +```java +java.lang.String[] listMonitorableFiles() + throws java.io.IOException +``` +Lists all items that may be monitored for output as a component is running. Note that this is normally in addition to any PHXRawFile output variables that your component exposes. Because of this, these names must not conflict with any variable names. + +**Throws:** +- `java.io.IOException` + +### getMonitor +```java +java.lang.Object getMonitor(java.lang.String monitorName) + throws PHXNoSuchObjectException +``` +Gets a specified monitor. This method can return PHXRawFile objects to publish files for monitoring that don't appear as a regular variable, or PHXMonitorableStream objects to publish random streams of monitor data. + +**Returns:** +- either a PHXRawFile or a PHXMonitorableStream object + +**Throws:** +- `PHXNoSuchObjectException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md new file mode 100644 index 0000000000..6b9890e118 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md @@ -0,0 +1,31 @@ +# Interface: IPHXRunQueue + +**Package:** `com.phoenix_int.aserver` + +**Declaration** +```java +public interface IPHXRunQueue +``` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `setRunQueue(java.lang.String connector, java.lang.String queue)`
Sets the run queue for a component. | + +## Method Detail + +### setRunQueue +```java +void setRunQueue(java.lang.String connector, java.lang.String queue) + throws java.lang.Exception +``` +Sets the run queue for a component. It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Parameters:** +- `connector` - The name of the selected connector +- `queue` - The name of the selected queue + +**Throws:** +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md new file mode 100644 index 0000000000..73fe7e6c41 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md @@ -0,0 +1,110 @@ +# Interface: IPHXSelfManager + +**Package:** `com.phoenix_int.aserver` + +**Known Subinterfaces** +- `IPHXSelfManager2`, `IPHXSelfManager3` + +**Known Implementing Classes** +- `PHXSimpleSelfManager`, `PHXSimpleSelfManager2`, `PHXSimpleSelfManager3` + +**Declaration** +```java +public interface IPHXSelfManager +``` + +This interface is for components that determine their properties at runtime. These types of components do not know what variables they have until they are started. Examples include wrappers that communicate with external programs—once the wrapper starts up, it loads a file into the external program. The external program then can be queried for its variables, which are then relayed through the analysis object. To handle this type of situation, a component should implement the functions provided by this interface. When present, the ModelCenter Remote Execution will call these functions. If an object does not implement this interface, the MCRE will use the default Bean mechanisms for interacting with the object. + +**See Also:** +- `IPHXComponent`, `IPHXAnalysis`, `IPHXDriver` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `PHXMethodDescriptor[]` | `getMethodDescriptors()`
Function for retrieving the methods of an object. | +| `PHXPropertyDescriptor[]` | `getPropertyDescriptors(java.lang.String name)`
Function for retrieving the properties of an object. | +| `java.lang.String` | `getValue(java.lang.String name)`
Function for retrieving a specified value. | +| `java.lang.String` | `invoke(java.lang.String methodName)`
Invokes the named method. | +| `void` | `setValue(java.lang.String name, java.lang.String value)`
Function for setting a specified value. | + +## Method Detail + +### getValue +```java +java.lang.String getValue(java.lang.String name) + throws PHXNoSuchObjectException, java.lang.Exception +``` +Function for retrieving a specified value. + +**Parameters:** +- `name` - the value to retrieve + +**Returns:** +- a String representation of the value + +**Throws:** +- `PHXNoSuchObjectException` - thrown if the specified name does not exist +- `java.lang.Exception` - an exception that may occur + +### setValue +```java +void setValue(java.lang.String name, java.lang.String value) + throws PHXNoSuchObjectException, PHXNoSuchWriteableObjectException, java.lang.Exception +``` +Function for setting a specified value. + +**Parameters:** +- `name` - the value to retrieve +- `value` - the String representation of the value to set + +**Throws:** +- `PHXNoSuchObjectException` - thrown if the specified name does not exist +- `PHXNoSuchWriteableObjectException` - thrown if the specified name cannot be modified +- `java.lang.Exception` - an exception that may occur + +### getPropertyDescriptors +```java +PHXPropertyDescriptor[] getPropertyDescriptors(java.lang.String name) + throws PHXNoSuchObjectException, java.lang.Exception +``` +Function for retrieving the properties of an object. + +**Parameters:** +- `name` - the object to retrieve descriptors for + +**Returns:** +- an array of PHXPropertyDescriptors + +**Throws:** +- `PHXNoSuchObjectException` - thrown if the specified name does not exist +- `java.lang.Exception` - an exception that may occur + +### getMethodDescriptors +```java +PHXMethodDescriptor[] getMethodDescriptors() + throws java.lang.Exception +``` +Function for retrieving the methods of an object. + +**Returns:** +- an array of MethodDescriptors + +**Throws:** +- `java.lang.Exception` - an exception that may occur + +### invoke +```java +java.lang.String invoke(java.lang.String methodName) + throws java.lang.Exception +``` +Invokes the named method. + +**Parameters:** +- `methodName` - the name of the method to invoke on obj + +**Returns:** +- the return value from the invocation + +**Throws:** +- `java.lang.Exception` - an exception that may occur \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md new file mode 100644 index 0000000000..4c9861c69f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md @@ -0,0 +1,68 @@ +# Interface: IPHXSelfManager2 + +**Package:** `com.phoenix_int.aserver` + +**Superinterfaces** +- `IPHXSelfManager` + +**Known Subinterfaces** +- `IPHXSelfManager3` + +**Known Implementing Classes** +- `PHXSimpleSelfManager2`, `PHXSimpleSelfManager3` + +**Declaration** +```java +public interface IPHXSelfManager2 + extends IPHXSelfManager +``` + +This interface extends IPHXSelfManager and provides new get and set functions which provide better performance than the original. + +**See Also:** +- `IPHXSelfManager` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.Object` | `getValue2(java.lang.String name)`
Function for retrieving a specified value. | +| `void` | `setValue2(java.lang.String name, PHXStringBuffer value)`
Function for setting a specified value. | + +### Methods inherited from interface `com.phoenix_int.aserver.IPHXSelfManager` +`getMethodDescriptors`, `getPropertyDescriptors`, `getValue`, `invoke`, `setValue` + +## Method Detail + +### getValue2 +```java +java.lang.Object getValue2(java.lang.String name) + throws PHXNoSuchObjectException, java.lang.Exception +``` +Function for retrieving a specified value. + +**Parameters:** +- `name` - the value to retrieve + +**Returns:** +- The value to be returned as any type of java Object. + +**Throws:** +- `PHXNoSuchObjectException` - thrown if the specified name does not exist +- `java.lang.Exception` - an exception that may occur + +### setValue2 +```java +void setValue2(java.lang.String name, PHXStringBuffer value) + throws PHXNoSuchObjectException, PHXNoSuchWriteableObjectException, java.lang.Exception +``` +Function for setting a specified value. + +**Parameters:** +- `name` - the value to retrieve +- `value` - the String representation of the value to set + +**Throws:** +- `PHXNoSuchObjectException` - thrown if the specified name does not exist +- `PHXNoSuchWriteableObjectException` - thrown if the specified name cannot be modified +- `java.lang.Exception` - an exception that may occur \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md new file mode 100644 index 0000000000..4771f540e8 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md @@ -0,0 +1,50 @@ +# Interface: IPHXSelfManager3 + +**Package:** `com.phoenix_int.aserver` + +**Superinterfaces** +- `IPHXSelfManager`, `IPHXSelfManager2` + +**Known Implementing Classes** +- `PHXSimpleSelfManager3` + +**Declaration** +```java +public interface IPHXSelfManager3 + extends IPHXSelfManager2 +``` + +This interface extends IPHXSelfManager2 and provides a new invoke that enables getting more information back from invoked methods. + +**See Also:** +- `IPHXSelfManager` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `PHXInvokeReturn` | `invoke2(java.lang.String methodName)`
Invokes the named method. | + +### Methods inherited from interface `com.phoenix_int.aserver.IPHXSelfManager2` +`getValue2`, `setValue2` + +### Methods inherited from interface `com.phoenix_int.aserver.IPHXSelfManager` +`getMethodDescriptors`, `getPropertyDescriptors`, `getValue`, `invoke`, `setValue` + +## Method Detail + +### invoke2 +```java +PHXInvokeReturn invoke2(java.lang.String methodName) + throws java.lang.Exception +``` +Invokes the named method. + +**Parameters:** +- `methodName` - the name of the method to invoke on obj + +**Returns:** +- the return object from the invocation + +**Throws:** +- `java.lang.Exception` - an exception that may occur \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md new file mode 100644 index 0000000000..46e9f9fe4f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md @@ -0,0 +1,36 @@ +# Interface: IPHXSetupFromFile + +**Package:** `com.phoenix_int.aserver` + +**Interface Hierarchy** +``` +↳ com.phoenix_int.aserver.IPHXSetupFromFile +``` + +**Declaration** +```java +public interface IPHXSetupFromFile +``` + +This interface defines the contract for components that can be set up or initialized from a file. Implementing classes provide mechanisms to configure themselves using external file-based data. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `setupFromFile(java.lang.String fileName)`
Set up the component using the specified file. | + +## Method Detail + +### setupFromFile +``` +public void setupFromFile(java.lang.String fileName) + throws java.io.IOException +``` +Sets up the component using the specified file. The file should contain the necessary configuration or data required for initialization. + +**Parameters:** +- `fileName` - The path to the file used for setup. + +**Throws:** +- `java.io.IOException` - If an I/O error occurs while reading the file. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md new file mode 100644 index 0000000000..7b0f76f2d5 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md @@ -0,0 +1,150 @@ +# Class: PHXComponentBranch + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXComponentBranch +``` + +**Declaration** +```java +public class PHXComponentBranch +extends java.lang.Object +``` + +This class represents a branch on a revision history tree for a version controlled component. Includes functionality for reading/writing XML branch descriptions. + +## Constructor Summary +| Constructor and Description | +|----------------------------| +| `PHXComponentBranch()`
Constructs an empty branch | +| `PHXComponentBranch(org.w3c.dom.Element branchElement)`
Constructs a branch based on an XML branch node | +| `PHXComponentBranch(java.lang.String name)`
Constructs an empty named branch | + +## Method Summary +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addVersion(PHXComponentVersion v)`
Adds a version to this branch | +| `PHXComponentBranch` | `findBranch(java.lang.String name)`
Finds any sub-branch that is part of any version in this branch by name | +| `PHXComponentVersion` | `findVersion(java.lang.String name)`
Finds a sub-version by the specified name | +| `void` | `fromXML(java.lang.String xmlString)`
Reads in an XML description of a branch into this object | +| `java.lang.String` | `getName()`
Gets the name of this branch | +| `int` | `getNumVersions()`
Returns how many versions there are in this branch | +| `PHXComponentVersion` | `getParent()`
Retrieves the parent version | +| `PHXComponentVersion` | `getVersion(int i)`
Gets the i'th version | +| `java.util.Iterator` | `getVersions()`
Returns an Iterator over the sub-versions | +| `void` | `insertVersion(PHXComponentVersion v, int location)`
Inserts a version to this branch at a particular location | +| `void` | `setName(java.lang.String name)`
Changes the branch name | +| `java.lang.String` | `toXML()`
Converts this branch into an XML String | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXComponentBranch +```java +public PHXComponentBranch() +``` +Constructs an empty branch + +### PHXComponentBranch +```java +public PHXComponentBranch(java.lang.String name) +``` +Constructs an empty named branch + +### PHXComponentBranch +```java +public PHXComponentBranch(org.w3c.dom.Element branchElement) + throws java.io.IOException +``` +Constructs a branch based on an XML branch node + +**Throws:** +- `java.io.IOException` + +## Method Detail + +### getParent +```java +public PHXComponentVersion getParent() +``` +Retrieves the parent version + +### setName +```java +public void setName(java.lang.String name) +``` +Changes the branch name + +### getName +```java +public java.lang.String getName() +``` +Gets the name of this branch + +### addVersion +```java +public void addVersion(PHXComponentVersion v) +``` +Adds a version to this branch + +### insertVersion +```java +public void insertVersion(PHXComponentVersion v, + int location) +``` +Inserts a version to this branch at a particular location + +### getNumVersions +```java +public int getNumVersions() +``` +Returns how many versions there are in this branch + +### getVersions +```java +public java.util.Iterator getVersions() +``` +Returns an Iterator over the sub-versions + +### getVersion +```java +public PHXComponentVersion getVersion(int i) +``` +Gets the i'th version + +### findVersion +```java +public PHXComponentVersion findVersion(java.lang.String name) +``` +Finds a sub-version by the specified name + +### findBranch +```java +public PHXComponentBranch findBranch(java.lang.String name) +``` +Finds any sub-branch that is part of any version in this branch by name + +### fromXML +```java +public void fromXML(java.lang.String xmlString) + throws javax.xml.parsers.ParserConfigurationException, + org.xml.sax.SAXException, + java.io.IOException +``` +Reads in an XML description of a branch into this object + +**Throws:** +- `javax.xml.parsers.ParserConfigurationException` +- `org.xml.sax.SAXException` +- `java.io.IOException` + +### toXML +```java +public java.lang.String toXML() +``` +Converts this branch into an XML String \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md new file mode 100644 index 0000000000..d8f5d52074 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md @@ -0,0 +1,251 @@ +# Class: PHXComponentDescription + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXComponentDescription +``` + +**Declaration** +```java +public class PHXComponentDescription +extends java.lang.Object +``` + +A class for holding description information about a component class. + +## Field Summary +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static int` | `VI_AVAILABLE` | +| `static int` | `VI_UNAVAILABLE` | +| `static int` | `VI_UNKNOWN` | + +## Constructor Summary +| Constructor and Description | +|----------------------------| +| `PHXComponentDescription()` | + +## Method Summary +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getAuthor()` | +| `long` | `getChecksum()` | +| `boolean` | `getDelayLoadSetupAllowed()` | +| `java.lang.String` | `getDescription()` | +| `boolean` | `getDriver()` | +| `boolean` | `getHasIcon()` | +| `int` | `getHasVersionInfo()` | +| `java.lang.String` | `getHelpURL()` | +| `PHXIcon` | `getIcon()` | +| `java.lang.String` | `getKeywords()` | +| `java.lang.String` | `getRedirectURL()` | +| `java.lang.String` | `getRequirements()`
Get the comma separated list of unquoted requirements. | +| `java.util.Date` | `getTimeStamp()` | +| `java.lang.String` | `getVersion()` | +| `void` | `setAuthor(java.lang.String a)` | +| `void` | `setChecksum(long d)` | +| `void` | `setDelayLoadSetupAllowed(boolean f)` | +| `void` | `setDescription(java.lang.String d)` | +| `void` | `setDriver(boolean f)` | +| `void` | `setHasIcon(boolean f)` | +| `void` | `setHasVersionInfo(int vi)` | +| `void` | `setHelpURL(java.lang.String v)` | +| `void` | `setIcon(PHXIcon i)` | +| `void` | `setIconFile(java.lang.String i)` | +| `void` | `setKeywords(java.lang.String v)` | +| `void` | `setRedirectURL(java.lang.String r)` | +| `void` | `setRequirements(java.lang.String v)`
Set the requirements via comma separated list. | +| `void` | `setTimeStamp(java.util.Date d)` | +| `void` | `setVersion(java.lang.String v)` | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### VI_UNKNOWN +``` +public static final int VI_UNKNOWN +``` + +**See Also:** +[Constant Field Values](../../../constant-values.html#com.phoenix_int.aserver.PHXComponentDescription.VI_UNKNOWN) + +### VI_AVAILABLE +``` +public static final int VI_AVAILABLE +``` + +**See Also:** +[Constant Field Values](../../../constant-values.html#com.phoenix_int.aserver.PHXComponentDescription.VI_AVAILABLE) + +### VI_UNAVAILABLE +``` +public static final int VI_UNAVAILABLE +``` + +**See Also:** +[Constant Field Values](../../../constant-values.html#com.phoenix_int.aserver.PHXComponentDescription.VI_UNAVAILABLE) + +## Constructor Detail + +### PHXComponentDescription +```java +public PHXComponentDescription() +``` + +## Method Detail + +### setRedirectURL +```java +public void setRedirectURL(java.lang.String r) +``` + +### getRedirectURL +```java +public java.lang.String getRedirectURL() +``` + +### setDescription +```java +public void setDescription(java.lang.String d) +``` + +### getDescription +```java +public java.lang.String getDescription() +``` + +### setAuthor +```java +public void setAuthor(java.lang.String a) +``` + +### getAuthor +```java +public java.lang.String getAuthor() +``` + +### setVersion +```java +public void setVersion(java.lang.String v) +``` + +### getVersion +```java +public java.lang.String getVersion() +``` + +### setHelpURL +```java +public void setHelpURL(java.lang.String v) +``` + +### getHelpURL +```java +public java.lang.String getHelpURL() +``` + +### setKeywords +```java +public void setKeywords(java.lang.String v) +``` + +### getKeywords +```java +public java.lang.String getKeywords() +``` + +### setRequirements +```java +public void setRequirements(java.lang.String v) +``` +Set the requirements via comma separated list. +**Parameters:** +: `v`- comma separated list of requirements + +### getRequirements +```java +public java.lang.String getRequirements() +``` +Get the comma separated list of unquoted requirements. +**Returns:** +: comma separated list of unquoted requirements + +### setDriver +```java +public void setDriver(boolean f) +``` + +### getDriver +```java +public boolean getDriver() +``` + +### setHasIcon +```java +public void setHasIcon(boolean f) +``` + +### getHasIcon +```java +public boolean getHasIcon() +``` + +### setIconFile +```java +public void setIconFile(java.lang.String i) +``` + +### getIcon +```java +public PHXIcon getIcon() +``` + +### setIcon +```java +public void setIcon(PHXIcon i) +``` + +### getTimeStamp +```java +public java.util.Date getTimeStamp() +``` + +### setTimeStamp +```java +public void setTimeStamp(java.util.Date d) +``` + +### getChecksum +```java +public long getChecksum() +``` + +### setChecksum +```java +public void setChecksum(long d) +``` + +### setHasVersionInfo +```java +public void setHasVersionInfo(int vi) +``` + +### getHasVersionInfo +```java +public int getHasVersionInfo() +``` + +### setDelayLoadSetupAllowed +```java +public void setDelayLoadSetupAllowed(boolean f) +``` + +### getDelayLoadSetupAllowed +```java +public boolean getDelayLoadSetupAllowed() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md new file mode 100644 index 0000000000..eacd25c08c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md @@ -0,0 +1,73 @@ +# Class: PHXComponentVersion + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXComponentVersion +``` + +**Declaration** +```java +public class PHXComponentVersion +extends java.lang.Object +``` + +This class represents a version on a revision history tree for a version controlled component. Includes functionality for reading/writing XML version descriptions. + +## Constructor Summary +| Constructor and Description | +|----------------------------| +| `PHXComponentVersion(org.w3c.dom.Element versionNode)`
Constructs a version based on information in an XML Element | +| `PHXComponentVersion(java.lang.String name)`
Constructs a version with a given name | +| `PHXComponentVersion(java.lang.String name, java.lang.String author, java.lang.String description, java.util.Date date)`
Constructs a version with the specified meta data | + +## Method Summary +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addBranch(PHXComponentBranch b)`
Adds a sub-branch to this version. | +| `java.lang.String` | `getAuthor()`
Gets the version author | +| `PHXComponentBranch` | `getBranch(int i)`
Returns the i'th sub-branch | +| `java.util.Iterator` | `getBranches()`
Returns an Iterator over the sub-branches | +| `java.util.Date` | `getDate()`
Gets the version date | +| `java.lang.String` | `getDescription()`
Gets the version description | +| `java.lang.String` | `getName()`
Gets the version name | +| `int` | `getNumBranches()`
Gets the number of sub-branches | +| `PHXComponentBranch` | `getParent()`
Gets our parent branch | +| `void` | `setAuthor(java.lang.String author)`
Sets the version author | +| `void` | `setDate(java.util.Date date)`
Sets the version date | +| `void` | `setDescription(java.lang.String description)`
Sets the version description | +| `void` | `setName(java.lang.String name)`
Sets the version name | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXComponentVersion +```java +public PHXComponentVersion(java.lang.String name) +``` +Constructs a version with a given name + +### PHXComponentVersion +```java +public PHXComponentVersion(java.lang.String name, java.lang.String author, java.lang.String description, java.util.Date date) +``` +Constructs a version with the specified meta data +**Parameters:** +- `name` - The version name +- `author` - The version author +- `description` - The version description +- `date` - The date of the version + +### PHXComponentVersion +```java +public PHXComponentVersion(org.w3c.dom.Element versionNode) + throws java.io.IOException +``` +Constructs a version based on information in an XML Element + +**Throws:** +- `java.io.IOException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXDFTException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXDFTException.md new file mode 100644 index 0000000000..66433678d5 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXDFTException.md @@ -0,0 +1,40 @@ +# Class: PHXDFTException + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.PHXDFTException +``` + +**Implemented Interfaces** +- `java.io.Serializable` + +**Declaration** +```java +public class PHXDFTException +extends java.lang.Exception +``` + +This exception is thrown for errors related to Direct File Transfer (DFT) operations in the ModelCenter server environment. + +## Constructor Summary +| Constructor and Description | +|----------------------------| +| `PHXDFTException(java.lang.String msg)` | + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXDFTException +```java +public PHXDFTException(java.lang.String msg) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md new file mode 100644 index 0000000000..07c4db37cb --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md @@ -0,0 +1,309 @@ +# Class: PHXGroup + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXGroup +``` + +**Declaration** +```java +public class PHXGroup +extends java.lang.Object +``` + +A utility class for holding sub-variables. Internally used to manage groups of variables within the `PHXSimpleSelfManager` class. To create your own groups, use the `PHXSimpleSelfManager.addVariable()` function. + +**See Also:** +- [PHXSimpleSelfManager](../../../com/phoenix_int/aserver/PHXSimpleSelfManager.html) + +## Constructor Summary +| Constructor and Description | +|----------------------------| +| `PHXGroup(java.lang.String name)` | + +## Method Summary +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addGroup(PHXGroup group)`
Adds a child group to the group | +| `void` | `addVariable(PHXVariableInfo varInfo)`
Stores a variable in the group. | +| `boolean` | `contains(PHXVariableInfo varInfo)`
Checks to see if a variable exists in this group | +| `boolean` | `contains(java.lang.String varName)`
Checks to see if a variable exists in this group. | +| `PHXGroup` | `getGroup(java.lang.String childName)`
Retrieves a child group. | +| `PHXGroup` | `getGroup2(java.lang.String childName)`
Retrieves a child group. | +| `java.util.Enumeration` | `getGroups()`
Retrieves the Enumeration of subgroups in the group. | +| `java.util.Iterator` | `getGroups2()`
Retrieves all the subgroups in the group | +| `java.lang.String` | `getName()`
Retrieves the name of the group | +| `int` | `getNumGroups()`
Retrieves the number of subgroups in the group. | +| `int` | `getNumVariables()`
Retrieves the number of variables in the group. | +| `PHXVariableInfo` | `getVariableInfo(java.lang.String varName)`
Retrieves a variable from the group. | +| `PHXVariableInfo` | `getVariableInfo2(java.lang.String varName)`
Retrieves a variable from the group. | +| `java.util.Enumeration` | `getVariables()`
Retrieves the Enumeration of variables in the group. | +| `java.util.Iterator` | `getVariables2()`
Retrieves all of the variables in the group. | +| `PHXGroup` | `makeGroup(java.lang.String childName)`
Creates a child group. | +| `void` | `removeAllGroups()`
Removes all groups from the group | +| `void` | `removeAllVariables()`
Removes all variables from the group | +| `void` | `removeGroup(java.lang.String childName)`
Removes a child group. | +| `void` | `removeVariable(PHXVariableInfo varInfo)`
Removes a variable | +| `java.lang.String` | `toString()`
Converts this to a string | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXGroup +```java +public PHXGroup(java.lang.String name) + throws PHXInvalidNameException +``` + +**Parameters:** +- `name` - the name of the group + +**Throws:** +- `PHXInvalidNameException` + +## Method Detail + +### getName +```java +public java.lang.String getName() +``` +retrieves the name of the group + +**Returns:** +- the name of the group + +### addGroup +```java +public void addGroup(PHXGroup group) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +adds a child group to the group + +**Parameters:** +- `group`- the child group + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` + +### getGroup +```java +public PHXGroup getGroup(java.lang.String childName) + throws PHXNoSuchObjectException +``` +retrieves a child group. + +**Parameters:** +- `childName`- the name of the child group + +**Returns:** +- the child group + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the child group is not found + +### getGroup2 +```java +public PHXGroup getGroup2(java.lang.String childName) +``` +retrieves a child group. Does not throw an exception on failure. + +**Parameters:** +- `childName`- the name of the child group + +**Returns:** +- the child group. Returns null on failure + +### makeGroup +```java +public PHXGroup makeGroup(java.lang.String childName) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +creates a child group. If the group already exists, it is retrieved + +**Parameters:** +- `childName`- the name of the child group + +**Returns:** +- the child group + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` + +### removeGroup +```java +public void removeGroup(java.lang.String childName) + throws java.lang.Exception +``` +remove a child group. If the group doesn't exist, it just returns + +**Parameters:** +- `childName`- the name of the child group + +**Throws:** +- `java.lang.Exception` + +### getNumGroups +```java +public int getNumGroups() +``` +retrieves the number of subgroups in the group. + +**Returns:** +- the number of subgroups + +### getGroups +```java +public java.util.Enumeration getGroups() +``` +retrieves the Enumeration of subgroups in the group. + +**Returns:** +- an Enumeration of PHXGroup objects + +### getGroups2 +```java +public java.util.Iterator getGroups2() +``` +retrieves all the subgroups in the group + +**Returns:** +- an Iterator of all the groups. + +### addVariable +```java +public void addVariable(PHXVariableInfo varInfo) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +stores a variable in the group. + +**Parameters:** +- `varInfo`- the variable info structure + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` + +### getVariableInfo +```java +public PHXVariableInfo getVariableInfo(java.lang.String varName) + throws PHXNoSuchObjectException +``` +retrieves a variable from the group. + +**Parameters:** +- `varName`- the name of the variable to get + +**Returns:** +- the variable info structure + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified variable is not found + +### getVariableInfo2 +```java +public PHXVariableInfo getVariableInfo2(java.lang.String varName) +``` +retrieves a variable from the group. Does not throw an Exception on failure. + +**Parameters:** +- `varName`- the name of the variable to get + +**Returns:** +- the variable info structure, or null if not found + +### contains +```java +public boolean contains(PHXVariableInfo varInfo) +``` +checks to see if a variable exists in this group + +**Parameters:** + +- `varInfo`- the variable to check, must be an exact match (not just name) + +**Returns:** +- true if the variable is in this group + +### contains +```java +public boolean contains(java.lang.String varName) +``` +Checks to see if a variable exists in this group. + +**Parameters:** +- `varName`- the name of the variable to check. + +**Returns:** + +- true if the variable is in this group. + +### getNumVariables +```java +public int getNumVariables() +``` +retrieves the number of variables in the group. + +**Returns:** +- the number of variables + +### getVariables +```java +public java.util.Enumeration getVariables() +``` +retrieves the Enumeration of variables in the group. + +**Returns:** + +- an Enumeration of PHXVariableInfo objects + +### getVariables2 +```java +public java.util.Iterator getVariables2() +``` +retrieves all of the variables in the group. + +**Returns:** +- an Iterator of all the PHXVariableInfo objects + +### removeAllVariables +```java +public void removeAllVariables() +``` +removes all variables from the group + +### removeAllGroups +```java +public void removeAllGroups() +``` +remove all groups from the group + +### removeVariable +```java +public void removeVariable(PHXVariableInfo varInfo) +``` +removes a variable + +**Parameters:** +- `varInfo`- the variable structure to remove + +### toString +```java +public java.lang.String toString() +``` +Converts this to a string + +**Overrides:** +- `toString`in class`java.lang.Object` + +**Returns:** +- the string "Group: " with the name of the group appended. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md new file mode 100644 index 0000000000..0681f4fdfb --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md @@ -0,0 +1,78 @@ +# Class: PHXInvalidNameException + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.PHXInvalidNameException +``` + +**Implemented Interfaces** +- `java.io.Serializable` + +**Declaration** +```java +public class PHXInvalidNameException +extends java.lang.Exception +``` + +An exception that is thrown when trying to create a new object using an invalid name. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXInvalidNameException(java.lang.String name)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `static void` | `checkGroup(java.lang.String name)`
Checks a name to see if it's valid. | +| `static void` | `checkName(java.lang.String name)`
Checks a name to see if it's valid. | + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait` + +## Constructor Detail + +### PHXInvalidNameException +```java +public PHXInvalidNameException(java.lang.String name) +``` +**Parameters:** +- `name` - the name that was already in use + +## Method Detail + +### checkName +```java +public static void checkName(java.lang.String name) + throws PHXInvalidNameException +``` +Checks a name to see if it's valid. + +**Parameters:** +- `name` - the name to check + +**Throws:** +- `PHXInvalidNameException` - thrown if the name is invalid, i.e. has invalid characters. + +### checkGroup +```java +public static void checkGroup(java.lang.String name) + throws PHXInvalidNameException +``` +Checks a name to see if it's valid. The name should be in the form "xxx.xxxxx.xxxx". + +**Parameters:** +- `name` - the name to check + +**Throws:** +- `PHXInvalidNameException` - thrown if the name is invalid, i.e. has invalid characters. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md new file mode 100644 index 0000000000..96b874d3b4 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md @@ -0,0 +1,94 @@ +# Class: PHXInvokeReturn + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXInvokeReturn +``` + +**Declaration** +```java +public class PHXInvokeReturn +extends java.lang.Object +``` + +A utility class for holding return information from an invoked function. It's used to capture additional return information such as whether all variable values should be retrieved after invocation, and can easily be extended for future needs in this vein. + +To use this class, simply return it from a method defined on a Simple Self Manager. + +**See Also:** [`PHXSimpleSelfManager`](../../../com/phoenix_int/aserver/PHXSimpleSelfManager.html) + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXInvokeReturn()` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `boolean` | `getDownloadInputs()`
Retrieves whether the invocation should trigger a redownloading of input values. | +| `java.lang.String` | `getReturnString()`
Retrieves the return string for the custom method. | +| `void` | `setDownloadInputs(boolean downloadInputs)`
Set whether input values should be redownloaded after the invocation. | +| `void` | `setReturnString(java.lang.String returnStr)`
Sets the return string for the custom method. | +| `java.lang.String` | `toString()`
Handle converting this class to a string in XML format. | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait` + +## Constructor Detail + +### PHXInvokeReturn +```java +public PHXInvokeReturn() +``` + +## Method Detail + +### getReturnString +```java +public java.lang.String getReturnString() +``` +Retrieves the return string for the custom method. + +**Returns:** +- the return string + +### setReturnString +```java +public void setReturnString(java.lang.String returnStr) +``` +Sets the return string for the custom method. + +**Parameters:** +- `returnStr` - the return string + +### getDownloadInputs +```java +public boolean getDownloadInputs() +``` +Retrieves whether the invocation should trigger a redownloading of input values. + +**Returns:** +- should the input values be redownloaded after the invocation? + +### setDownloadInputs +```java +public void setDownloadInputs(boolean downloadInputs) +``` +Set whether input values should be redownloaded after the invocation. + +**Parameters:** +- `downloadInputs` - Sends a hint to the client as to whether input values should be re-downloaded after the invocation. + +### toString +```java +public java.lang.String toString() +``` +Handle converting this class to a string in XML format. + +**Overrides:** +- `toString` in class `java.lang.Object` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md new file mode 100644 index 0000000000..87f8dd01ed --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md @@ -0,0 +1,120 @@ +# Class: PHXMethodDescriptor + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXMethodDescriptor +``` + +**Declaration** +```java +public class PHXMethodDescriptor +extends java.lang.Object +``` + +A utility class used by PHXSelfManager to indicate which methods it can invoke. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXMethodDescriptor()` | +| `PHXMethodDescriptor(java.lang.String name)` | +| `PHXMethodDescriptor(java.lang.String name, java.lang.String fullName)` | +| `PHXMethodDescriptor(java.lang.String name, java.lang.String fullName, boolean downloadInputs)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `static PHXMethodDescriptor` | `fromString(java.lang.String str)` | +| `boolean` | `getDownloadInputs()` | +| `java.lang.String` | `getFullName()` | +| `java.lang.String` | `getName()` | +| `void` | `setDownloadInputs(boolean di)` | +| `void` | `setFullName(java.lang.String fullName)` | +| `void` | `setName(java.lang.String name)` | +| `java.lang.String` | `toString()` | +| `java.lang.String` | `toString2()` | +| `java.lang.String` | `toString3()` | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait` + +## Constructor Detail + +### PHXMethodDescriptor +```java +public PHXMethodDescriptor() +``` + +### PHXMethodDescriptor +```java +public PHXMethodDescriptor(java.lang.String name) +``` + +### PHXMethodDescriptor +```java +public PHXMethodDescriptor(java.lang.String name, java.lang.String fullName) +``` + +### PHXMethodDescriptor +```java +public PHXMethodDescriptor(java.lang.String name, java.lang.String fullName, boolean downloadInputs) +``` + +## Method Detail + +### getDownloadInputs +```java +public boolean getDownloadInputs() +``` + +### setDownloadInputs +```java +public void setDownloadInputs(boolean di) +``` + +### getFullName +```java +public java.lang.String getFullName() +``` + +### setFullName +```java +public void setFullName(java.lang.String fullName) +``` + +### getName +```java +public java.lang.String getName() +``` + +### setName +```java +public void setName(java.lang.String name) +``` + +### toString3 +```java +public java.lang.String toString3() +``` + +### toString2 +```java +public java.lang.String toString2() +``` + +### toString +```java +public java.lang.String toString() +``` +**Overrides:** +- `toString` in class `java.lang.Object` + +### fromString +```java +public static PHXMethodDescriptor fromString(java.lang.String str) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNameAlreadyInUseException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNameAlreadyInUseException.md new file mode 100644 index 0000000000..63309f5e68 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNameAlreadyInUseException.md @@ -0,0 +1,45 @@ +# Class: PHXNameAlreadyInUseException + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.PHXNameAlreadyInUseException +``` + +**Implemented Interfaces** +- `java.io.Serializable` + +**Declaration** +```java +public class PHXNameAlreadyInUseException +extends java.lang.Exception +``` + +An exception that is thrown when trying to create a new object with a name that already exists. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXNameAlreadyInUseException(java.lang.String name)` | + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait` + +## Constructor Detail + +### PHXNameAlreadyInUseException +```java +public PHXNameAlreadyInUseException(java.lang.String name) +``` +**Parameters:** +- `name` - the name that was already in use \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md new file mode 100644 index 0000000000..6ff8c5641e --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md @@ -0,0 +1,69 @@ +# Class: PHXNoSuchObjectException + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.PHXNoSuchObjectException +``` + +**Implemented Interfaces** +- `java.io.Serializable` + +**Direct Known Subclasses:** +- [`PHXNoSuchWriteableObjectException`](../../../com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.html) + +**Declaration** +```java +public class PHXNoSuchObjectException +extends java.lang.Exception +``` + +An exception that is thrown when an object cannot be found. + +## Constructor Summary + +| Modifier | Constructor and Description | +|-------------|----------------------------| +| `protected` | `PHXNoSuchObjectException(int i, java.lang.String msg)` | +| | `PHXNoSuchObjectException(java.lang.String object)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|---------------------|----------------------| +| `java.lang.String` | `getInvalidObject()`
Retrieves the object name that was invalid. | + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait` + +## Constructor Detail + +### PHXNoSuchObjectException +```java +protected PHXNoSuchObjectException(int i, java.lang.String msg) +``` + +### PHXNoSuchObjectException +```java +public PHXNoSuchObjectException(java.lang.String object) +``` +**Parameters:** +- `object` - the object name that caused the exception. + +## Method Detail + +### getInvalidObject +```java +public java.lang.String getInvalidObject() +``` +Retrieves the object name that was invalid. + +**Returns:** +- the invalid object name \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md new file mode 100644 index 0000000000..fd0cd25797 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md @@ -0,0 +1,49 @@ +# Class: PHXNoSuchWriteableObjectException + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.PHXNoSuchObjectException + ↳ com.phoenix_int.aserver.PHXNoSuchWriteableObjectException +``` + +**Implemented Interfaces** +- `java.io.Serializable` + +**Declaration** +```java +public class PHXNoSuchWriteableObjectException +extends PHXNoSuchObjectException +``` + +An exception that the PHXObjectManager throws when it can't find an object. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXNoSuchWriteableObjectException(java.lang.String object)` | + +## Method Summary + +### Methods inherited from class com.phoenix_int.aserver.PHXNoSuchObjectException +`getInvalidObject` + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait` + +## Constructor Detail + +### PHXNoSuchWriteableObjectException +```java +public PHXNoSuchWriteableObjectException(java.lang.String object) +``` +**Parameters:** +- `object` - the object name that caused the exception. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md new file mode 100644 index 0000000000..3f020d1c5a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md @@ -0,0 +1,267 @@ +# Class: PHXPropertyDescriptor + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXPropertyDescriptor +``` + +**Declaration** +```java +public class PHXPropertyDescriptor +extends java.lang.Object +``` + +A utility class used by PHXSelfManager to indicate which properties it manages. + + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXPropertyDescriptor()`
Creates a property descriptor with all values set to "unknown" | +| `PHXPropertyDescriptor(java.beans.PropertyDescriptor prop)` | +| `PHXPropertyDescriptor(java.beans.PropertyDescriptor prop, java.lang.Object parent)` | +| `PHXPropertyDescriptor(java.lang.String name, java.lang.Object object, boolean canSet, boolean canGet)` | +| `PHXPropertyDescriptor(java.lang.String name, java.lang.String type, boolean canSet, boolean canGet)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `static void` | `asPropertyDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet)`
Stringify the property descriptor data. | +| `java.lang.String` | `asValueDescriptor()`
Converts the property to a machine-readable format. | +| `static void` | `asValueDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet, java.lang.String value)`
Stringify the value descriptor data. | +| `void` | `asValueDescriptor2(PHXStringBuffer out)`
Converts the property to a readable format. | +| `void` | `asValueDescriptor3(PHXStringBuffer out)`
Converts the property to a readable format. | +| `boolean` | `getCanGet()`
Determines if the property can be retrieved. | +| `boolean` | `getCanSet()`
Determines if the property can be modified. | +| `java.lang.String` | `getName()`
Retrieves the property name. | +| `java.lang.Object` | `getSource()` | +| `java.lang.String` | `getType()`
Retrieves the type of the property as a string. | +| `java.lang.Class` | `getTypeClass()`
Retrieves the type of the property as a Class object. | +| `java.lang.String` | `getValue()` | +| `PHXStringBuffer` | `getValue2()` | +| `PHXStringBuffer` | `getValue3()` | +| `void` | `setCanGet(boolean flag)`
Sets whether the property can be retrieved. | +| `void` | `setCanSet(boolean flag)`
Sets whether the property can be modified. | +| `java.lang.String` | `toString()`
Converts the property to a readable format. | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait` + +## Constructor Detail + +### PHXPropertyDescriptor +```java +public PHXPropertyDescriptor() +``` +Creates a property descriptor with all values set to "unknown". + +### PHXPropertyDescriptor +```java +public PHXPropertyDescriptor(java.beans.PropertyDescriptor prop) +``` +**Parameters:** +- `prop` - the PropertyDescriptor + +### PHXPropertyDescriptor +```java +public PHXPropertyDescriptor(java.lang.String name, java.lang.String type, boolean canSet, boolean canGet) +``` +**Parameters:** +- `name` - the name of the property +- `type` - the property type +- `canGet` - true if the property is readable +- `canSet` - true if the property is writeable + +### PHXPropertyDescriptor +```java +public PHXPropertyDescriptor(java.lang.String name, java.lang.Object object, boolean canSet, boolean canGet) +``` +**Parameters:** +- `name` - the name of the property +- `object` - the property +- `canGet` - true if the property is readable +- `canSet` - true if the property is writeable + +### PHXPropertyDescriptor +```java +public PHXPropertyDescriptor(java.beans.PropertyDescriptor prop, java.lang.Object parent) + throws java.lang.IllegalArgumentException +``` +**Parameters:** +- `prop` - the PropertyDescriptor +- `parent` - the parent object - used to retrieve the actual object for prop if prop is an array (so that the array length can be determined). May be null. + +**Throws:** +- `java.lang.IllegalArgumentException` + +## Method Detail + +### getCanGet +```java +public boolean getCanGet() +``` +Determines if the property can be retrieved. + +**Returns:** +- true if the property can be retrieved + +### setCanGet +```java +public void setCanGet(boolean flag) +``` +Sets whether the property can be retrieved. + +**Parameters:** +- `flag` - true if the property can be retrieved + +### getCanSet +```java +public boolean getCanSet() +``` +Determines if the property can be modified. + +**Returns:** +- true if the property can be modified + +### setCanSet +```java +public void setCanSet(boolean flag) +``` +Sets whether the property can be modified. + +**Parameters:** +- `flag` - true if the property can be modified + +### getName +```java +public java.lang.String getName() +``` +Retrieves the property name. + +**Returns:** +- the name of the property + +### getType +```java +public java.lang.String getType() +``` +Retrieves the type of the property as a string. + +**Returns:** +- the type of the property as a String + +### getTypeClass +```java +public java.lang.Class getTypeClass() +``` +Retrieves the type of the property as a Class object. + +**Returns:** +- the type of the property as a Class object + +### getValue +```java +public java.lang.String getValue() +``` + +### getValue2 +```java +public PHXStringBuffer getValue2() + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### getValue3 +```java +public PHXStringBuffer getValue3() + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### getSource +```java +public java.lang.Object getSource() +``` + +### toString +```java +public java.lang.String toString() +``` +Converts the property to a readable format. + +**Overrides:** +- `toString` in class `java.lang.Object` + +**Returns:** +- the property in String format + +### asValueDescriptor +```java +public java.lang.String asValueDescriptor() +``` +Converts the property to a machine-readable format. + +**Returns:** +- the property in String format + +### asValueDescriptor2 +```java +public void asValueDescriptor2(PHXStringBuffer out) + throws java.io.IOException +``` +Converts the property to a readable format. Returns a PHXStringBuffer for performance. + +**Parameters:** +- `out` - a buffer for the method to use to store the property in String format + +**Throws:** +- `java.io.IOException` + +### asValueDescriptor3 +```java +public void asValueDescriptor3(PHXStringBuffer out) + throws java.io.IOException +``` +Converts the property to a readable format. Returns a PHXStringBuffer for performance. + +**Parameters:** +- `out` - a buffer for the method to use to store the property in String format + +**Throws:** +- `java.io.IOException` + +### asPropertyDescriptor +```java +public static void asPropertyDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet) +``` +Stringify the property descriptor data. + +**Parameters:** +- `out` - the buffer to write to +- `name` - the property name +- `type` - the property type +- `canSet` - whether the property can be set +- `canGet` - whether the property can be read + +### asValueDescriptor +```java +public static void asValueDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet, java.lang.String value) +``` +Stringify the value descriptor data. + +**Parameters:** +- `out` - the buffer to write to +- `name` - the property name +- `type` - the property type +- `canSet` - whether the property can be set +- `canGet` - whether the property can be read +- `value` - the value to write \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md new file mode 100644 index 0000000000..38a39ca7ac --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md @@ -0,0 +1,58 @@ +# Class: PHXRunShare.RunInfo + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXRunShare.RunInfo +``` + +**Enclosing class:** +[PHXRunShare](../../../com/phoenix_int/aserver/PHXRunShare.html) + +**Declaration** +```java +public class PHXRunShare.RunInfo +extends java.lang.Object +``` + +Data structure used to hold info about a currently running command. + +## Field Summary + +| Modifier and Type | Field and Description | +|---------------------|----------------------| +| `java.lang.String` | `cmd` | +| `java.io.File` | `runFolder` | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `RunInfo(java.lang.String cmd, java.lang.String runFolder)` | + +## Method Summary + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### cmd +```java +public java.lang.String cmd +``` + +### runFolder +```java +public java.io.File runFolder +``` + +## Constructor Detail + +### RunInfo +```java +public RunInfo(java.lang.String cmd, java.lang.String runFolder) +``` + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md new file mode 100644 index 0000000000..407c145fc6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md @@ -0,0 +1,519 @@ +# Class: PHXRunShare + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXRunShare +``` + +**Implemented Interfaces** +- `IPHXMonitorable`, `com.phoenix_int.aserver.trace.IPHXTraceGenerator` + +**Declaration** +```java +public class PHXRunShare +extends java.lang.Object +implements IPHXMonitorable, com.phoenix_int.aserver.trace.IPHXTraceGenerator +``` + +This class handles runshare capabilities for any component which needs it. It can create temp directories, deal w/ auto-copy and auto-delete of important files, return errors and block until it is safe to run. It also handles providing monitors for stdout and stderr as well as for monitoring started processes. + +This class can only handle one single process running at a time. If you need to run multiple processes, use multiple instances of this class. You can use this same object over and over by calling `lock()` and `unlock()` multiple times. + +## Nested Class Summary + +| Modifier and Type | Class and Description | +|------------------|----------------------| +| class | `PHXRunShare.RunInfo`
Data structure used to hold info about a currently running command | + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static int` | `DEL_AUTO`
delete the directory only if an error did not occur while running the wrapper. | +| `static int` | `DEL_FALSE`
do not delete the directory. | +| `static int` | `DEL_TRUE`
delete the directory. | +| `static int` | `MODE_ERROR`
When a user tries to run a component that is already running, this option generates an error message and instructs the user to try again later. | +| `static int` | `MODE_NONE`
This option performs no run sharing. | +| `static int` | `MODE_SHARE`
When two or more users attempt to run a component simultaneously, the FileWrapper creates separate directories that hold unique input and output files for every user. | +| `static int` | `MODE_WAIT`
When the component is running, this option ensures that no one else will be able to run it. | + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `PHXRunShare(java.lang.String baseDir, java.lang.String wrapperID)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addFileToCopy(java.lang.String file)` | +| `void` | `addRunDirChangedListener(com.phoenix_int.aserver.IPHXRunDirChangedListener rdl)`
Adds a listener which will receive events when the run directory is changed. | +| `void` | `addTraceListener(com.phoenix_int.aserver.trace.IPHXTraceListener listener)`
Adds a listener to trace events | +| `void` | `cleanTempDir()`
cleans up the temporary run directory if one has been created. | +| `void` | `finalize()` | +| `boolean` | `getAutoChangeDir()`
Gets the `AutoChangeDir` flag | +| `int` | `getAutoDelete()`
Gets the auto-delete mode | +| `java.lang.String` | `getBaseDirectory()`
Gets the base dir which was passed in to the constructor. | +| `java.util.Map` | `getDictionary()` | +| `java.lang.String` | `getDirectory()`
Returns the current directory being used by the runshare system. | +| `boolean` | `getIgnoreErrors()`
Gets the `IgnoreErrors` flag | +| `int` | `getMode()`
Gets the runshare mode | +| `java.lang.Object` | `getMonitor(java.lang.String m)`
Returns any available monitors by name. | +| `java.lang.String` | `getShell()`
Gets the shell used to execute commands. | +| `java.lang.String` | `getWrapperID()`
Returns the wrapper ID being used for locking. | +| `void` | `halt()`
halts any running process | +| `java.lang.String[]` | `listMonitorableFiles()`
Lists available "monitors". | +| `PHXProcessInfo[]` | `listProcesses()`
Lists any running processes | +| `void` | `lock()`
Causes the run-share mode to be implemented. | +| `void` | `removeRunDirChangedListener(com.phoenix_int.aserver.IPHXRunDirChangedListener rdl)`
Removes a listener for run directory changed events. | +| `void` | `removeTraceListener(com.phoenix_int.aserver.trace.IPHXTraceListener listener)`
Removes a listener from trace events | +| `void` | `reset()`
Reset the `ProcessStruct` back to initial state for possible use in another run request. | +| `void` | `run(java.lang.String cmd)`
Runs a command. | +| `void` | `run(java.lang.String cmd, boolean ignoreErrors, boolean autoChangeDir, java.lang.String shell)`
Runs a command. | +| `void` | `run(java.lang.String cmd, boolean ignoreErrors, java.lang.String autoChangeDir, java.lang.String shell)`
Runs a command. | +| `int` | `run2(java.lang.String cmd, boolean ignoreErrors, java.lang.String autoChangeDir, java.lang.String shell)`
Runs a command. | +| `void` | `setAutoChangeDir(boolean flag)`
Sets the `AutoChangeDir` flag. | +| `void` | `setAutoDelete(int autoDelete)`
Sets the auto-delete mode for runshare mode MODE_SHARE. | +| `PHXRunShare` | `setDictionary(java.util.Map dict)` | +| `void` | `setDirectTransfer(boolean flag)`
Set whether or not this runShare is involved in direct transfer of files | +| `void` | `setFilesToCopy(java.lang.String files)`
Sets the files which need to be copied when runshare mode is MODE_SHARE. | +| `void` | `setIgnoreErrors(boolean flag)`
Sets the `IgnoreErrors` flag. | +| `void` | `setMode(int mode)`
Sets the runshare mode. | +| `void` | `setRunDirectory(java.lang.String runDirectory)` | +| `void` | `setRunReplacer(com.phoenix_int.aserver.util.PHXRunReplacer replacer)`
Sets the run replacer object which is used to transform $VAR type specifications before running commands | +| `void` | `setShell(java.lang.String shell)`
Sets the shell used to execute commands. | +| `void` | `timeout()`
Cleans up a run that has timed out | +| `void` | `unlock()`
Unlocks the runshare mechanisms. | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### MODE_NONE +``` +public static final int MODE_NONE +``` +This option performs no run sharing. This means that when two users attempt to run the same component simultaneously, ModelCenter Remote Execution will take no action to ensure that input and output files are not overwritten. + +**See Also:** + +[`Constant Field Values`](../../../constant-values.html#com.phoenix_int.aserver.PHXRunShare.MODE_NONE) + +### MODE_ERROR +``` +public static final int MODE_ERROR +``` +When a user tries to run a component that is already running, this option generates an error message and instructs the user to try again later. + +**See Also:** + +[`Constant Field Values`](../../../constant-values.html#com.phoenix_int.aserver.PHXRunShare.MODE_ERROR) + +### MODE_WAIT +``` +public static final int MODE_WAIT +``` +When the component is running, this option ensures that no one else will be able to run it. A second user will not be able to read or write files until the first user is done with them. When the first user's object has retrieved all of the output information it needs from the component's files, the second user's object can now run; it overwrites the current input and output files in doing so. This is the default run sharing mechanism of FileWrapper components. + +**See Also:** + +[`Constant Field Values`](../../../constant-values.html#com.phoenix_int.aserver.PHXRunShare.MODE_WAIT) + +### MODE_SHARE +``` +public static final int MODE_SHARE +``` +When two or more users attempt to run a component simultaneously, the FileWrapper creates separate directories that hold unique input and output files for every user. Thus, all users can run the component simultaneously without file conflicts. + +**See Also:** + +[`Constant Field Values`](../../../constant-values.html#com.phoenix_int.aserver.PHXRunShare.MODE_SHARE) + +### DEL_AUTO +``` +public static final int DEL_AUTO +``` +delete the directory only if an error did not occur while running the wrapper. If an error did occur, then the directory is preserved and a file named exception.log is created in the directory to record the error. If no error occurs, the directory is deleted when the component is ended or when it's run again. This the default setting. + +**See Also:** + +[`Constant Field Values`](../../../constant-values.html#com.phoenix_int.aserver.PHXRunShare.DEL_AUTO) + +### DEL_FALSE +``` +public static final int DEL_FALSE +``` +do not delete the directory. + +**See Also:** + +[`Constant Field Values`](../../../constant-values.html#com.phoenix_int.aserver.PHXRunShare.DEL_FALSE) + +### DEL_TRUE +``` +public static final int DEL_TRUE +``` +delete the directory. + +**See Also:** + +[`Constant Field Values`](../../../constant-values.html#com.phoenix_int.aserver.PHXRunShare.DEL_TRUE) + +## Constructor Detail + +### PHXRunShare +``` +public PHXRunShare(java.lang.String baseDir, + java.lang.String wrapperID) +``` +**Parameters:** +- `baseDir` - The directory on disk where the files associated w/ this component are located. +- `wrapperID` - A unique ID which identifies this component. This is used to synchronize runshare access across multiple instances of the same component. Typically the full path on disk to the component's main file is used for this ID. + +## Method Detail + +### finalize +``` +public void finalize() +``` +**Overrides::** +- `finalize` in class `java.lang.Object` + +### getWrapperID +``` +public java.lang.String getWrapperID() +``` +Returns the wrapper ID being used for locking. This ID should be the full path to the main file on disk for the associated wrapper. + +### setDictionary +``` +public PHXRunShare setDictionary(java.util.Map dict) +``` + +### getDictionary +``` +public java.util.Map getDictionary() +``` + +### setRunReplacer +``` +public void setRunReplacer(com.phoenix_int.aserver.util.PHXRunReplacer replacer) +``` +Sets the run replacer object which is used to transform $VAR type specifications before running commands + +### addRunDirChangedListener +``` +public void addRunDirChangedListener(com.phoenix_int.aserver.IPHXRunDirChangedListener rdl) +``` +Adds a listener which will receive events when the run directory is changed. + +### removeRunDirChangedListener +``` +public void removeRunDirChangedListener(com.phoenix_int.aserver.IPHXRunDirChangedListener rdl) +``` +Removes a listener for run directory changed events. + +### getBaseDirectory +``` +public java.lang.String getBaseDirectory() +``` +Gets the base dir which was passed in to the constructor. + +### getDirectory +``` +public java.lang.String getDirectory() +``` +Returns the current directory being used by the runshare system. This may be the base directory, or it may be a temp directory created underneath there to implement run sharing. + +### lock +``` +public void lock() + throws java.io.IOException +``` +Causes the run-share mode to be implemented. This creates sub-dirs, waits or errors as appropriate. + +Once in "locked" mode, calling `lock()` again has no effect. + +**Throws:** +- `java.io.IOException` + +### unlock +``` +public void unlock() +``` +Unlocks the runshare mechanisms. This will unblock other components which are waiting for us to finish. + +Calling `unlock()` when not in "locked" mode has no effect. + +### setDirectTransfer +``` +public void setDirectTransfer(boolean flag) +``` +Set whether or not this runShare is involved in direct transfer of files + +**Parameters:** +- `flag` - boolean flag + +### cleanTempDir +``` +public void cleanTempDir() + throws java.io.IOException +``` +cleans up the temporary run directory if one has been created. In general, wrappers and end users should **not** use this function unless you have manually created your own runshare object. Doing so will prevent proper delayed transfer of direct file transfer (DFT) files. + +**Throws:** +- `java.io.IOException` + +### setRunDirectory +``` +public void setRunDirectory(java.lang.String runDirectory) + throws com.phoenix_int.aserver.PHXCannotSetRunDirectoryException +``` +**Throws:** +- `com.phoenix_int.aserver.PHXCannotSetRunDirectoryException` + +### setMode +``` +public void setMode(int mode) +``` +Sets the runshare mode. + +### getMode +``` +public int getMode() +``` +Gets the runshare mode + +### addFileToCopy +``` +public void addFileToCopy(java.lang.String file) +``` + +### setFilesToCopy +``` +public void setFilesToCopy(java.lang.String files) +``` +Sets the files which need to be copied when runshare mode is MODE_SHARE. + +### setAutoDelete +``` +public void setAutoDelete(int autoDelete) +``` +Sets the auto-delete mode for runshare mode MODE_SHARE. If DEL_TRUE, the created sub-dir is always deleted. If DEL_FALSE, it is never deleted. If DEL_AUTO, it is only deleted when no errors occur during the run. Deletion occurs when the component is ended or when the component is run again. + +### getAutoDelete +``` +public int getAutoDelete() +``` +Gets the auto-delete mode + +### setIgnoreErrors +``` +public void setIgnoreErrors(boolean flag) +``` +Sets the `IgnoreErrors` flag. By default this code will throw an exception if the spawned process returns a non-zero errorlevel. Occasionally a program will return an errorlevel even if it succeeds. This option allows you to igore the errorlevel. + +**Parameters:** +- `flag` - true to ignore errors + +### getIgnoreErrors +``` +public boolean getIgnoreErrors() +``` +Gets the `IgnoreErrors` flag + +**Returns:** +- the `IgnoreErrors` flag + +### setAutoChangeDir +``` +public void setAutoChangeDir(boolean flag) +``` +Sets the `AutoChangeDir` flag. This flag indicates whether to change the current working directory to the run directory (see `getDirectory`) before running the code. Changing directories occasionally causes problems with other command line programs. True by default. + +**Parameters:** +- `flag` - false to not change folders. + +### getAutoChangeDir +``` +public boolean getAutoChangeDir() +``` +Gets the `AutoChangeDir` flag + +**Returns:** +- the `AutoChangeDir` flag + +### setShell +``` +public void setShell(java.lang.String shell) +``` +Sets the shell used to execute commands. This only applies to UNIX hosts. By default "sh" is used. + +**Parameters:** +- `shell` - The shell used to invoke the run command + +### getShell +``` +public java.lang.String getShell() +``` +Gets the shell used to execute commands. + +**Returns:** +- the command shell + +### run +``` +public void run(java.lang.String cmd) + throws java.lang.Exception +``` +Runs a command. Command may be relative to the run directory, see getDirectory(). + +This function will not return until the sub-process has finished. It will collect stdout and stderr and provide progress monitors. + +If the command is halted (via [`halt()`](../../../com/phoenix_int/aserver/PHXRunShare.html#halt--) or [`timeout()`](../../../com/phoenix_int/aserver/PHXRunShare.html#timeout--)) and `ignoreError` is `false`, this method will throw a [`ProcessHaltedException`](../../../com/phoenix_int/aserver/ProcessHaltedException.html "class in com.phoenix_int.aserver"). + +**Parameters:** +- `cmd` - The command to run. + +**Throws:** +- `java.io.IOException` - Either the command cannot be executed, or an I/O error occurred while reading standard error or standard out from the command +- [`ProcessHaltedException`](../../../com/phoenix_int/aserver/ProcessHaltedException.html "class in com.phoenix_int.aserver") - The running script was halted via the [`halt()`](../../../com/phoenix_int/aserver/PHXRunShare.html#halt--) or [`timeout()`](../../../com/phoenix_int/aserver/PHXRunShare.html#timeout--). +- `java.lang.Exception` + +### run +``` +public void run(java.lang.String cmd, + boolean ignoreErrors, + boolean autoChangeDir, + java.lang.String shell) + throws java.lang.Exception +``` +Runs a command. Command may be relative to the run directory, see getDirectory(). + +This function will not return until the sub-process has finished. It will collect stdout and stderr and provide progress monitors. + +If the command is halted (via [`halt()`](../../../com/phoenix_int/aserver/PHXRunShare.html#halt--) or [`timeout()`](../../../com/phoenix_int/aserver/PHXRunShare.html#timeout--)) and `ignoreError` is `false`, this method will throw a [`ProcessHaltedException`](../../../com/phoenix_int/aserver/ProcessHaltedException.html "class in com.phoenix_int.aserver"). + +**Parameters:** +- `cmd` - The command to run. + +**Throws:** +- `java.io.IOException` - Either the command cannot be executed, or an I/O error occurred while reading standard error or standard out from the command +- [`ProcessHaltedException`](../../../com/phoenix_int/aserver/ProcessHaltedException.html "class in com.phoenix_int.aserver") - The running script was halted via the [`halt()`](../../../com/phoenix_int/aserver/PHXRunShare.html#halt--) or [`timeout()`](../../../com/phoenix_int/aserver/PHXRunShare.html#timeout--). +- `java.lang.Exception` + +### run +``` +public void run(java.lang.String cmd, + boolean ignoreErrors, + java.lang.String autoChangeDir, + java.lang.String shell) + throws java.lang.Exception +``` +Runs a command. Command may be relative to the run directory, see `getDirectory()`. + +This function will not return until the sub-process has finished. It will collect stdout and stderr and provide progress monitors. + +If the command is halted (via `halt()` or `timeout()`) and `ignoreError` is false, this method will throw a `ProcessHaltedException`. If `ignoreError` is true, this method will return one (1). + +**Parameters:** +- `cmd` - The command to run. +- `ignoreErrors` - By default this code will throw an exception if the spawned process returns a non-zero errorlevel. Occasionally a program will return an errorlevel even if it succeeds. This option allows you to ignore the errorlevel. +- `autoChangeDir` - If non-empty, the directory will be changed to this before running the program. +- `shell` - On UNIX you can specify which shell to use to launch the program. By default "sh" is used. + +**Returns:** +- the cmd exit status (`errorlevel`). Will be 0 unless `ignoreErrors` is true + +**Throws:** +- `java.io.IOException` - Either the command cannot be executed, or an I/O error occurred while reading standard error or standard out from the command +- `ProcessHaltedException` - The running script was halted via the `halt()` or `timeout()`. +- `java.lang.Exception` + +### halt +``` +public void halt() +``` +halts any running process + +### timeout +``` +public void timeout() +``` +Cleans up a run that has timed out + +### reset +``` +public void reset() +``` +Reset the `ProcessStruct` back to initial state for possible use in another run request. + +### listProcesses +``` +public PHXProcessInfo[] listProcesses() throws java.io.IOException +``` +Lists any running processes + +**Specified by:** +- `listProcesses` in interface `IPHXMonitorable` + +**Throws:** +- `java.io.IOException` - If there was a problem reading information about running processes + +### listMonitorableFiles +``` +public java.lang.String[] listMonitorableFiles() + throws java.io.IOException +``` +Lists available "monitors". This will be "stdout" and "stderr". + +**Specified by:** +- `listMonitorableFiles` in interface `IPHXMonitorable` + +**Throws:** +- `java.io.IOException` + +### getMonitor +``` +public java.lang.Object getMonitor(java.lang.String m) + throws PHXNoSuchObjectException +``` +Returns any available monitors by name. + +**Specified by:** +- `getMonitor` in interface `IPHXMonitorable` + +**Returns:** +- either a `PHXRawFile` or a `PHXMonitorableStream` object + +**Throws:** +- `PHXNoSuchObjectException` + +### addTraceListener +``` +public void addTraceListener(com.phoenix_int.aserver.trace.IPHXTraceListener listener) +``` +Adds a listener to trace events + +**Specified by:** +- `addTraceListener` in interface `com.phoenix_int.aserver.trace.IPHXTraceGenerator` + +**Parameters:** +- `listener` - the listener + +### removeTraceListener +``` +public void removeTraceListener(com.phoenix_int.aserver.trace.IPHXTraceListener listener) +``` +Removes a listener from trace events + +**Specified by:** +- `removeTraceListener` in interface `com.phoenix_int.aserver.trace.IPHXTraceGenerator` + +**Parameters:** +- `listener` - the listener \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md new file mode 100644 index 0000000000..5fb080bfb1 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md @@ -0,0 +1,599 @@ +# Class: PHXSimpleSelfManager + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXSimpleSelfManager +``` + +**Implemented Interfaces** +- `IPHXSelfManager`, `IPHXComponent` + +**Direct Known Subclasses:** +- [PHXSimpleSelfManager2](../../../com/phoenix_int/aserver/PHXSimpleSelfManager2.html) + +**Declaration** +```java +public class PHXSimpleSelfManager + extends java.lang.Object + implements IPHXSelfManager, IPHXComponent +``` + +This is a class that implements most of the functionality of a self-managing component. The class provides utility functions for storing variables. These variables are then served to the ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. + + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXSimpleSelfManager()` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `protected void` | `addMethod(java.lang.String name)`
Relay function for addMethod(String name, boolean isVisible=true) | +| `protected void` | `addMethod(java.lang.String name, boolean isVisible)`
Relay function for addMethod(String name, String fullName = name, boolean isVisible) | +| `protected void` | `addMethod(java.lang.String name, java.lang.String fullName)`
Relay function for addMethod(String name, String fullName, boolean isVisible=true) | +| `protected void` | `addMethod(java.lang.String name, java.lang.String fullName, boolean isVisible)`
Relay function for addMethod(String name, String fullName, boolean isVisible, boolean downloadInputs = false) | +| `protected void` | `addMethod(java.lang.String name, java.lang.String fullName, boolean isVisible, boolean downloadInputs)`
Adds a method name to the object | +| `protected void` | `addVariable(PHXVariableInfo varInfo)`
Adds a variable information object to the manager | +| `protected void` | `addVariable(java.lang.String varName, boolean isInput, java.lang.Object var)`
Adds a variable object to the manager | +| `protected void` | `addVariable(java.lang.String groupName, PHXVariableInfo varInfo)`
Adds a variable information object to the manager | +| `protected void` | `addVariable(java.lang.String groupName, java.lang.String varName, boolean isInput, java.lang.Object var)`
Adds a variable object to the manager | +| `void` | `end()`
Notifies the driver that it has ended. | +| `void` | `forceSetValue(java.lang.String name, java.lang.String value)`
Sets the value for a variable regardless of whether it's an input or an output | +| `protected PHXGroup` | `getGroup(java.lang.String group)`
Retrieves a group. | +| `protected PHXGroup` | `getGroup2(java.lang.String group)`
Retrieves a group. | +| `protected PHXMethodDescriptor` | `getMethodDescriptor(java.lang.String name)`
Find the Method Descriptor associated with a given name | +| `PHXMethodDescriptor[]` | `getMethodDescriptors()`
Retrieves a set of method descriptors for this object | +| `PHXPropertyDescriptor[]` | `getPropertyDescriptors(java.lang.String name)`
Retrieves a set of property descriptors for the variables managed by this object or one of its subobjects | +| `PHXGroup` | `getRootGroup()`
Retrieves the root group | +| `java.lang.String` | `getValue(java.lang.String name)`
Retrieves the value for the appropriate variable | +| `java.lang.Object` | `getValue2(java.lang.String name)`
Retrieves the value for the appropriate variable | +| `java.lang.String` | `getVariableFullName(java.lang.Object var)`
Gets the name of a variable | +| `PHXVariableInfo` | `getVariableInfo(java.lang.Object var)`
Gets the information about a variable | +| `protected PHXVariableInfo` | `getVariableInfo(java.lang.String fullVarName)`
Retrieves a variable information object from the manager | +| `protected PHXVariableInfo` | `getVariableInfo(java.lang.String groupName, java.lang.String varName)`
Retrieves a variable information object from the manager | +| `protected PHXVariableInfo` | `getVariableInfo2(java.lang.String fullVarName)`
Retrieves a variable information object from the manager | +| `protected PHXVariableInfo` | `getVariableInfo2(java.lang.String groupName, java.lang.String varName)`
Retrieves a variable information object from the manager | +| `java.lang.String` | `invoke(java.lang.String methodName)`
Invokes a named method. | +| `PHXInvokeReturn` | `invoke2(java.lang.String methodName)`
Invokes a named method. | +| `protected PHXGroup` | `makeGroup(java.lang.String group)`
Creates a group. | +| `protected boolean` | `removeVariable(PHXVariableInfo varInfo)`
Removes a variable. | +| `void` | `setValue(java.lang.String name, java.lang.String value)`
Stores a value into the appropriate variable | +| `void` | `setValue2(java.lang.String name, PHXStringBuffer value)`
Stores a value into the appropriate variable | +| `void` | `setValueActual(java.lang.String name, java.lang.Object value)` | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXSimpleSelfManager +```java +public PHXSimpleSelfManager() +``` + +## Method Detail + +### addVariable +```java +protected void addVariable(java.lang.String groupName, + java.lang.String varName, + boolean isInput, + java.lang.Object var) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +adds a variable object to the manager + +**Parameters:** +- `groupName`- the group to store the variable in. May be a dot-separated list of groups +- `varName`- the name of the variable +- `isInput`- true if the variable is an input +- `var`- the variable information to add + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### addVariable +```java +protected void addVariable(java.lang.String varName, + boolean isInput, + java.lang.Object var) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +adds a variable object to the manager + +**Parameters:** +- `varName`- the name of the variable +- `isInput`- true if the variable is an input +- `var`- the variable information to add + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### addVariable +```java +protected void addVariable(PHXVariableInfo varInfo) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +adds a variable information object to the manager + +**Parameters:** +- `varInfo`- the variable information object + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### addVariable +```java +protected void addVariable(java.lang.String groupName, + PHXVariableInfo varInfo) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +adds a variable information object to the manager + +**Parameters:** +- `groupName`- the group to store the variable in. May be a dot-separated list of groups +- `varInfo`- the variable information object + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### removeVariable +```java +protected boolean removeVariable(PHXVariableInfo varInfo) +``` +removes a variable. The groups will be searched for the matching variable. + +**Parameters:** +- `varInfo`- the variable structure to remove + +**Returns:** +- false if the variable was not found + +### addMethod +```java +protected void addMethod(java.lang.String name, + java.lang.String fullName, + boolean isVisible, + boolean downloadInputs) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +adds a method name to the object + +**Parameters:** +- `name`- the name of the method +- `fullName`- the human readable name +- `isVisible`- if true, the method is displayed using the listMethods command. Invoking is handled by the derived class, so it is up to it whether invisible methods may be invoked. +- `downloadInputs`- if true, signal calling application that input variable values need to be reread + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### getMethodDescriptor +```java +protected PHXMethodDescriptor getMethodDescriptor(java.lang.String name) +``` +find the Method Descriptor associated with a given name + +**Returns:** +- The PHXMethodDescriptor, or null if not found. + +### addMethod +```java +protected void addMethod(java.lang.String name, + java.lang.String fullName, + boolean isVisible) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +relay function for addMethod( String name, String fullName, boolean isVisible, boolean downloadInputs = false ) + +**Parameters:** +- `name`- the name of the method +- `fullName`- the human readable name +- `isVisible`- if true, the method is displayed using the listMethods command. Invoking is handled by the derived class, so it is up to it whether invisible methods may be invoked. + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### addMethod +```java +protected void addMethod(java.lang.String name, + boolean isVisible) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +relay function for addMethod( String name, String fullName = name, boolean isVisible ) + +**Parameters:** +- `name`- the name of the method + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### addMethod +```java +protected void addMethod(java.lang.String name, + java.lang.String fullName) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +relay function for addMethod( String name, String fullName, boolean isVisible=true ) + +**Parameters:** +- `name`- the name of the method + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### addMethod +```java +protected void addMethod(java.lang.String name) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +relay function for addMethod( String name, boolean isVisible=true ) + +**Parameters:** +- `name`- the name of the method + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### makeGroup +```java +protected PHXGroup makeGroup(java.lang.String group) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +creates a group. If the group already exists, it is just returned + +**Parameters:** +- `group`- the name of the group. This name follows the dot-syntax format for the parent-child relationship + +**Throws:** +- `PHXNameAlreadyInUseException`- thrown if the name is already in use +- `PHXInvalidNameException`- thrown if the name has invalid characters + +### getVariableFullName +```java +public java.lang.String getVariableFullName(java.lang.Object var) + throws PHXNoSuchObjectException +``` +gets the name of a variable + +**Parameters:** +- `var`- the variable object + +**Returns:** +- the name of the variable or null if not found + +**Throws:** +- `PHXNoSuchObjectException` + +### getVariableInfo +```java +public PHXVariableInfo getVariableInfo(java.lang.Object var) + throws PHXNoSuchObjectException +``` +gets the information about a variable + +**Parameters:** +- `var`- the variable object + +**Returns:** +- the PHXVariableInfo object associated with the variable + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified variable is not found + +### getVariableInfo +```java +protected PHXVariableInfo getVariableInfo(java.lang.String fullVarName) + throws PHXNoSuchObjectException +``` +retrieves a variable information object from the manager + +**Parameters:** +- `fullVarName`- The var name in format "group.group.name" + +**Returns:** +- the associated variableInfo object + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified variable is not found + +### getVariableInfo2 +```java +protected PHXVariableInfo getVariableInfo2(java.lang.String fullVarName) +``` +retrieves a variable information object from the manager + +**Parameters:** +- `fullVarName`- The var name in format "group.group.name" + +**Returns:** +- the associated variableInfo object or null if it doesn't exist. + +### getVariableInfo +```java +protected PHXVariableInfo getVariableInfo(java.lang.String groupName, + java.lang.String varName) + throws PHXNoSuchObjectException +``` +retrieves a variable information object from the manager + +**Parameters:** +- `groupName`- the group to store the variable in. May be a dot-separated list of groups +- `varName`- the name of the variable information object + +**Returns:** +- the associated variableInfo object + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified variable is not found + +### getVariableInfo2 +```java +protected PHXVariableInfo getVariableInfo2(java.lang.String groupName, + java.lang.String varName) +``` +retrieves a variable information object from the manager + +**Parameters:** +- `groupName`- the group to store the variable in. May be a dot-separated list of groups +- `varName`- the name of the variable information object + +**Returns:** +- the associated variableInfo object or null if not found + +### getGroup +```java +protected PHXGroup getGroup(java.lang.String group) + throws PHXNoSuchObjectException +``` +retrieves a group. + +**Parameters:** +- `group`- the name of the group. This name follows the dot-syntax format for the parent-child relationship + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified group is not found + +### getGroup2 +```java +protected PHXGroup getGroup2(java.lang.String group) +``` +retrieves a group. + +**Parameters:** +- `group`- the name of the group. This name follows the dot-syntax format for the parent-child relationship + +**Returns:** +- The PHXGroup object, or null if not found. + +### getRootGroup +```java +public PHXGroup getRootGroup() +``` +retrieves the root group + +**Returns:** +- the root group + +### setValue +```java +public void setValue(java.lang.String name, + java.lang.String value) + throws PHXNoSuchObjectException, + PHXNoSuchWriteableObjectException, + java.lang.Exception +``` +stores a value into the appropriate variable + +**Specified by:** +- `setValue`in interface`IPHXSelfManager` + +**Parameters:** +- `name`- the name of the variable +- `value`- the value to store + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified object does not exist +- `PHXNoSuchWriteableObjectException`- thrown if the specified object cannot be + written to +- `java.lang.Exception`- thrown if the value cannot be set + +### setValue2 +```java +public void setValue2(java.lang.String name, + PHXStringBuffer value) + throws PHXNoSuchObjectException, + PHXNoSuchWriteableObjectException, + java.lang.Exception +``` +stores a value into the appropriate variable + +**Parameters:** +- `name`- the name of the variable +- `value`- the value to store + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified object does not exist +- `PHXNoSuchWriteableObjectException`- thrown if the specified object cannot be + written to +- `java.lang.Exception`- thrown if the value cannot be set + +### forceSetValue +```java +public void forceSetValue(java.lang.String name, + java.lang.String value) + throws PHXNoSuchObjectException, + java.lang.Exception +``` +sets the value for a variable regardless of whether it's an input or an output + +**Parameters:** +- `name`- the name of the variable +- `value`- the value to store + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified object does not exist +- `java.lang.Exception`- thrown if the value cannot be set + +### setValueActual +```java +public void setValueActual(java.lang.String name, + java.lang.Object value) + throws PHXNoSuchObjectException, + PHXNoSuchWriteableObjectException, + java.lang.IllegalAccessException, + java.lang.reflect.InvocationTargetException +``` + +**Throws:** +- `PHXNoSuchObjectException` +- `PHXNoSuchWriteableObjectException` +- `java.lang.IllegalAccessException` +- `java.lang.reflect.InvocationTargetException` + +### getValue +```java +public java.lang.String getValue(java.lang.String name) + throws PHXNoSuchObjectException, + java.lang.Exception +``` +retrieves the value for the appropriate variable + +**Specified by:** +- `getValue`in interface`IPHXSelfManager` + +**Parameters:** +- `name`- the name of the variable + +**Returns:** +- a String reprentation of the value + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified object does not exist +- `java.lang.Exception`- thrown if the value cannot be retrieved + +### getValue2 +```java +public java.lang.Object getValue2(java.lang.String name) + throws PHXNoSuchObjectException, + java.lang.Exception +``` +retrieves the value for the appropriate variable + +**Parameters:** +- `name`- the name of the variable + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified object does not exist +- `java.lang.Exception`- thrown if the value cannot be retrieved + +### getPropertyDescriptors +```java +public PHXPropertyDescriptor[] getPropertyDescriptors(java.lang.String name) + throws PHXNoSuchObjectException, + java.lang.Exception +``` +retrieves a set of property descriptors for the variables managed by this object or one of it's subobjects + +**Specified by:** +- `getPropertyDescriptors`in interface`IPHXSelfManager` + +**Parameters:** +- `name`- the name of the object to retrieve the property descriptors. If the value is null, then the top level + is searched. + +**Returns:** +- an array of PHXPropertyDescriptors + +**Throws:** +- `PHXNoSuchObjectException`- thrown if the specified object does not exist +- `java.lang.Exception`- thrown if the properties cannot be retrieved + +### getMethodDescriptors +```java +public PHXMethodDescriptor[] getMethodDescriptors() + throws java.lang.Exception +``` +retrieves a set of method descriptors for this object + +**Specified by:** +- `getMethodDescriptors`in interface`IPHXSelfManager` + +**Returns:** +- an array of MethodDescriptors + +**Throws:** +- `java.lang.Exception`- thrown if the properties cannot be retrieved + +### invoke +```java +public java.lang.String invoke(java.lang.String methodName) + throws java.lang.Exception +``` +Invokes a named method. + +**Specified by:** +- `invoke`in interface`IPHXSelfManager` + +**Parameters:** +- `methodName`- the name of the method to invoke on obj + +**Returns:** +- the return value from the invocation + +**Throws:** +- `java.lang.Exception`- thrown if a problem occurs invoking the method + +### invoke2 +```java +public PHXInvokeReturn invoke2(java.lang.String methodName) + throws java.lang.Exception +``` +Invokes a named method. + +**Parameters:** +- `methodName`- the name of the method to invoke on obj + +**Returns:** +- the return value from the invocation + +**Throws:** +- `java.lang.Exception`- thrown if a problem occurs invoking the method + +### end +```java +public void end() + throws java.lang.Exception +``` +Description copied from interface:`IPHXComponent`notifies the driver that it has ended. The driver should perform any necesary shutdown functions. + +**Specified by:** +- `end`in interface`IPHXComponent` + +**Throws:** +- `java.lang.Exception`- thrown if the function does not complete succesfully \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md new file mode 100644 index 0000000000..4ede75ab45 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md @@ -0,0 +1,52 @@ +# Class: PHXSimpleSelfManager2 + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXSimpleSelfManager + ↳ com.phoenix_int.aserver.PHXSimpleSelfManager2 +``` + +**Implemented Interfaces** +- `IPHXComponent`, `IPHXSelfManager`, `IPHXSelfManager2` + +**Direct Known Subclasses:** +- [PHXSimpleSelfManager3](../../../com/phoenix_int/aserver/PHXSimpleSelfManager3.html) + +**Declaration** +```java +public class PHXSimpleSelfManager2 + extends PHXSimpleSelfManager + implements IPHXSelfManager2 +``` + +This class implements most of the functionality of a self-managing component. It provides utility functions for storing variables, which are then served to ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. This second iteration provides new functions for setValue and getValue capable of streaming large files and strings without loading them into memory via the PHXStringBuffer and PHXRawFile classes. + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXSimpleSelfManager2()` | + +## Method Summary + +### Methods inherited from class com.phoenix_int.aserver.PHXSimpleSelfManager +`addMethod`, `addVariable`, `end`, `forceSetValue`, `getGroup`, `getGroup2`, `getMethodDescriptor`, `getMethodDescriptors`, `getPropertyDescriptors`, `getRootGroup`, `getValue`, `getValue2`, `getVariableFullName`, `getVariableInfo`, `invoke`, `invoke2`, `makeGroup`, `removeVariable`, `setValue`, `setValue2`, `setValueActual` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager2 +`getValue2`, `setValue2` + +### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager +`getMethodDescriptors`, `getPropertyDescriptors`, `getValue`, `invoke`, `setValue` + +## Constructor Detail + +### PHXSimpleSelfManager2 +```java +public PHXSimpleSelfManager2() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md new file mode 100644 index 0000000000..7c6f8aa2d1 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md @@ -0,0 +1,104 @@ +# Class: PHXSimpleSelfManager3 + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXSimpleSelfManager + ↳ com.phoenix_int.aserver.PHXSimpleSelfManager2 + ↳ com.phoenix_int.aserver.PHXSimpleSelfManager3 +``` + +**Implemented Interfaces** +- `IPHXComponent`, `com.phoenix_int.aserver.IPHXConnector`, `IPHXSelfManager`, `IPHXSelfManager2`, `IPHXSelfManager3` + +**Declaration** +```java +public class PHXSimpleSelfManager3 + extends PHXSimpleSelfManager2 + implements IPHXSelfManager3, com.phoenix_int.aserver.IPHXConnector +``` + +This class implements most of the functionality of a self-managing component. It provides utility functions for storing variables, which are then served to ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. This iteration provides new functions for setValue and getValue capable of streaming large files and strings without loading them into memory via the PHXStringBuffer and PHXRawFile classes. The third iteration adds a function for getting info from the user on invoked methods to determine things like whether input values should be read in again. + +When extending this class, it may be worth investigating other interfaces to see which of them should also be implemented, such as: +- IPHXSetupFromFile +- IPHXFilteredWrapper +- IPHXAthenaAnalysis +- IPHXHaltableComponent +- IPHXSelfManager2 +- IPHXMonitorable +- IPHXTraceListener +- IPHXTraceGenerator +- ILazyLoadComponent +- AutoCloseable + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXSimpleSelfManager3()` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `com.phoenix_int.aserver.ascore.PHXConnection` | `getConnection()`
Gets the connection object | +| `PHXRunShare` | `getRunShare2()`
Return the run share object | +| `void` | `setConnection(com.phoenix_int.aserver.ascore.PHXConnection c)`
Sets the connection object | +| `void` | `setRunShare2(PHXRunShare rs)`
Sets the run share object | + +### Methods inherited from class com.phoenix_int.aserver.PHXSimpleSelfManager +`addMethod`, `addVariable`, `end`, `forceSetValue`, `getGroup`, `getGroup2`, `getMethodDescriptor`, `getMethodDescriptors`, `getPropertyDescriptors`, `getRootGroup`, `getValue`, `getValue2`, `getVariableFullName`, `getVariableInfo`, `invoke`, `invoke2`, `makeGroup`, `removeVariable`, `setValue`, `setValue2`, `setValueActual` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager3 +`invoke2` + +### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager2 +`getValue2`, `setValue2` + +### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager +`getMethodDescriptors`, `getPropertyDescriptors`, `getValue`, `invoke`, `setValue` + +## Constructor Detail + +### PHXSimpleSelfManager3 +```java +public PHXSimpleSelfManager3() +``` + +## Method Detail + +### getRunShare2 +```java +public PHXRunShare getRunShare2() +``` +Return the run share object + +### setRunShare2 +```java +public void setRunShare2(PHXRunShare rs) +``` +Sets the run share object + +### setConnection +```java +public void setConnection(com.phoenix_int.aserver.ascore.PHXConnection c) +``` +Sets the connection object + +**Specified by:** +- `setConnection` in interface `com.phoenix_int.aserver.IPHXConnector` + +### getConnection +```java +public com.phoenix_int.aserver.ascore.PHXConnection getConnection() +``` +Gets the connection object + +**Specified by:** +- `getConnection` in interface `com.phoenix_int.aserver.IPHXConnector` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md new file mode 100644 index 0000000000..33b45dfdfa --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md @@ -0,0 +1,99 @@ +# Class: PHXVariableInfo + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXVariableInfo +``` + +**Declaration** +```java +public class PHXVariableInfo + extends java.lang.Object +``` + +This is a utility class for holding parsing information about a variable. + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXVariableInfo()`
Creates an uninitialized object. | +| `PHXVariableInfo(java.lang.String name, boolean input, java.lang.Object var)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getName()` | +| `java.lang.String` | `getType()` | +| `java.lang.Object` | `getVariable()` | +| `void` | `initialize(java.lang.String name, boolean input, java.lang.Object var)`
Initializes the variable | +| `boolean` | `isInput()` | +| `void` | `setVariable(java.lang.Object var)` | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXVariableInfo +```java +public PHXVariableInfo() +``` +Creates an uninitialized object. Initialize must be called before any of the methods will work properly. + +### PHXVariableInfo +```java +public PHXVariableInfo(java.lang.String name, boolean input, java.lang.Object var) + throws PHXInvalidNameException +``` +**Parameters:** +- `name` - the name of the variable +- `input` - true if the variable is an input, false if an output +- `var` - the actual variable +**Throws:** +- `PHXInvalidNameException` - thrown if the name contains invalid characters + +## Method Detail + +### initialize +```java +public void initialize(java.lang.String name, boolean input, java.lang.Object var) + throws PHXInvalidNameException +``` +Initializes the variable +**Parameters:** +- `name` - the name of the variable +- `input` - true if the variable is an input, false if an output +- `var` - the actual variable + +**Throws:** +- `PHXInvalidNameException` - thrown if the name contains invalid characters + +### getName +```java +public java.lang.String getName() +``` + +### isInput +```java +public boolean isInput() +``` + +### getVariable +```java +public java.lang.Object getVariable() +``` + +### setVariable +```java +public void setVariable(java.lang.Object var) +``` + +### getType +```java +public java.lang.String getType() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md new file mode 100644 index 0000000000..a30bde17d7 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md @@ -0,0 +1,31 @@ +# Class: ProcessHaltedException + +**Package:** `com.phoenix_int.aserver` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ java.io.IOException + ↳ com.phoenix_int.aserver.ProcessHaltedException +``` + +**Implemented Interfaces** +- `java.io.Serializable` + +**Declaration** +```java +public class ProcessHaltedException + extends java.io.IOException +``` + +Exception indicating that the request cannot be handled because the associated process was halted. + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md new file mode 100644 index 0000000000..defe127087 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md @@ -0,0 +1,44 @@ +# Interface: IPHXAnalysisClientListener + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** +``` +↳ java.util.EventListener + ↳ com.phoenix_int.aserver.client.IPHXAnalysisClientListener +``` + +**Declaration** +```java +public interface IPHXAnalysisClientListener + extends java.util.EventListener +``` + +This interface is used by the `PHXAnalysisClient` class. The `onResponse()` method is called each time a new response is received from the server. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `onException(PHXAnalysisClientExceptionEvent e)`
Called each time an exception occurs while reading from the connection to the ModelCenter Remote Execution. | +| `void` | `onResponse(PHXAnalysisClientEvent e)`
Called each time a new response is received from the ModelCenter Remote Execution. | + +## Method Detail + +### onResponse +```java +void onResponse(PHXAnalysisClientEvent e) +``` +Called each time a new response is received from the ModelCenter Remote Execution. + +**Parameters:** +- `e` - The event structure holding the response object and event id. + +### onException +```java +void onException(PHXAnalysisClientExceptionEvent e) +``` +Called each time an exception occurs while reading from the connection to the ModelCenter Remote Execution. + +**Parameters:** +- `e` - The event structure holding the Exception object and event id. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md new file mode 100644 index 0000000000..a59eebd2c6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md @@ -0,0 +1,2253 @@ +# Class: PHXAnalysisClient + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.client.PHXAnalysisClient +``` + +**Declaration** +```java +@Deprecated +public class PHXAnalysisClient + extends java.lang.Object +``` + +This class automates communications with the ModelCenter Remote Execution. Communication can be performed asynchronously or synchronously. Synchronous communication is performed by calling any of the direct access functions, e.g. `start()` or `listProperties()`. Asynchronous communication is performed by calling a `sendXXXRequest()` function and then calling the matching `getXXXResponse()` when the response is ready. Listener methods are provided for notification of responses. + +Sample Usage: + +```java + // this code connects to the ModelCenter Remote Execution and performs serveral + // functions + String host = "phoenix-int.com"; + try + { + PHXAnalysisClient client = new PHXAnalysisClient( host ); + + // list all the classes + String classes[] = client.listClasses( null ); + System.out.println( classes.length + " classes found:" ); + for ( int i = 0; i < classes.length; i++ ) + { + System.out.println( " Class: " + classes[i] ); + + PHXComponentDescription d = client.describe( classes[i] ); + + System.out.println( " Author: " + d.getAuthor() ); + System.out.println( " Version: " + d.getVersion() ); + System.out.println( " HasIcon: " + d.getHasIcon() ); + System.out.println( " Description: " + d.getDescription() ); + } + + // start up the block analysis + String msg = client.start( "Block", "b" ); + + // query for it's props + PHXPropertyDescriptor props[] = client.listProperties( "b" ); + System.out.println( props.length + " properties found:" ); + for ( int i = 0; i < props.length; i++ ) + { + System.out.println( " Prop: " + props[i].getName() ); + System.out.println( " type: " + props[i].getType() ); + System.out.println( " canGet: " + props[i].getCanGet() ); + System.out.println( " canSet: " + props[i].getCanSet() ); + } + + // perform a bunch of operations + client.set( "b.height", Double.toString( 3.141593 ) ); + for ( int i = 0; i < 10; i++ ) + { + msg = client.set( "b.width", Integer.toString( i ) ); + msg = client.execute( "b" ); + + System.out.println( "when width = " + client.get( "b.width" ) + + ", area = " + client.get( "b.area" ) ); + } + + // end the analysis + client.end( "b" ); + + client.close(); + } + catch ( Exception e ) + { + System.out.println( e ); + } + +``` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static int` | `ADD_PROXY_CLIENTS_REQUEST`
Deprecated. | +| `static int` | `ARBITRARY_REQUEST`
Deprecated. | +| `static int` | `DELETE_RUN_SHARE_REQUEST`
Deprecated. | +| `static int` | `DESCRIBE_REQUEST`
Deprecated. | +| `static int` | `END_REQUEST`
Deprecated. | +| `static int` | `EXECUTE_REQUEST`
Deprecated. | +| `static int` | `GET_BY_URL_REQUEST`
Deprecated. | +| `static int` | `GET_HIERARCHY_REQUEST`
Deprecated. | +| `static int` | `GET_ICON_REQUEST`
Deprecated. | +| `static int` | `GET_REQUEST`
Deprecated. | +| `static int` | `HISTORY_REQUEST`
Deprecated. | +| `static int` | `INVOKE_REQUEST`
Deprecated. | +| `static int` | `LIST_ARRAY_VALUES_REQUEST`
Deprecated. | +| `static int` | `LIST_CATEGORIES_REQUEST`
Deprecated. | +| `static int` | `LIST_CLASSES_REQUEST`
Deprecated. | +| `static int` | `LIST_METHODS_REQUEST`
Deprecated. | +| `static int` | `LIST_PROPERTIES_REQUEST`
Deprecated. | +| `static int` | `LIST_REQUEST`
Deprecated. | +| `static int` | `LIST_VALUES_REQUEST`
Deprecated. | +| `static int` | `LIST_VALUES_URL_REQUEST`
Deprecated. | +| `static int` | `SET_BY_URL_REQUEST`
Deprecated. | +| `static int` | `SET_DICTIONARY_REQUEST`
Deprecated. | +| `static int` | `SET_HIERARCHY_REQUEST`
Deprecated. | +| `static int` | `SET_REQUEST`
Deprecated. | +| `static int` | `START_REQUEST`
Deprecated. | + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXAnalysisClient()`
Deprecated. | +| `PHXAnalysisClient(java.lang.String host)`
Deprecated. Creates a client to the ModelCenter Remote Execution and connects it to the specified host. | +| `PHXAnalysisClient(java.lang.String host, int port)`
Deprecated. Creates a client to the MCRE and connects it to the specified host. | +| `PHXAnalysisClient(java.lang.String host, int port, int timeout)`
Deprecated. Creates a client to the MCRE and connects it to the specified host. | +| `PHXAnalysisClient(java.lang.String host, int timeout, java.lang.String username, java.lang.String password)`
Deprecated. Creates a client to the MCRE and connects it to the specified host. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addListener(IPHXAnalysisClientListener l)`
Deprecated. Adds a listener. | +| `java.lang.String` | `addProxyClients(java.lang.String clients)`
Deprecated. Tells the server to add other hosts as part of the proxy chain. | +| `void` | `close()`
Deprecated. Closes the connection to the server. | +| `void` | `connect(java.lang.String host)`
Deprecated. Connects to the MCRE on the specified host. | +| `void` | `connect(java.lang.String host, int port)`
Deprecated. Connects to the MCRE on the specified host. | +| `void` | `connect(java.lang.String host, int port, boolean useSSL)`
Deprecated. Connects to the MCRE on the specified host. | +| `void` | `connect(java.lang.String host, int port, boolean useSSL, int timeout)`
Deprecated. Connects to the MCRE on the specified host. | +| `void` | `connect(java.lang.String host, int port, boolean useSSL, int timeout, java.lang.String username, java.lang.String password)`
Deprecated. Connects to the MCRE on the specified host. | +| `void` | `connectExternal(java.lang.String host, int timeout, java.lang.String username, java.lang.String password)`
Deprecated. Connects to the MCRE via external tool. | +| `void` | `connectLocal(java.lang.String userName, java.lang.String password)`
Deprecated. Makes a virtual connection to the ModelCenter Remote Execution inside of this process. | +| `void` | `connectLocal(java.lang.String userName, java.lang.String password, java.util.Map initialProps)`
Deprecated. Makes a virtual connection to the MCRE inside of this process. | +| `void` | `connectProcess(java.lang.String userName, java.lang.String password, java.lang.String asRoot, java.lang.String asConfig)`
Deprecated. Makes a virtual connection to the MCRE by calling a new java process. | +| `void` | `connectURL(java.lang.String url)`
Deprecated. Connects to the MCRE using the specified URL, such as mcre://hostname. | +| `void` | `connectURL(java.lang.String url, int timeout, java.lang.String user, java.lang.String password)`
Deprecated. Connects to the ModelCenter Remote Execution using the specified URL, such as mcre://hostname. | +| `java.lang.String` | `deleteRunShare(java.lang.Long key)`
Deprecated. Handle cleaning up a runShare in a local client. | +| `PHXComponentDescription` | `describe(java.lang.String analysis)`
Deprecated. Describes an analysis. | +| `java.lang.String` | `end(java.lang.String analysis)`
Deprecated. Ends an analysis. | +| `java.lang.String` | `execute(java.lang.String analysis)`
Deprecated. Executes an analysis. | +| `protected void` | `finalize()`
Deprecated. | +| `java.lang.String` | `get(java.lang.String property)`
Deprecated. Get the value of a property. | +| `PHXStringBuffer` | `get2(java.lang.String property)`
Deprecated. Get the value of a property. | +| `java.lang.String` | `getAddProxyClientsResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXStringBuffer` | `getByUrl(java.lang.String propertyName, java.lang.String url)`
Deprecated. Get the value of a property. | +| `PHXComponentBranch` | `getComponentHistory(java.lang.String analysis)`
Deprecated. Gets the component history for a particular component. | +| `java.lang.String` | `getDeleteRunShareResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXComponentDescription` | `getDescribeResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String` | `getEndResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String` | `getExecuteResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXStringBuffer` | `getGetByUrlResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXComponentBranch` | `getGetComponentHistoryResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXStringBuffer` | `getGetHierarchyResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXIcon` | `getGetIconResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String` | `getGetResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXStringBuffer` | `getGetResponse2(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXStringBuffer` | `getHierarchy(java.lang.String analysis)`
Deprecated. Retrieve the hierarchy for the component. | +| `java.lang.String` | `getHostName()`
Deprecated. Retrieves the host name of the server. | +| `PHXIcon` | `getIcon(java.lang.String analysis)`
Deprecated. Retrieves an icon for an analysis. | +| `java.lang.String` | `getInvokeResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String[]` | `getListArrayValuesResponse(java.lang.String id, boolean wait)`
Deprecated. | +| `java.lang.String[]` | `getListCategoriesResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String[]` | `getListClassesResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXMethodDescriptor[]` | `getListMethodsResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXPropertyDescriptor[]` | `getListPropertiesResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String[]` | `getListResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `PHXPropertyValue[]` | `getListValuesResponse(java.lang.String id, boolean wait)`
Deprecated. | +| `PHXStringBuffer` | `getResponseAsPHXStringBuffer(java.lang.String id, int type, boolean wait)`
Deprecated. Retrieves a low-level response from the server in String format. | +| `java.lang.String` | `getResponseAsText(java.lang.String id, int type, boolean wait)`
Deprecated. Retrieves a low-level response from the server in String format. | +| `PHXStringBuffer` | `getSetByUrlResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String` | `getSetDictionaryResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String` | `getSetHierarchyResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String` | `getSetResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `java.lang.String` | `getStartResponse(java.lang.String id, boolean wait)`
Deprecated. Retrieves a response from the server. | +| `static void` | `handleLogin(java.io.InputStream in, java.io.OutputStream out, java.lang.String username, java.lang.String password)`
Deprecated. | +| `java.lang.String` | `invoke(java.lang.String method)`
Deprecated. Invokes a method. | +| `boolean` | `isConnected()`
Deprecated. Determines if the client is currently connected to a server. | +| `boolean` | `isResponseReady(java.lang.String id)`
Deprecated. Indicates whether a response is ready. | +| `java.lang.String[]` | `list()`
Deprecated. Lists the running objects. | +| `java.lang.String[]` | `listArrayValues(java.lang.String analysis)`
Deprecated. | +| `java.lang.String[]` | `listCategories(java.lang.String category)`
Deprecated. Lists the categories within a category. | +| `java.lang.String[]` | `listClasses(java.lang.String category)`
Deprecated. Lists the classes within a category. | +| `PHXMethodDescriptor[]` | `listMethods(java.lang.String analysis)`
Deprecated. Lists the methods of an analysis. | +| `PHXPropertyDescriptor[]` | `listProperties(java.lang.String analysis)`
Deprecated. Lists the properties of an analysis. | +| `PHXPropertyValue[]` | `listValues(java.lang.String analysis)`
Deprecated. | +| `static void` | `main(java.lang.String[] args)`
Deprecated. | +| `void` | `removeListener(IPHXAnalysisClientListener l)`
Deprecated. Removes a listener. | +| `java.lang.String` | `sendAddProxyClientsRequest(java.lang.String clients)`
Deprecated. Tells the server to add other hosts as part of the proxy chain. | +| `java.lang.String` | `sendArbitraryRequest(PHXStringBuffer request)`
Deprecated. Sends an arbitrary request to the server. | +| `java.lang.String` | `sendArbitraryRequest(java.lang.String request)`
Deprecated. Sends an arbitrary request to the server. | +| `java.lang.String` | `sendDeleteRunShareRequest(java.lang.Long key)`
Deprecated. Sends a request to delete a runShare. | +| `java.lang.String` | `sendDescribeRequest(java.lang.String analysis)`
Deprecated. Sends a request to describe an analysis. | +| `java.lang.String` | `sendEndRequest(java.lang.String analysis)`
Deprecated. Sends a request to end an analysis. | +| `java.lang.String` | `sendExecuteRequest(java.lang.String analysis)`
Deprecated. Sends a request to execute an analysis. | +| `java.lang.String` | `sendGetByUrlRequest(java.lang.String propertyName, java.lang.String url)`
Deprecated. Sends a request to get the value of a property. | +| `java.lang.String` | `sendGetComponentHistoryRequest(java.lang.String analysis)`
Deprecated. Sends a request to get the version history of a component. | +| `java.lang.String` | `sendGetHierarchyRequest(java.lang.String analysis)`
Deprecated. Sends a request to retrieve a hierarchy for a component. | +| `java.lang.String` | `sendGetHierarchyRequest(java.lang.String analysis, com.phoenix_int.aserver.client.PHXHierarchyFileMode fileMode)`
Deprecated. Sends a request to retrieve a hierarchy for a component. | +| `java.lang.String` | `sendGetIconRequest(java.lang.String analysis)`
Deprecated. Sends a request to retrieve an icon. | +| `java.lang.String` | `sendGetRequest(java.lang.String property)`
Deprecated. Sends a request to get the value of a property. | +| `java.lang.String` | `sendInvokeRequest(java.lang.String method)`
Deprecated. Sends a request to invoke a method. | +| `java.lang.String` | `sendListArrayValuesRequest(java.lang.String analysis)`
Deprecated. | +| `java.lang.String` | `sendListCategoriesRequest(java.lang.String category)`
Deprecated. Sends a request to list the categories. | +| `java.lang.String` | `sendListClassesRequest(java.lang.String category)`
Deprecated. Sends a request to list the classes. | +| `java.lang.String` | `sendListMethodsRequest(java.lang.String analysis)`
Deprecated. Sends a request to list the methods of an analysis. | +| `java.lang.String` | `sendListPropertiesRequest(java.lang.String analysis)`
Deprecated. Sends a request to list the properties of an analysis. | +| `java.lang.String` | `sendListRequest()`
Deprecated. Sends a request to list the running objects. | +| `java.lang.String` | `sendListValuesRequest(java.lang.String analysis)`
Deprecated. | +| `java.lang.String` | `sendListValuesURLRequest(java.lang.String analysis)`
Deprecated. | +| `java.lang.String` | `sendSetByUrlRequest(java.lang.String varName, java.lang.String url)`
Deprecated. Sends a request to get the value of a property. | +| `java.lang.String` | `sendSetDictionaryRequest(java.lang.String dictionary)`
Deprecated. Sends a request to set a dictionary. | +| `java.lang.String` | `sendSetHierarchyRequest(java.lang.String analysis, PHXStringBuffer xml)`
Deprecated. Sends a request to set a hierarchy for a component. | +| `java.lang.String` | `sendSetRequest(java.lang.String property, java.lang.Object value)`
Deprecated. Sends a request to set the value of a property. | +| `java.lang.String` | `sendStartRequest(java.lang.String analysis, java.lang.String instanceName)`
Deprecated. Sends a request to start an analysis. | +| `java.lang.String` | `set(java.lang.String property, java.lang.Object value)`
Deprecated. Set the value of a property. | +| `void` | `setByUrl(java.lang.String varName, java.lang.String url)`
Deprecated. Set the value of a variable. | +| `void` | `setDeleteDFT(boolean delete)`
Deprecated. Set whether the analysis client should auto-delete Direct File Transfer run shares or not. | +| `java.lang.String` | `setDictionary(java.lang.String dictionary)`
Deprecated. Tries to set the dictionary by sending a set dictionary request. | +| `java.lang.String` | `setHierarchy(java.lang.String analysis, PHXStringBuffer xml)`
Deprecated. Sends a request to set a hierarchy for a component. | +| `java.lang.String` | `start(java.lang.String analysis, java.lang.String instanceName)`
Deprecated. Starts an analysis. | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### START_REQUEST +``` +public static final int START_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### END_REQUEST +``` +public static final int END_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### GET_REQUEST +``` +public static final int GET_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### SET_REQUEST +``` +public static final int SET_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_REQUEST +``` +public static final int LIST_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_CLASSES_REQUEST +``` +public static final int LIST_CLASSES_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_PROPERTIES_REQUEST +``` +public static final int LIST_PROPERTIES_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_CATEGORIES_REQUEST +``` +public static final int LIST_CATEGORIES_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### EXECUTE_REQUEST +``` +public static final int EXECUTE_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### DESCRIBE_REQUEST +``` +public static final int DESCRIBE_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### GET_ICON_REQUEST +``` +public static final int GET_ICON_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_VALUES_REQUEST +``` +public static final int LIST_VALUES_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_ARRAY_VALUES_REQUEST +``` +public static final int LIST_ARRAY_VALUES_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_METHODS_REQUEST +``` +public static final int LIST_METHODS_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### INVOKE_REQUEST +``` +public static final int INVOKE_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### ADD_PROXY_CLIENTS_REQUEST +``` +public static final int ADD_PROXY_CLIENTS_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### HISTORY_REQUEST +``` +public static final int HISTORY_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### GET_BY_URL_REQUEST +``` +public static final int GET_BY_URL_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### GET_HIERARCHY_REQUEST +``` +public static final int GET_HIERARCHY_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### SET_HIERARCHY_REQUEST +``` +public static final int SET_HIERARCHY_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### DELETE_RUN_SHARE_REQUEST +``` +public static final int DELETE_RUN_SHARE_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### SET_DICTIONARY_REQUEST +``` +public static final int SET_DICTIONARY_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### SET_BY_URL_REQUEST +``` +public static final int SET_BY_URL_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### ARBITRARY_REQUEST +``` +public static final int ARBITRARY_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +### LIST_VALUES_URL_REQUEST +``` +public static final int LIST_VALUES_URL_REQUEST +``` +Deprecated. + +**See Also:** +- Constant Field Values + +## Constructor Detail + +### PHXAnalysisClient +``` +public PHXAnalysisClient() +``` +Deprecated. + +### PHXAnalysisClient +``` +public PHXAnalysisClient(java.lang.String host) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +**Parameters:** +- host - the MCRE host to connect to, or the full URL style host specification (`mcre://hostname:port`) + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### PHXAnalysisClient +``` +public PHXAnalysisClient(java.lang.String host, + int port) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +**Parameters:** +- host - the MCRE host to connect to +- port - the port to use for the MCRE (default is 1835) + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### PHXAnalysisClient +``` +public PHXAnalysisClient(java.lang.String host, + int port, + int timeout) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +**Parameters:** +- host - the MCRE host to connect to +- port - the port to use for the MCRE (default is 1835) +- timeout - the number of seconds to wait during the connect + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### PHXAnalysisClient +``` +public PHXAnalysisClient(java.lang.String host, + int timeout, + java.lang.String username, + java.lang.String password) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +**Parameters:** +- host - the MCRE host to connect to +- timeout - the number of seconds to wait during the connect +- username +- password + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +## Method Detail + +### connect +``` +public void connect(java.lang.String host) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +connects to MCRE on the specified host + +**Parameters:** +- host - MCRE host to connect to, or the full URL style host specification (`mcre://hostname:port`) + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### connectURL +``` +public void connectURL(java.lang.String url) + throws java.io.IOException, + java.net.UnknownHostException, + java.net.URISyntaxException +``` +Deprecated. + +connects to MCRE using the specified URL, such as `mcre://hostname`. + +**Parameters:** +- url - MCRE URL style host specification (`mcre://hostname:port`). May include path part, which will be ignored. + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host +- `java.net.URISyntaxException` + +### connectURL +``` +public void connectURL(java.lang.String url, + int timeout, + java.lang.String user, + java.lang.String password) + throws java.io.IOException, + java.net.UnknownHostException, + java.net.URISyntaxException +``` +Deprecated. + +connects to ModelCenter Remote Execution using the specified URL, such as `mcre://hostname`. Note that if you are using mcre+local style connections, you must have previously instantiated MCRE Engine as described in `connectLocal()`. + +**Parameters:** +- url - MCRE URL style host specification (`mcre://hostname:port`). May include path part, which will be ignored. + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host +- `java.net.URISyntaxException` + +### connectLocal +``` +public void connectLocal(java.lang.String userName, + java.lang.String password) + throws java.io.IOException +``` +Deprecated. + +Makes a virtual connection to ModelCenter Remote Execution inside of this process. MCRE must have been previously instantiated using this method: +``` + PHXAnalysisServer.doInitialization( + new String[] {"-aee", "-noSManager", + "-base", "c:\\users\\nsharp\\vers\\MCAS\\ASERVER\\install"}); +``` +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established + +### connectLocal +``` +public void connectLocal(java.lang.String userName, + java.lang.String password, + java.util.Map initialProps) + throws java.io.IOException +``` +Deprecated. + +Makes a virtual connection to MCRE inside of this process. MCRE must have been previously instantiated using this method: +``` + PHXAnalysisServer.doInitialization( + new String[] {"-aee", "-noSManager", + "-base", "c:\\users\\nsharp\\vers\\MCAS\\ASERVER\\install"}); +``` +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established + +### connectProcess +``` +public void connectProcess(java.lang.String userName, + java.lang.String password, + java.lang.String asRoot, + java.lang.String asConfig) + throws java.io.IOException +``` +Deprecated. + +Makes a virtual connection to MCRE by calling a new java process. MCRE must have been previously instantiated using this method: +``` + PHXAnalysisServer.doInitialization( + new String[] {"-aee", "-noSManager", + "-base", "c:\\users\\nsharp\\vers\\MCAS\\ASERVER\\install"}); +``` +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established + +### connect +``` +public void connect(java.lang.String host, + int port) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +connects to MCRE on the specified host + +**Parameters:** +- host - MCRE host to connect to +- port - the port to use for MCRE (default is 1835) + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### connect +``` +public void connect(java.lang.String host, + int port, + boolean useSSL) + throws java.io.IOException, java.net.UnknownHostException +``` +Deprecated. + +connects to MCRE on the specified host + +**Parameters:** +- host - MCRE host to connect to +- port - the port to use for MCRE (default is 1835) +- useSSL - Whether to connect using SSL + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### connectExternal +``` +public void connectExternal(java.lang.String host, + int timeout, + java.lang.String username, + java.lang.String password) + throws java.io.IOException +``` +Deprecated. + +connects to MCRE via external tool + +**Parameters:** +- host - MCRE host to connect to +- timeout - the number of seconds to wait during the connect +- username - the username to use in the external tool +- password - the password to use in the external tool + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### connect +``` +public void connect(java.lang.String host, + int port, + boolean useSSL, + int timeout) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +connects to MCRE on the specified host + +**Parameters:** +- host - MCRE host to connect to +- port - the port to use for MCRE (default is 1835) +- useSSL - Whether to connect using SSL +- timeout - the number of seconds to wait during the connect + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### connect +``` +public void connect(java.lang.String host, + int port, + boolean useSSL, + int timeout, + java.lang.String username, + java.lang.String password) + throws java.io.IOException, + java.net.UnknownHostException +``` +Deprecated. + +connects to MCRE on the specified host + +**Parameters:** +- host - MCRE host to connect to +- port - the port to use for MCRE (default is 1835) +- useSSL - Whether to connect using SSL +- timeout - the number of seconds to wait during the connect +- username - the username for authentication +- password - the password for authentication + +**Throws:** +- `java.io.IOException` - thrown if a connection cannot be established +- `java.net.UnknownHostException` - thrown if the host does not match a valid host + +### handleLogin +``` +public static void handleLogin(java.io.InputStream in, + java.io.OutputStream out, + java.lang.String username, + java.lang.String password) + throws java.io.IOException +``` +Deprecated. + +**Throws:** +- `java.io.IOException` + +### isConnected +``` +public boolean isConnected() +``` +Deprecated. + +determines if the client is currently connected to a server + +**Returns:** +- true if currently connected + +### setDeleteDFT +``` +public void setDeleteDFT(boolean delete) +``` +Deprecated. + +Set whether the analysis client should auto-delete Direct File Transfer run shares or not + +### getHostName +``` +public java.lang.String getHostName() +``` +Deprecated. + +retrieves the host name of the server + +**Returns:** +- the host name, or "not connected" if not currently connected to the server + +### close +``` +public void close() +``` +Deprecated. + +closes the connection to the server + +### finalize +``` +protected void finalize() + throws java.lang.Throwable +``` +Deprecated. + +Overrides: +- finalize in class `java.lang.Object` + +**Throws:** +- `java.lang.Throwable` + +### addListener +``` +public void addListener(IPHXAnalysisClientListener l) +``` +Deprecated. + +adds a listener + +**Parameters:** +- l - the listener + +### removeListener +``` +public void removeListener(IPHXAnalysisClientListener l) +``` +Deprecated. + +removes a listener + +**Parameters:** +- l - the listener + +### isResponseReady +``` +public boolean isResponseReady(java.lang.String id) +``` +Deprecated. + +indicates whether a response is ready + +**Parameters:** +- id - the id of the response + +**Returns:** +- true if the response is ready + +### sendStartRequest +``` +public java.lang.String sendStartRequest(java.lang.String analysis, + java.lang.String instanceName) +``` +Deprecated. + +sends a request to start an analysis + +**Parameters:** +- analysis - the analysis to start +- instanceName - the name for the analysis + +**Returns:** +- the id for the response + +### getStartResponse +``` +public java.lang.String getStartResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the response from the server + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### start +``` +public java.lang.String start(java.lang.String analysis, + java.lang.String instanceName) + throws PHXServerSideException +``` +Deprecated. + +starts an analysis + +**Parameters:** +- analysis - the snalyais to start +- instanceName - the name for the analysis + +**Returns:** +- the response from the server + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendEndRequest +``` +public java.lang.String sendEndRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to end an analysis + +**Parameters:** +- analysis - the analysis to start + +**Returns:** +- the id for the response + +### getEndResponse +``` +public java.lang.String getEndResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the response from the server + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### end +``` +public java.lang.String end(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +ends an analysis + +**Parameters:** +- analysis - the snalyais to end + +**Returns:** +- the response from the server + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendListClassesRequest +``` +public java.lang.String sendListClassesRequest(java.lang.String category) +``` +Deprecated. + +sends a request to list the classes + +**Parameters:** +- category - the category to search. If null, then the root category is searched + +**Returns:** +- the id for the response + +### getListClassesResponse +``` +public java.lang.String[] getListClassesResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- an array of classes + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### listClasses +``` +public java.lang.String[] listClasses(java.lang.String category) + throws PHXServerSideException +``` +Deprecated. + +lists the classes within a category + +**Parameters:** +- category - the category to search. If null, then the root category is searched + +**Returns:** +- an array of classes + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendExecuteRequest +``` +public java.lang.String sendExecuteRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to execute an analysis + +**Parameters:** +- analysis - the analysis to execute + +**Returns:** +- the id for the response + +### getExecuteResponse +``` +public java.lang.String getExecuteResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the response from the server + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### execute +``` +public java.lang.String execute(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +exectutes an analysis + +**Parameters:** +- analysis - the analyais to start + +**Returns:** +- the response from the server + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendAddProxyClientsRequest +``` +public java.lang.String sendAddProxyClientsRequest(java.lang.String clients) +``` +Deprecated. + +Tells the server to add other hosts as part of the proxy chain + +**Parameters:** +- clients - The comma separated list of hosts + +**Returns:** +- the id for the response + +### getAddProxyClientsResponse +``` +public java.lang.String getAddProxyClientsResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the response from the server + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### addProxyClients +``` +public java.lang.String addProxyClients(java.lang.String clients) + throws PHXServerSideException +``` +Deprecated. + +Tells the server to add other hosts as part of the proxy chain + +**Parameters:** +- clients - The comma separated list of hosts + +**Returns:** +- the response from the server + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendGetRequest +``` +public java.lang.String sendGetRequest(java.lang.String property) +``` +Deprecated. + +sends a request to get the value of a property + +**Parameters:** +- property - the property to retrieve a value for + +**Returns:** +- the id for the response + +### getGetResponse +``` +public java.lang.String getGetResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the value of the property + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### getGetResponse2 +``` +public PHXStringBuffer getGetResponse2(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the value of the property + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### get +``` +public java.lang.String get(java.lang.String property) + throws PHXServerSideException +``` +Deprecated. + +get the value of a property + +**Parameters:** +- property - the property to retrieve a value for + +**Returns:** +- the value of the property + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- `PHXServerSideException` - thrown if the the server returned an error + +### get2 +``` +public PHXStringBuffer get2(java.lang.String property) + throws PHXServerSideException +``` +Deprecated. + +get the value of a property + +**Parameters:** +- property - the property to retrieve a value for + +**Returns:** +- the value of the property + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- `PHXServerSideException` - thrown if the the server returned an error + +### sendGetByUrlRequest +``` +public java.lang.String sendGetByUrlRequest(java.lang.String propertyName, + java.lang.String url) +``` +Deprecated. + +sends a request to get the value of a property + +**Parameters:** +- url - The url requested + +**Returns:** +- the id for the response + +### getGetByUrlResponse +``` +public PHXStringBuffer getGetByUrlResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the value of the property + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### getByUrl +``` +public PHXStringBuffer getByUrl(java.lang.String propertyName, + java.lang.String url) + throws PHXServerSideException +``` +Deprecated. + +get the value of a property + +**Parameters:** +- url - the url to get the file contents of + +**Returns:** +- the contents of the file + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- `PHXServerSideException` - thrown if the the server returned an error + +### sendSetByUrlRequest +``` +public java.lang.String sendSetByUrlRequest(java.lang.String varName, + java.lang.String url) +``` +Deprecated. + +sends a request to get the value of a property + +**Parameters:** +- url - The url requested + +**Returns:** +- the id for the response + +### getSetByUrlResponse +``` +public PHXStringBuffer getSetByUrlResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the value of the property + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### setByUrl +``` +public void setByUrl(java.lang.String varName, + java.lang.String url) + throws PHXServerSideException +``` +Deprecated. + +set the value of a variable + +**Parameters:** +- varName - the variable to set +- url - the url to set the variable at + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendSetRequest +``` +public java.lang.String sendSetRequest(java.lang.String property, + java.lang.Object value) +``` +Deprecated. + +sends a request to set the value of a property + +**Parameters:** +- property - the property to retrieve a value for + +**Returns:** +- the id for the response + +### getSetResponse +``` +public java.lang.String getSetResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the response from the server + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### set +``` +public java.lang.String set(java.lang.String property, + java.lang.Object value) + throws PHXServerSideException +``` +Deprecated. + +set the value of a property + +**Parameters:** +- property - the property to retrieve a value for +- value - the value of the property + +**Returns:** +- the response from the server + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- `PHXServerSideException` - thrown if the the server returned an error + +### sendGetComponentHistoryRequest +``` +public java.lang.String sendGetComponentHistoryRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to get the version history of a component + +**Parameters:** +- analysis - the analysis to query + +**Returns:** +- the id for the response + +### getGetComponentHistoryResponse +``` +public PHXComponentBranch getGetComponentHistoryResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- a description object for the analysis + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### getComponentHistory +``` +public PHXComponentBranch getComponentHistory(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +Gets the component history for a particular component. + +**Parameters:** +- analysis - The full path to the component + +**Returns:** +- The top level branch object which represents the main development branch. + +**Throws:** +- `PHXServerSideException` - thrown if the server reports any problems. + +### sendDescribeRequest +``` +public java.lang.String sendDescribeRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to describe an analysis + +**Parameters:** +- analysis - the analysis to start + +**Returns:** +- the id for the response + +### getDescribeResponse +``` +public PHXComponentDescription getDescribeResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- a description object for the analysis + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### describe +``` +public PHXComponentDescription describe(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +describes an analysis + +**Parameters:** +- analysis - the full path to the component + +**Returns:** +- a description object + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendListPropertiesRequest +``` +public java.lang.String sendListPropertiesRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to list the properties of an analysis + +**Parameters:** +- analysis - the analysis to query + +**Returns:** +- the id for the response + +### getListPropertiesResponse +``` +public PHXPropertyDescriptor[] getListPropertiesResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- a property descriptor object for the analysis + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### listProperties +``` +public PHXPropertyDescriptor[] listProperties(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +lists the properties of an analysis + +**Parameters:** +- analysis - the analyais to list properties for + +**Returns:** +- a property descriptor for the object + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendListMethodsRequest +``` +public java.lang.String sendListMethodsRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to list the methods of an analysis + +**Parameters:** +- analysis - the analysis to query + +**Returns:** +- the id for the response + +### getListMethodsResponse +``` +public PHXMethodDescriptor[] getListMethodsResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- a property descriptor object for the analysis + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### listMethods +``` +public PHXMethodDescriptor[] listMethods(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +lists the methods of an analysis + +**Parameters:** +- analysis - the analyais to list methods for + +**Returns:** +- an array of method descriptors for the object + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendInvokeRequest +``` +public java.lang.String sendInvokeRequest(java.lang.String method) +``` +Deprecated. + +sends a request to invoke a method + +**Parameters:** +- method - the method to invoke + +**Returns:** +- the id for the response + +### getInvokeResponse +``` +public java.lang.String getInvokeResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the value of the property + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### invoke +``` +public java.lang.String invoke(java.lang.String method) + throws PHXServerSideException +``` +Deprecated. + +invokes a method + +**Parameters:** +- method - the method to invoke + +**Returns:** +- the results of the invocation + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendListValuesRequest +``` +public java.lang.String sendListValuesRequest(java.lang.String analysis) +``` +Deprecated. + +### sendListValuesURLRequest +``` +public java.lang.String sendListValuesURLRequest(java.lang.String analysis) +``` +Deprecated. + +### getListValuesResponse +``` +public PHXPropertyValue[] getListValuesResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException, + java.io.IOException, + java.lang.NumberFormatException +``` +Deprecated. + +**Throws:** +- `PHXResponseTypeMismatchException` +- `PHXNoSuchResponseException` +- `PHXServerSideException` +- `java.io.IOException` +- `java.lang.NumberFormatException` + +### listValues +``` +public PHXPropertyValue[] listValues(java.lang.String analysis) + throws PHXServerSideException, + java.io.IOException +``` +Deprecated. + +**Throws:** +- `PHXServerSideException` +- `java.io.IOException` + +### sendListArrayValuesRequest +``` +public java.lang.String sendListArrayValuesRequest(java.lang.String analysis) +``` +Deprecated. + +### getListArrayValuesResponse +``` +public java.lang.String[] getListArrayValuesResponse(java.lang.String id, boolean wait) + throws PHXResponseTypeMismatchException, PHXNoSuchResponseException +``` +Deprecated. + +**Throws:** +- `PHXResponseTypeMismatchException` +- `PHXNoSuchResponseException` + +### listArrayValues +``` +public java.lang.String[] listArrayValues(java.lang.String analysis) + throws PHXServerSideException, + java.io.IOException +``` +Deprecated. + +**Throws:** +- PHXServerSideException +- `java.io.IOException` + +### sendListCategoriesRequest +``` +public java.lang.String sendListCategoriesRequest(java.lang.String category) +``` +Deprecated. + +sends a request to list the categories + +**Parameters:** +- category - the category to search. If null, then the root category is searched + +**Returns:** +- the id for the response + +### getListCategoriesResponse +``` +public java.lang.String[] getListCategoriesResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- an array of categories + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### listCategories +``` +public java.lang.String[] listCategories(java.lang.String category) + throws PHXServerSideException +``` +Deprecated. + +lists the categories within a category + +**Parameters:** +- category - the category to search. If null, then the root category is searched + +**Returns:** +- an array of categories + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendListRequest +``` +public java.lang.String sendListRequest() +``` +Deprecated. + +sends a request to list the running objects + +**Returns:** +- the id for the response + +### getListResponse +``` +public java.lang.String[] getListResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- an array of objects + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### list +``` +public java.lang.String[] list() + throws PHXServerSideException +``` +Deprecated. + +lists the running objects + +**Returns:** +- an array of objects + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendGetHierarchyRequest +``` +public java.lang.String sendGetHierarchyRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to retrieve a hierarchy for a component + +**Parameters:** +- analysis - the analysis class to retrieve the icon for + +**Returns:** +- the id for the response + +### sendGetHierarchyRequest +``` +public java.lang.String sendGetHierarchyRequest(java.lang.String analysis, + com.phoenix_int.aserver.client.PHXHierarchyFileMode fileMode) +``` +Deprecated. + +sends a request to retrieve a hierarchy for a component + +**Parameters:** +- analysis - the analysis class to retrieve the icon for +- fileMode - how to retrieve files + +**Returns:** +- the id for the response + +### getGetHierarchyResponse +``` +public PHXStringBuffer getGetHierarchyResponse(java.lang.String id, boolean wait) + throws PHXResponseTypeMismatchException, PHXNoSuchResponseException, PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- an icon Image + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### getHierarchy +``` +public PHXStringBuffer getHierarchy(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +retrievethe hierarchy for the component + +**Parameters:** +- analysis - the analysis class to retrieve the icon for + +**Returns:** +- the string buffer containing the hierarchy + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendSetHierarchyRequest +``` +public java.lang.String sendSetHierarchyRequest(java.lang.String analysis, + PHXStringBuffer xml) +``` +Deprecated. + +Sends a request to set a hierarchy for a component + +**Parameters:** +- analysis - the analysis object or parameter name to set data into +- xml - The XML data structure containing the data to be set. + +**Returns:** +- the id for the response + +### getSetHierarchyResponse +``` +public java.lang.String getSetHierarchyResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the result from the server + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### setHierarchy +``` +public java.lang.String setHierarchy(java.lang.String analysis, + PHXStringBuffer xml) + throws PHXServerSideException +``` +Deprecated. + +Sends a request to set a hierarchy for a component + +**Parameters:** +- analysis - the analysis object or parameter name to set data into +- xml - The XML data structure containing the data to be set. + +**Returns:** +- the result from the server + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendDeleteRunShareRequest +``` +public java.lang.String sendDeleteRunShareRequest(java.lang.Long key) +``` +Deprecated. + +Sends a request to delete a runShare + +**Parameters:** +- key - the key for the runShare to delete + +**Returns:** +- the id for the response + +### getDeleteRunShareResponse +``` +public java.lang.String getDeleteRunShareResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the result from the server + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### deleteRunShare +``` +public java.lang.String deleteRunShare(java.lang.Long key) + throws PHXServerSideException +``` +Deprecated. + +Handle cleaning up a runShare in a local client + +**Throws:** +- PHXServerSideException + +### sendGetIconRequest +``` +public java.lang.String sendGetIconRequest(java.lang.String analysis) +``` +Deprecated. + +sends a request to retrieve an icon + +**Parameters:** +- analysis - the analysis class to retrieve the icon for + +**Returns:** +- the id for the response + +### getGetIconResponse +``` +public PHXIcon getGetIconResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- an icon Image + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### getIcon +``` +public PHXIcon getIcon(java.lang.String analysis) + throws PHXServerSideException +``` +Deprecated. + +retrieves an icon for an analysis + +**Parameters:** +- analysis - the analysis class to retrieve the icon for + +**Returns:** +- an icon Image + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendSetDictionaryRequest +``` +public java.lang.String sendSetDictionaryRequest(java.lang.String dictionary) +``` +Deprecated. + +sends a request to set a dictionary + +**Parameters:** +- dictionary - the desired dictionary + +**Returns:** +- the id for the response + +### getSetDictionaryResponse +``` +public java.lang.String getSetDictionaryResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a response from the server + +**Parameters:** +- id - the id for the response +- wait - if true, the function blocks until the response is ready + +**Returns:** +- an icon Image + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### setDictionary +``` +public java.lang.String setDictionary(java.lang.String dictionary) + throws PHXServerSideException +``` +Deprecated. + +Tries to set the dictionary by sending a set dictionary request. + +**Parameters:** +- dictionary - the desired dictionary + +**Returns:** +- the response from the server, or a blank string for invalid responses + +**Throws:** +- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server + +### sendArbitraryRequest +``` +public java.lang.String sendArbitraryRequest(java.lang.String request) +``` +Deprecated. + +sends an arbitrary request to the server + +**Parameters:** +- request - MCRE api command to send + +**Returns:** +- the id for the response + +### sendArbitraryRequest +``` +public java.lang.String sendArbitraryRequest(PHXStringBuffer request) +``` +Deprecated. + +sends an arbitrary request to the server + +**Parameters:** +- request - MCRE api command to send + +**Returns:** +- the id for the response + +### getResponseAsText +``` +public java.lang.String getResponseAsText(java.lang.String id, + int type, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a low-level response from the server in String format. + +**Parameters:** +- id - the id for the response +- type - the type of response to expect. +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the value of the property + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### getResponseAsPHXStringBuffer +``` +public PHXStringBuffer getResponseAsPHXStringBuffer(java.lang.String id, + int type, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException +``` +Deprecated. + +retrieves a low-level response from the server in String format. + +**Parameters:** +- id - the id for the response +- type - the type of response to expect. +- wait - if true, the function blocks until the response is ready + +**Returns:** +- the value of the property + +**Throws:** +- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. +- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). +- `PHXServerSideException` - thrown if the the server returned an error + +### main +``` +public static void main(java.lang.String[] args) +``` +Deprecated. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md new file mode 100644 index 0000000000..235431153a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md @@ -0,0 +1,56 @@ +# Class: PHXAnalysisClientEvent + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.util.EventObject + ↳ com.phoenix_int.aserver.client.PHXAnalysisClientEvent +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +**Declaration** + +```java +public class PHXAnalysisClientEvent +extends java.util.EventObject +``` + +This class is an event for the `PHXAnalysisClient` class. The event is generated each time a new response is received from the server. + + +**See Also:** +- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.client.PHXAnalysisClientEvent) + +## Field Summary + +### Fields inherited from class java.util.EventObject +`source` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `com.phoenix_int.aserver.client.PHXResponse` | `getResponse()`
retrieves the response | + +### Methods inherited from class java.util.EventObject +`getSource, toString` + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +## Method Detail + +### getResponse +``` +public com.phoenix_int.aserver.client.PHXResponse getResponse() +``` +retrieves the response + +**Returns:** +- the response object \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md new file mode 100644 index 0000000000..49afbb62ce --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md @@ -0,0 +1,55 @@ +# Class: PHXAnalysisClientExceptionEvent + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.util.EventObject + ↳ com.phoenix_int.aserver.client.PHXAnalysisClientExceptionEvent +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +**Declaration** + +```java +public class PHXAnalysisClientExceptionEvent +extends java.util.EventObject +``` + +This class is an event for the PHXAnalysisClient class. The event is generated when an exception occurs on the read thread. + +**See Also:** +- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.client.PHXAnalysisClientExceptionEvent) + +## Field Summary + +### Fields inherited from class java.util.EventObject +`source` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.Exception` | `getException()`
retrieves the Exception object | + +### Methods inherited from class java.util.EventObject +`getSource, toString` + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +## Method Detail + +### getException +``` +public java.lang.Exception getException() +``` +retrieves the Exception object + +**Returns:** +- the Exception object. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXNoSuchResponseException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXNoSuchResponseException.md new file mode 100644 index 0000000000..a01fe6f434 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXNoSuchResponseException.md @@ -0,0 +1,51 @@ +# Class: PHXNoSuchResponseException + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.client.PHXNoSuchResponseException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +**Declaration** + +```java +public class PHXNoSuchResponseException +extends java.lang.Exception +``` + +An exception that is thrown when an invalid response is specified. + +**See Also:** +- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.client.PHXNoSuchResponseException) + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getInvalidID()`
retrieves the id that didn't have a response | + +### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +## Method Detail + +### getInvalidID +``` +public java.lang.String getInvalidID() +``` +retrieves the id that didn't have a response + +**Returns:** +- the invalid id \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXPropertyValue.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXPropertyValue.md new file mode 100644 index 0000000000..fcb4ad7fb4 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXPropertyValue.md @@ -0,0 +1,81 @@ +# Class: PHXPropertyValue + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.client.PHXPropertyValue +``` + +**Declaration** + +```java +public class PHXPropertyValue +extends java.lang.Object +``` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `PHXPropertyDescriptor` | `_prop` | +| `PHXPropertyValue[]` | `subProps` | + +### Fields inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXPropertyValue()` | +| `PHXPropertyValue(PHXPropertyDescriptor prop, java.lang.String val)` | +| `PHXPropertyValue(PHXPropertyValue val)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getValue()` | + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` + +## Field Detail + +### _prop +``` +public PHXPropertyDescriptor _prop +``` + +### subProps +``` +public PHXPropertyValue[] subProps +``` + +## Constructor Detail + +### PHXPropertyValue +``` +public PHXPropertyValue() +``` + +### PHXPropertyValue +``` +public PHXPropertyValue(PHXPropertyValue val) +``` + +### PHXPropertyValue +``` +public PHXPropertyValue(PHXPropertyDescriptor prop, + java.lang.String val) +``` + +## Method Detail + +### getValue +``` +public java.lang.String getValue() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md new file mode 100644 index 0000000000..4be462528c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md @@ -0,0 +1,52 @@ +# Class: PHXResponseTypeMismatchException + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ java.lang.RuntimeException + ↳ com.phoenix_int.aserver.client.PHXResponseTypeMismatchException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +**Declaration** + +```java +public class PHXResponseTypeMismatchException +extends java.lang.RuntimeException +``` + +An exception that is thrown when an invalid response is specified. + +**See Also:** +- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.client.PHXResponseTypeMismatchException) + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getInvalidID()`
retrieves the id that didn't have a response | + +### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +## Method Detail + +### getInvalidID +``` +public java.lang.String getInvalidID() +``` +retrieves the id that didn't have a response + +**Returns:** +- the invalid id \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXServerSideException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXServerSideException.md new file mode 100644 index 0000000000..018fe8a499 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXServerSideException.md @@ -0,0 +1,53 @@ +# Class: PHXServerSideException + +**Package:** `com.phoenix_int.aserver.client` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.client.PHXServerSideException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +**Declaration** + +```java +public class PHXServerSideException +extends java.lang.Exception +``` + +An exception that is thrown when an error is returned from the server. + +**See Also:** +- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.client.PHXServerSideException) + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXServerSideException(java.lang.String msg)` | + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +## Constructor Detail + +### PHXServerSideException +``` +public PHXServerSideException(java.lang.String msg) +``` +Constructor + +**Parameters:** +- `msg` - the error text from the server \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md new file mode 100644 index 0000000000..cd34835d85 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md @@ -0,0 +1,31 @@ +# Package com.phoenix_int.aserver.client +Provides a client package for programmatically invoking the Analysis Server +remotely from the Java language. +See:Description + +## Interface Summary +| Interface | Description | +| --- | --- | +| [IPHXAnalysisClientListener](../../../../com/phoenix_int/aserver/client/IPHXAnalysisClientListener.html) | This interface is used by the PHXAnalysisClient class. | + +## Class Summary +| Class | Description | +| --- | --- | +| [PHXAnalysisClient](../../../../com/phoenix_int/aserver/client/PHXAnalysisClient.html) | DeprecatedUse[AnalysisServerClient](../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html)instead. | +| [PHXAnalysisClientEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientEvent.html) | this class is an event for the PHXAnalysisClient class. | +| [PHXAnalysisClientExceptionEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.html) | this class is an event for the PHXAnalysisClient class. | +| [PHXPropertyValue](../../../../com/phoenix_int/aserver/client/PHXPropertyValue.html) | | + +## Exception Summary +| Exception | Description | +| --- | --- | +| [PHXNoSuchResponseException](../../../../com/phoenix_int/aserver/client/PHXNoSuchResponseException.html) | An exception that is thrown when an invalid response is specified. | +| [PHXResponseTypeMismatchException](../../../../com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.html) | An exception that is thrown when an invalid response is specified. | +| [PHXServerSideException](../../../../com/phoenix_int/aserver/client/PHXServerSideException.html) | An exception that is thrown when an error is returned from the server. | + +## Package com.phoenix_int.aserver.client Description +Provides a client package for programmatically invoking the Analysis Server +remotely from the Java language. Start with the PHXAnalysisClient class. + +**See Also:** +- [PHXAnalysisClient](../../../../com/phoenix_int/aserver/client/PHXAnalysisClient.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md new file mode 100644 index 0000000000..99952683d9 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md @@ -0,0 +1,24 @@ +# Hierarchy For Package com.phoenix_int.aserver.client + +**Package Hierarchies:** +- [All Packages](../../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - java.util.EventObject (implements java.io.Serializable) + - com.phoenix_int.aserver.client.[PHXAnalysisClientEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientEvent.html) + - com.phoenix_int.aserver.client.[PHXAnalysisClientExceptionEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.html) + - com.phoenix_int.aserver.client.[PHXAnalysisClient](../../../../com/phoenix_int/aserver/client/PHXAnalysisClient.html) + - com.phoenix_int.aserver.client.[PHXPropertyValue](../../../../com/phoenix_int/aserver/client/PHXPropertyValue.html) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - com.phoenix_int.aserver.client.[PHXNoSuchResponseException](../../../../com/phoenix_int/aserver/client/PHXNoSuchResponseException.html) + - com.phoenix_int.aserver.client.[PHXServerSideException](../../../../com/phoenix_int/aserver/client/PHXServerSideException.html) + - java.lang.RuntimeException + - com.phoenix_int.aserver.client.[PHXResponseTypeMismatchException](../../../../com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.html) + +## Interface Hierarchy + +- java.util.EventListener + - com.phoenix_int.aserver.client.[IPHXAnalysisClientListener](../../../../com/phoenix_int/aserver/client/IPHXAnalysisClientListener.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md new file mode 100644 index 0000000000..c2ec378874 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md @@ -0,0 +1,1792 @@ +# Class: AnalysisServerClient + +**Package:** `com.phoenix_int.aserver.client.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.client.v2.AnalysisServerClient +``` + +**Implemented Interfaces** + +- `java.lang.AutoCloseable` + +**Declaration** + +```java +public class AnalysisServerClient +extends java.lang.Object +implements java.lang.AutoCloseable +``` + +ModelCenter Remote Execution client object. + +## Constructor Summary + +| Constructor and Description | +|---| +| `AnalysisServerClient()` | + +## Method Summary + +| Modifier and Type | Method and Description | +|---|---| +| `void` | `addProxyClients(java.lang.Iterable clientHosts)` Add a list of allowed proxy client hosts. | +| `void` | `addProxyClientsAsync(java.lang.Iterable clientHosts, IAnalysisServerCallback callback)` Add a list of allowed proxy client hosts. | +| `void` | `close()` Close the connection to the server. | +| `void` | `connect(java.net.URI uri)` Connect to ModelCenter Remote Execution at a specified URI with no timeout. | +| `void` | `connect(java.net.URI uri, int timeout)` Connect to ModelCenter Remote Execution at a specified URI. | +| `void` | `connect(java.net.URI uri, java.lang.String username, java.lang.String password)` Connect to ModelCenter Remote Execution with optional authentication and no timeout. | +| `void` | `connect(java.net.URI uri, java.lang.String username, java.lang.String password, int timeout)` Connect to ModelCenter Remote Execution with optional authentication. | +| `void` | `connectEmbedded()` Connect to the in-process (embedded) ModelCenter Remote Execution instance. | +| `void` | `connectEmbedded(java.util.Map initialProperties)` Connect to the in-process (embedded) ModelCenter Remote Execution instance. | +| `void` | `connectEmbedded(java.util.Map initialProperties, java.lang.String username, java.lang.String password)` Connect to the in-process (embedded) ModelCenter Remote Execution instance. | +| `void` | `connectEmbedded(java.lang.String username, java.lang.String password)` Connect to the in-process (embedded) ModelCenter Remote Execution instance. | +| `void` | `connectSsh(java.lang.String host, java.io.InputStream inputStream, java.io.OutputStream outputStream, java.io.InputStream errorStream)` Connect to ModelCenter Remote Execution via arbitrary input and output streams. | +| `void` | `deleteRunShare(java.lang.String key)` Delete a run share. | +| `void` | `deleteRunShareAsync(java.lang.String key, IAnalysisServerCallback callback)` Delete a run share. | +| `PHXComponentDescription` | `describe(java.lang.String analysis)` Get the description of an analysis. | +| `void` | `describeAsync(java.lang.String analysis, IAnalysisServerCallback callback)` Get the description history of an analysis. | +| `void` | `end(java.lang.String instanceName)` End an analysis. | +| `void` | `endAsync(java.lang.String instanceName, IAnalysisServerCallback callback)` End an analysis. | +| `void` | `execute(java.lang.String instanceName, boolean background)` Execute an analysis. | +| `void` | `executeAsync(java.lang.String instanceName, boolean background, IAnalysisServerCallback callback)` Execute an analysis. | +| `protected void` | `finalize()` Clean up during finalization. | +| `java.lang.String` | `get(java.lang.String fullPropertyName)` Request the value of a property. | +| `void` | `getAsync(java.lang.String fullPropertyName, IAnalysisServerCallback callback)` Request the value of a property. | +| `void` | `getByUrl(java.io.File destFile, java.lang.String url, boolean isBinaryFile)` Convenience overload of getByUrl(File, String, String, boolean). | +| `void` | `getByUrl(java.io.File destFile, java.lang.String fullPropertyName, java.lang.String url, boolean isBinaryFile)` Get a file by URL. | +| `void` | `getByUrlAsync(java.io.File destFile, java.lang.String fullPropertyName, java.lang.String url, boolean isBinaryFile, IAnalysisServerCallback callback)` Fetch the contents of a file by URL. | +| `int[]` | `getDimensions(java.lang.String fullPropertyName)` Set the dimensions of an array. | +| `void` | `getDimensionsAsync(java.lang.String fullPropertyName, IAnalysisServerCallback callback)` Set the dimensions of an array. | +| `void` | `getFile(java.io.File destFile, java.lang.String fullPropertyName, boolean isBinaryFile)` Get a file by property name. | +| `void` | `getFileAsync(java.io.File destFile, java.lang.String fullPropertyName, boolean isBinaryFile, IAnalysisServerCallback callback)` Fetch the contents of a file by property name. | +| `java.util.Map` | `getHierarchy(java.lang.String instanceName, com.phoenix_int.aserver.client.PHXHierarchyFileMode fileMode)` Get the variable hierarchy of a running instance. | +| `void` | `getHierarchyAsync(java.lang.String instanceName, com.phoenix_int.aserver.client.PHXHierarchyFileMode fileMode, IAnalysisServerCallback callback)` Get the variable hierarchy of a running instance. | +| `java.lang.String` | `getHostname()` Returns the currently-connected host, or null if none. | +| `PHXIcon` | `getIcon(java.lang.String analysis)` Retrieve an icon. | +| `void` | `getIconAsync(java.lang.String analysis, IAnalysisServerCallback callback)` Retrieve an icon. | +| `java.lang.String` | `getScratchDirectory()` Request for the server's scratch directory. | +| `void` | `getScratchDirectoryAsync(IAnalysisServerCallback callback)` Request for the server's scratch directory. | +| `java.lang.String` | `getSystemProperty(java.lang.String key)` Request for the server's system property. | +| `void` | `getSystemPropertyAsync(java.lang.String key, IAnalysisServerCallback callback)` Request for the server's system property. | +| `java.net.URI` | `getUri()` Get the currently-connected URI, or null if none. | +| `AnalysisServerVersion` | `getVersion()` Get the MCRE version. | +| `PHXComponentBranch` | `getVersionHistory(java.lang.String analysis)` Get the version history of an analysis. | +| `void` | `getVersionHistoryAsync(java.lang.String analysis, IAnalysisServerCallback callback)` Get the version history of an analysis. | +| `java.lang.String` | `invoke(java.lang.String instanceName, java.lang.String methodName)` Invoke a method on a component instance. | +| `void` | `invokeAsync(java.lang.String instanceName, java.lang.String methodName, IAnalysisServerCallback callback)` Invoke a method on a component instance. | +| `boolean` | `isConnected()` Is the server connected? | +| `java.util.List` | `listAnalyses(java.lang.String folderPath)` List the analyses on the server. | +| `void` | `listAnalysesAsync(java.lang.String folderPath, IAnalysisServerCallback callback)` List the analyses on the server. | +| `java.util.List` | `listFolders(java.lang.String folderPath)` List the sub-folders of a folder on the server. | +| `void` | `listFoldersAsync(java.lang.String folderPath, IAnalysisServerCallback callback)` List the sub-folders of a folder on the server. | +| `java.util.List` | `listInstances()` List running instances on the server. | +| `void` | `listInstancesAsync(IAnalysisServerCallback callback)` List running instances on the server. | +| `java.util.List` | `listMethods(java.lang.String analysis)` List the methods of an analysis. | +| `void` | `listMethodsAsync(java.lang.String analysis, IAnalysisServerCallback callback)` List the methods of an analysis. | +| `java.util.List` | `listProperties(java.lang.String analysis)` List the properties of an analysis. | +| `void` | `listPropertiesAsync(java.lang.String analysis, IAnalysisServerCallback callback)` List the properties of an analysis. | +| `java.util.List` | `listValues(java.lang.String analysis)` List the values of an analysis. | +| `void` | `listValuesAsync(java.lang.String analysis, IAnalysisServerCallback callback)` List the values of an analysis. | +| `void` | `quit(boolean background)` Force quit current analysis, and shut down ModelCenter Remote Execution. | +| `void` | `set(java.lang.String fullPropertyName, java.io.File contents)` Set a file variable on the server. | +| `void` | `set(java.lang.String fullPropertyName, java.io.File contents, java.lang.String encoding)` Set a file variable on the server. | +| `void` | `set(java.lang.String fullPropertyName, java.lang.Object value)` Set the value of a property. | +| `void` | `setAsync(java.lang.String fullPropertyName, java.io.File contents, IAnalysisServerCallback callback)` Set a file variable on the server. | +| `void` | `setAsync(java.lang.String fullPropertyName, java.io.File contents, java.lang.String encoding, IAnalysisServerCallback callback)` Set a file variable on the server. | +| `void` | `setAsync(java.lang.String fullPropertyName, java.lang.Object value, IAnalysisServerCallback callback)` Set the value of a property. | +| `void` | `setByUrl(java.lang.String fullPropertyName, java.lang.String url)` Set the URL of a file property. | +| `void` | `setByUrlAsync(java.lang.String fullPropertyName, java.lang.String url, IAnalysisServerCallback callback)` Set the URL associated with a property | +| `void` | `setDictionary(java.lang.String xml)` Set dictionary on Server. | +| `void` | `setDictionaryAsync(java.lang.String xml, IAnalysisServerCallback callback)` Set dictionary on Server. | +| `void` | `setDimensions(java.lang.String fullPropertyName, int[] dimensions)` Set the dimensions of an array. | +| `void` | `setDimensionsAsync(java.lang.String fullPropertyName, int[] dimensions, IAnalysisServerCallback callback)` Set the dimensions of an array. | +| `void` | `setHierarchy(java.lang.String instanceName, java.io.File xmlData, java.lang.String xmlEncoding, boolean gzipped)` Set the variable hierarchy of a running instance. | +| `void` | `setHierarchy(java.lang.String instanceName, java.lang.Iterable variables)` Set the variable hierarchy of a running instance. | +| `void` | `setHierarchyAsync(java.lang.String instanceName, java.io.File xmlData, java.lang.String xmlEncoding, boolean gzipped, IAnalysisServerCallback callback)` Set the variable hierarchy of a running instance. | +| `void` | `setHierarchyAsync(java.lang.String instanceName, java.lang.Iterable variables, IAnalysisServerCallback callback)` Set the variable hierarchy of a running instance. | +| `void` | `setServerProperties(java.util.Map propertyMap)` Set server properties. | +| `void` | `setServerPropertiesAsync(java.util.Map propertyMap, IAnalysisServerCallback callback)` Set server properties. | +| `void` | `start(java.lang.String analysis, java.lang.String instanceName)` Start an analysis. | +| `void` | `startAsync(java.lang.String analysis, java.lang.String instanceName, IAnalysisServerCallback callback)` Start an analysis. | +| `boolean` | `supportsBinaryTransfer()` Does this server support binary transfer? | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### AnalysisServerClient + +```java +public AnalysisServerClient() +``` +## Method Detail + +### isConnected + +```java +public boolean isConnected() +``` +Is the server connected? + +### getUri + +```java +public java.net.URI getUri() +``` +Get the currently-connected URI, or null if none. + +### getHostname + +```java +public java.lang.String getHostname() +``` +Returns the currently-connected host, or null if none. + +### supportsBinaryTransfer + +```java +public boolean supportsBinaryTransfer() + throws java.lang.IllegalStateException +``` +Does this server support binary transfer? + +**Throws:** +- `java.lang.IllegalStateException` – if the client is not connected + +### connect + +```java +public void connect(java.net.URI uri) + throws javax.security.auth.login.FailedLoginException, + java.io.IOException, + java.lang.NullPointerException +``` +Connect to ModelCenter Remote Execution at a specified URI with no timeout. The server must not require authentication. + +**Parameters:** +- `uri` – the URI + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the server requires credentials +- `java.io.IOException` – if the server cannot be connected +- `java.lang.NullPointerException` – if uri is null + +### connect + +```java +public void connect(java.net.URI uri, + int timeout) + throws javax.security.auth.login.FailedLoginException, + java.io.IOException, java.lang.NullPointerException +``` +Connect to ModelCenter Remote Execution at a specified URI. The server must not require authentication. + +**Parameters:** +- `uri` – the URI +- `timeout` – the timeout to use, or 0 for none + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the server requires credentials +- `java.io.IOException` – if the server cannot be connected +- `java.lang.NullPointerException` – if uri is null + +### connect + +```java +public void connect(java.net.URI uri, + java.lang.String username, + java.lang.String password) + throws javax.security.auth.login.FailedLoginException, + java.io.IOException, + java.lang.NullPointerException +``` +Connect to ModelCenter Remote Execution with optional authentication and no timeout. + +**Parameters:** +- `uri` – the URI to connect to +- `username` – the username to use (null for none) +- `password` – the password to use (null for none) + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the credentials are invalid +- `java.io.IOException` – if the server cannot be connected +- `java.lang.NullPointerException` – if uri is null + +### connect + +```java +public void connect(java.net.URI uri, + java.lang.String username, + java.lang.String password, + int timeout) + throws javax.security.auth.login.FailedLoginException, + java.io.IOException, + java.lang.UnsupportedOperationException, + java.lang.NullPointerException +``` +Connect to ModelCenter Remote Execution with optional authentication. + +**Parameters:** +- `uri` – the URI to connect to +- `username` – the username to use (null for none) +- `password` – the password to use (null for none) +- `timeout` – the timeout, or 0 for none + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the credentials are invalid +- `java.io.IOException` – if the server cannot be connected +- `java.lang.UnsupportedOperationException` – if the URI is not a recognized type +- `java.lang.NullPointerException` – if uri is null + +### connectEmbedded + +```java +public void connectEmbedded() + throws javax.security.auth.login.FailedLoginException, + java.io.IOException +``` +Connect to the in-process (embedded) ModelCenter Remote Execution instance. + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the server requires authentication +- `java.io.IOException` – on connection error + +### connectEmbedded + +```java +public void connectEmbedded(java.lang.String username, + java.lang.String password) + throws javax.security.auth.login.FailedLoginException, + java.io.IOException +``` +Connect to the in-process (embedded) ModelCenter Remote Execution instance. + +**Parameters:** +- `username` – the username to use (null for none) +- `password` – the password to use (null for none) + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the credentials are invalid +- `java.io.IOException` – on connection error + +### connectEmbedded + +```java +public void connectEmbedded(java.util.Map initialProperties) + throws javax.security.auth.login.FailedLoginException, java.io.IOException +``` +Connect to the in-process (embedded) ModelCenter Remote Execution instance. + +**Parameters:** +- `initialProperties` – the initial properties to set (may be null) + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the server requires authentication +- `java.io.IOException` – on connection error + +### connectEmbedded + +```java +public void connectEmbedded(java.util.Map initialProperties, + java.lang.String username, + java.lang.String password) + throws javax.security.auth.login.FailedLoginException, + java.io.IOException +``` +Connect to the in-process (embedded) ModelCenter Remote Execution instance. + +**Parameters:** +- `initialProperties` – the initial properties to set (may be null) +- `username` – the username to use (null for none) +- `password` – the password to use (null for none) + +**Throws:** +- `javax.security.auth.login.FailedLoginException` – if the credentials are invalid +- `java.io.IOException` – on connection error + +### connectSsh + +```java +public void connectSsh(java.lang.String host, + java.io.InputStream inputStream, + java.io.OutputStream outputStream, + java.io.InputStream errorStream) + throws javax.security.auth.login.FailedLoginException, + java.io.IOException, + java.net.URISyntaxException +``` +Connect to ModelCenter Remote Execution via arbitrary input and output streams. This function is misnamed because it doesn't really care if the streams come from ssh or not, only that the other end of the streams are hooked up to ModelCenter Remote Execution. + +**Parameters:** +- `host` – the machine at which the streams are connected +- `inputStream` – the stream where the SSH server writes its output +- `outputStream` – the stream where the SSH server reads further input +- `errorStream` – The stream where the SSH server writes its error output, which may be null; this is used to include additional information if a connection error occurs + +**Throws:** +- `javax.security.auth.login.FailedLoginException` +- `java.io.IOException` +- `java.net.URISyntaxException` + +### close + +```java +public void close() +``` +Close the connection to the server. + +**Specified by:** +- `close` in interface `java.lang.AutoCloseable` + +### quit + +```java +public void quit(boolean background) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Force quit current analysis, and shut down ModelCenter Remote Execution. + +**Parameters:** +- `background` – whether to background execution + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### finalize + +```java +protected void finalize() + throws java.lang.Throwable +``` +Clean up during finalization. + +**Overrides:** +- `finalize` in class `java.lang.Object` + +**Throws:** +- `java.lang.Throwable` + +### getVersion + +```java +public AnalysisServerVersion getVersion() + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Get the MCRE version. + +**Returns:** +- the version + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### startAsync + +```java +public void startAsync(java.lang.String analysis, + java.lang.String instanceName, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Start an analysis. + +**Parameters:** +- `analysis` – the analysis +- `instanceName` – the name for this instance +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### start + +```java +public void start(java.lang.String analysis, + java.lang.String instanceName) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Start an analysis. + +**Parameters:** +- `analysis` – the analysis +- `instanceName` – the name for this instance + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### endAsync + +```java +public void endAsync(java.lang.String instanceName, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +End an analysis. + +**Parameters:** +- `instanceName` – the name of the instance +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### end + +```java +public void end(java.lang.String instanceName) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +End an analysis. + +**Parameters:** +- `instanceName` – the name of the instance + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### listAnalysesAsync + +```java +public void listAnalysesAsync(java.lang.String folderPath, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +List the analyses on the server. + +**Parameters:** +- `folderPath` – the path to the folder (may be null) +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### listAnalyses + +```java +public java.util.List listAnalyses(java.lang.String folderPath) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +List the analyses on the server. + +**Parameters:** +- `folderPath` – the path to the folder (may be null) + +**Returns:** +- the list of classes + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### executeAsync + +```java +public void executeAsync(java.lang.String instanceName, + boolean background, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Execute an analysis. + +**Parameters:** +- `instanceName` – the name of the instance +- `background` – whether to background execution +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### execute + +```java +public void execute(java.lang.String instanceName, + boolean background) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Execute an analysis. + +**Parameters:** +- `instanceName` – the name of the instance +- `background` – whether to background execution + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### addProxyClientsAsync + +```java +public void addProxyClientsAsync(java.lang.Iterable clientHosts, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Add a list of allowed proxy client hosts. + +**Parameters:** +- `clientHosts` – the collection of hosts +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### addProxyClients + +```java +public void addProxyClients(java.lang.Iterable clientHosts) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Add a list of allowed proxy client hosts. + +**Parameters:** +- `clientHosts` – the collection of hosts + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### getAsync + +```java +public void getAsync(java.lang.String fullPropertyName, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Request the value of a property. + +**Parameters:** +- `fullPropertyName` – the full property name +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### get + +```java +public java.lang.String get(java.lang.String fullPropertyName) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Request the value of a property. + +**Parameters:** +- `fullPropertyName` – the full property name + +**Returns:** +- the property value + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### getFileAsync + +```java +public void getFileAsync(java.io.File destFile, + java.lang.String fullPropertyName, + boolean isBinaryFile, + IAnalysisServerCallback callback) + throws java.io.IOException, java.lang.IllegalStateException +``` +Fetch the contents of a file by property name. + +**Parameters:** +- `destFile` – the file to write to +- `fullPropertyName` – the full property name +- `isBinaryFile` – whether or not this is a binary file (will only be used if the server must transfer the file as text, so we know how to decode it!) +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### getFile + +```java +public void getFile(java.io.File destFile, + java.lang.String fullPropertyName, + boolean isBinaryFile) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Get a file by property name. + +**Parameters:** +- `fullPropertyName` – the full property name +- `destFile` – the file to write with the results +- `isBinaryFile` – whether or not this is a binary file (will only be used if the server must transfer the file as text, so we know how to decode it!) + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### getByUrlAsync + +```java +public void getByUrlAsync(java.io.File destFile, + java.lang.String fullPropertyName, + java.lang.String url, + boolean isBinaryFile, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Fetch the contents of a file by URL. + +**Parameters:** +- `destFile` – the file to write to +- `fullPropertyName` – the full property name +- `url` – the URL to retrieve +- `isBinaryFile` – whether or not this is a binary file (will only be used if the server must transfer the file as text, so we know how to decode it!) +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### getByUrl + +```java +public void getByUrl(java.io.File destFile, + java.lang.String fullPropertyName, + java.lang.String url, + boolean isBinaryFile) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Get a file by URL. + +**Parameters:** +- `fullPropertyName` – the full property name +- `destFile` – the file to write with the results +- `url` – the URL to retrieve +- `isBinaryFile` – whether or not this is a binary file (will only be used if the server must transfer the file as text, so we know how to decode it!) + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### getByUrl + +```java +public void getByUrl(java.io.File destFile, + java.lang.String url, + boolean isBinaryFile) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Convenience overload of `getByUrl(File, String, String, boolean)`. Calls that getByUrl with a blank fullPropertyName parameter. Get a file by URL. + +**Parameters:** +- `destFile` – the file to write with the results +- `url` – the URL to retrieve +- `isBinaryFile` – whether or not this is a binary file (will only be used if the server must transfer the file as text, so we know how to decode it!) + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### getDimensionsAsync + +```java +public void getDimensionsAsync(java.lang.String fullPropertyName, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Set the dimensions of an array. + +**Parameters:** +- `fullPropertyName` – the full property name +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### getDimensions + +```java +public int[] getDimensions(java.lang.String fullPropertyName) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Set the dimensions of an array. + +**Parameters:** +- `fullPropertyName` – the full property name + +**Returns:** +- the dimensions + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### setDimensionsAsync + +```java +public void setDimensionsAsync(java.lang.String fullPropertyName, + int[] dimensions, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException, + java.lang.NullPointerException, + java.lang.IllegalArgumentException +``` +Set the dimensions of an array. + +**Parameters:** +- `fullPropertyName` – the full property name +- `dimensions` – the dimensions +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error +- `java.lang.NullPointerException` – if dimensions is null +- `java.lang.IllegalArgumentException` – if any of the dimensions are invalid + +### setDimensions + +```java +public void setDimensions(java.lang.String fullPropertyName, + int[] dimensions) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException, + java.lang.NullPointerException, + java.lang.IllegalArgumentException +``` +Set the dimensions of an array. + +**Parameters:** +- `fullPropertyName` – the full property name +- `dimensions` – the dimensions + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response +- `java.lang.NullPointerException` – if dimensions is null +- `java.lang.IllegalArgumentException` – if any of the dimensions are invalid + +### setByUrlAsync + +```java +public void setByUrlAsync(java.lang.String fullPropertyName, + java.lang.String url, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Set the URL associated with a property + +**Parameters:** +- `fullPropertyName` – the full property name +- `url` – the URL to set +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### setByUrl + +```java +public void setByUrl(java.lang.String fullPropertyName, + java.lang.String url) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Set the URL of a file property. + +**Parameters:** +- `fullPropertyName` – the full property name +- `url` – the URL to set + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### setDictionary + +```java +public void setDictionary(java.lang.String xml) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Set dictionary on Server. + +**Parameters:** +- `xml` – context information in form of a xml string + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### setDictionaryAsync + +```java +public void setDictionaryAsync(java.lang.String xml, + IAnalysisServerCallback callback) + throws java.lang.IllegalStateException, + java.io.IOException +``` +Set dictionary on Server. + +**Parameters:** +- `xml` – context information in form of a xml string +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error +- `java.lang.NullPointerException` – if xml is null + +### setAsync + +```java +public void setAsync(java.lang.String fullPropertyName, + java.lang.Object value, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Set the value of a property. + +**Parameters:** +- `fullPropertyName` – the full property name +- `value` – the value to set +- `callback` – the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – on communications error + +### set + +```java +public void set(java.lang.String fullPropertyName, + java.lang.Object value) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Set the value of a property. + +**Parameters:** +- `fullPropertyName` – the full property name +- `value` – the value to set (if this is a`File`or (`@link PHXTempFile`), [set(java.lang.String, java.io.File)](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html#set-java.lang.String-java.io.File-) will be called automatically + +**Throws:** +- `java.lang.IllegalStateException` – if the server is not connected +- `java.io.IOException` – if there is an error talking to the server +- `AnalysisServerException` – if the request fails +- `java.lang.InterruptedException` – if the current thread is interrupted waiting for the response + +### setAsync + +```java +public void setAsync(java.lang.String fullPropertyName, + java.io.File contents, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException, + java.lang.UnsupportedOperationException +``` +Set a file variable on the server. + +**Parameters:** +- `fullPropertyName` - the full property name to set +- `contents` - the contents to set +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server or reading from the file +- `java.lang.UnsupportedOperationException` - if the server does not support file transfer + + + +### setAsync + +```java +public void setAsync(java.lang.String fullPropertyName, + java.io.File contents, + java.lang.String encoding, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException, + java.lang.UnsupportedOperationException +``` +Set a file variable on the server. + +**Parameters:** +- `fullPropertyName` - the full property name to set +- `contents` - the contents to set +- `encoding` - the text encoding to use for non-file variables, null for file variables +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server or reading from the file +- `java.lang.UnsupportedOperationException` - if the server does not support file transfer + + + +### set + +```java +public void set(java.lang.String fullPropertyName, + java.io.File contents) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException, + java.lang.UnsupportedOperationException +``` +Set a file variable on the server. + +**Parameters:** +- `fullPropertyName` - the full property name to set +- `contents` - the contents to set + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server or reading from the file +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response +- `java.lang.UnsupportedOperationException` - if the server does not support binary transfer + + + +### set + +```java +public void set(java.lang.String fullPropertyName, + java.io.File contents, + java.lang.String encoding) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException, + java.lang.UnsupportedOperationException +``` +Set a file variable on the server. + +**Parameters:** +- `fullPropertyName` - the full property name to set +- `contents` - the contents to set +- `encoding` - the text encoding to use for non-file variables, null for file variables + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server or reading from the file +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response +- `java.lang.UnsupportedOperationException` - if the server does not support binary transfer + + + +### getVersionHistoryAsync + +```java +public void getVersionHistoryAsync(java.lang.String analysis, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Get the version history of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### getVersionHistory + +```java +public PHXComponentBranch getVersionHistory(java.lang.String analysis) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Get the version history of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for + +**Returns:** +- the version history information + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### describeAsync + +```java +public void describeAsync(java.lang.String analysis, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Get the description history of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### describe + +```java +public PHXComponentDescription describe(java.lang.String analysis) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Get the description of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for + +**Returns:** +- the version history information + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### listPropertiesAsync + +```java +public void listPropertiesAsync(java.lang.String analysis, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +List the properties of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### listProperties + +```java +public java.util.List listProperties(java.lang.String analysis) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +List the properties of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for + +**Returns:** +- the property list + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### listMethodsAsync + +```java +public void listMethodsAsync(java.lang.String analysis, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +List the methods of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### listMethods + +```java +public java.util.List listMethods(java.lang.String analysis) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +List the methods of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for + +**Returns:** +- the method list + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### invokeAsync + +```java +public void invokeAsync(java.lang.String instanceName, + java.lang.String methodName, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Invoke a method on a component instance. + +**Parameters:** +- `instanceName` - the name of the instance to invoke the method for +- `methodName` - the method name to invoke +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### invoke + +```java +public java.lang.String invoke(java.lang.String instanceName, + java.lang.String methodName) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Invoke a method on a component instance. + +**Parameters:** +- `instanceName` - the name of the instance to invoke the method for +- `methodName` - the method name to invoke + +**Returns:** +- whatever the method returned + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### listValuesAsync + +```java +public void listValuesAsync(java.lang.String analysis, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +List the values of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### listValues + +```java +public java.util.List listValues(java.lang.String analysis) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +List the values of an analysis. + +**Parameters:** +- `analysis` - the analysis to retrieve info for + +**Returns:** +- the value list + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### listFoldersAsync + +```java +public void listFoldersAsync(java.lang.String folderPath, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +List the sub-folders of a folder on the server. + +**Parameters:** +- `folderPath` - the folder path; may be null +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### listFolders + +```java +public java.util.List listFolders(java.lang.String folderPath) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +List the sub-folders of a folder on the server. + +**Parameters:** +- `folderPath` - the folder path; may be null + +**Returns:** +- the list of folders + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### listInstancesAsync + +```java +public void listInstancesAsync(IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +List running instances on the server. + +**Parameters:** +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### listInstances + +```java +public java.util.List listInstances() + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +List running instances on the server. + +**Returns:** +- the list of folders + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### getHierarchyAsync + +```java +public void getHierarchyAsync(java.lang.String instanceName, + com.phoenix_int.aserver.client.PHXHierarchyFileMode fileMode, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Get the variable hierarchy of a running instance. + +**Parameters:** +- `instanceName` - the name of the instance to retrieve variables for +- `fileMode` - the way to return files +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### getHierarchy + +```java +public java.util.Map getHierarchy(java.lang.String instanceName, + com.phoenix_int.aserver.client.PHXHierarchyFileMode fileMode) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Get the variable hierarchy of a running instance. + +**Parameters:** +- `instanceName` - the name of the instance to retrieve variables for +- `fileMode` - the way to return files + +**Returns:** +- the hierarchy (a map from variable paths to values) + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### setHierarchyAsync + +```java +public void setHierarchyAsync(java.lang.String instanceName, + java.lang.Iterable variables, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Set the variable hierarchy of a running instance. + +**Parameters:** +- `instanceName` - the name of the instance to retrieve variables for +- `variables` - the variables and values to set + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### setHierarchy + +```java +public void setHierarchy(java.lang.String instanceName, + java.lang.Iterable variables) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Set the variable hierarchy of a running instance. + +**Parameters:** +- `instanceName` - the name of the instance to retrieve variables for +- `variables` - the variables and values to set + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### setHierarchyAsync + +```java +public void setHierarchyAsync(java.lang.String instanceName, + java.io.File xmlData, + java.lang.String xmlEncoding, + boolean gzipped, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Set the variable hierarchy of a running instance. + +**Parameters:** +- `instanceName` - the name of the instance to retrieve variables for +- `xmlData` - the file containing XML data to set +- `xmlEncoding` - the encoding of the data; null or empty for default (UTF-8) +- `gzipped` - whether the file on disk has been gzipped + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### setHierarchy + +```java +public void setHierarchy(java.lang.String instanceName, + java.io.File xmlData, + java.lang.String xmlEncoding, + boolean gzipped) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Set the variable hierarchy of a running instance. + +**Parameters:** +- `instanceName` - the name of the instance to retrieve variables for +- `xmlData` - the file containing XML data to set +- `xmlEncoding` - the encoding of the data; null or empty for default (UTF-8) +- `gzipped` - whether the file on disk has been gzipped + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### deleteRunShareAsync + +```java +public void deleteRunShareAsync(java.lang.String key, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Delete a run share. + +**Parameters:** +- `key` - the unique key for the share + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### deleteRunShare + +```java +public void deleteRunShare(java.lang.String key) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Delete a run share. + +**Parameters:** +- `key` - the unique key for the share + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### getIconAsync + +```java +public void getIconAsync(java.lang.String analysis, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Retrieve an icon. + +**Parameters:** +- `analysis` - the analysis to get the icon for + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### getIcon + +```java +public PHXIcon getIcon(java.lang.String analysis) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Retrieve an icon. + +**Parameters:** +- `analysis` - the analysis to get the icon for + +**Returns:** +- the icon + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### setServerPropertiesAsync + +```java +public void setServerPropertiesAsync(java.util.Map propertyMap, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Set server properties. + +**Parameters:** +- `propertyMap` - a map of keys to values + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### setServerProperties + +```java +public void setServerProperties(java.util.Map propertyMap) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Set server properties. + +**Parameters:** +- `propertyMap` - a map of keys to values + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### getSystemPropertyAsync + +```java +public void getSystemPropertyAsync(java.lang.String key, + IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Request for the server's system property. + +**Parameters:** +- `key` - the name of the system property +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + + + +### getSystemProperty + +```java +public java.lang.String getSystemProperty(java.lang.String key) + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Request for the server's system property. + +**Parameters:** +- `key` - the name of the system property + +**Returns:** +- the property value + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + + + +### getScratchDirectoryAsync + +```java +public void getScratchDirectoryAsync(IAnalysisServerCallback callback) + throws java.io.IOException, + java.lang.IllegalStateException +``` +Request for the server's scratch directory. + +**Parameters:** +- `callback` - the callback for when the response is received + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - on communications error + +### getScratchDirectory + +```java +public java.lang.String getScratchDirectory() + throws java.lang.IllegalStateException, + java.io.IOException, + AnalysisServerException, + java.lang.InterruptedException +``` +Request for the server's scratch directory. + +**Returns:** +- the scratch directory of the connected MCRE + +**Throws:** +- `java.lang.IllegalStateException` - if the server is not connected +- `java.io.IOException` - if there is an error talking to the server +- `AnalysisServerException` - if the request fails +- `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerException.md new file mode 100644 index 0000000000..7deb162609 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerException.md @@ -0,0 +1,75 @@ +# Class: AnalysisServerException + +**Package:** `com.phoenix_int.aserver.client.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.client.v2.AnalysisServerException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +**Declaration** + +```java +public class AnalysisServerException +extends java.lang.Exception +``` + +Exception thrown when a request fails on the server. + +--- + +## Constructor Summary + +| Constructor and Description | +| --- | +| `AnalysisServerException(java.lang.String message)`
Constructor. | +| `AnalysisServerException(java.lang.String message, java.lang.Throwable cause)`
Constructor. | + + + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + + + +## Constructor Detail + + + +**Constructor:** AnalysisServerException + +```java +public AnalysisServerException(java.lang.String message) +``` +Constructor. + +**Parameters:** +- `message` - the error message + + + +**Constructor:** AnalysisServerException + +```java +public AnalysisServerException(java.lang.String message, + java.lang.Throwable cause) +``` +Constructor. + +**Parameters:** +- `message` - the error message +- `cause` - the triggering exception + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md new file mode 100644 index 0000000000..d158287157 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md @@ -0,0 +1,329 @@ +# Class: AnalysisServerResponse + +**Package:** `com.phoenix_int.aserver.client.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.client.v2.AnalysisServerResponse +``` +------ + +**Declaration** + +```java +public class AnalysisServerResponse +extends java.lang.Object +``` + +Implementation of `PHXResponse` along lines of `PHXResponse` in C++ code. + + +## Constructor Summary + +| Constructor and Description | +| ------------ | +| `AnalysisServerResponse()` | + + +## Method Summary + +| Modifier and Type | Method and Description | +| --------------- | --------------- | +| `com.phoenix_int.aserver.client.v2.ChunkDescriptor` | `asChunkDescriptor()`
Parse the response as a chunk descriptor. | +| `PHXComponentDescription` | `asComponentDescription(boolean asXml)`
Parse a component description. | +| `java.util.Map` | `asHierarchy()`
Parse the response as a variable hierarchy. | +| `java.util.List` | `asList()`
Convert the string data to a list of properties. | +| `java.util.List` | `asMethodDescriptors()`
Convert the string data to a list of method descriptors. | +| `java.util.List` | `asPropertyDescriptors()`
Parse this response as a sequence of property descriptors. | +| `java.util.List` | `asPropertyDescriptors(java.lang.String baseObjectName)`
Parse this response as a sequence of property descriptors. | +| `java.util.List` | `asValueDescriptors()`
Parse the response as a list of value descriptors. | +| `AnalysisServerVersion` | `asVersion()`
Get the response as a server version. | +| `PHXComponentBranch` | `asVersionHistory()`
Parse the response as a version history. | +| `byte[]` | `getBinaryData()`
Get the binary data; only valid if format is Extended or Icon. | +| `java.lang.String` | `getErrorMessage()`
Get the server error; only valid if response type is ServerError or ConnectionError. | +| `java.lang.String` | `getHost()`
Get the host which sent the message. | +| `java.lang.String` | `getID()`
Get the unique identifier of the message. | +| `AnalysisServerResponseType` | `getResponseType()`
Get the type of response. | +| `java.lang.String` | `getStringData()`
Get the string data; only valid if format is Normal or Extended. | +| `boolean` | `hasText()`
Does this response have actual string data (i.e. string data is not empty)? | +| `boolean` | `isBinary()`
Is this a response with binary data? | +| `boolean` | `isError()`
Does the response represent an error? | +| `boolean` | `isSuccess()`
Is the response a successful response? | +| `boolean` | `isText()`
Does the response have text content? | + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` + + +## Constructor Detail + + +**Constructor:** AnalysisServerResponse + +```java +public AnalysisServerResponse() +``` + + +## Method Detail + + +### getID + +```java +public java.lang.String getID() +``` +Get the unique identifier of the message. + + +### getHost + +```java +public java.lang.String getHost() +``` +Get the host which sent the message. + + +### getResponseType + +```java +public AnalysisServerResponseType getResponseType() +``` +Get the type of response. + + +### getStringData + +```java +public java.lang.String getStringData() +``` +Get the string data; only valid if format is Normal or Extended. + + +### getErrorMessage + +```java +public java.lang.String getErrorMessage() +``` +Get the server error; only valid if response type is ServerError or ConnectionError. + + +### getBinaryData + +```java +public byte[] getBinaryData() +``` +Get the binary data; only valid if format is Extended or Icon. + + +### isText + +```java +public boolean isText() +``` +Does the response have text content? + + +### hasText + +```java +public boolean hasText() +``` +Does this response have actual string data (i.e. string data is not empty)? + + +### isBinary + +```java +public boolean isBinary() +``` +Is this a response with binary data? + + +### isSuccess + +```java +public boolean isSuccess() +``` +Is the response a successful response? + + +### isError + +```java +public boolean isError() +``` +Does the response represent an error? + + +### asVersion + +```java +public AnalysisServerVersion asVersion() + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Get the response as a server version. + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + + +### asComponentDescription + +```java +public PHXComponentDescription asComponentDescription(boolean asXml) + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Parse a component description. + +**Parameters:** +- `asXml` - whether to interpret the result as XML + +**Returns:** +- the description + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + + +### asList + +```java +public java.util.List asList() + throws java.lang.IllegalStateException +``` +Convert the string data to a list of properties. + +**Returns:** +- the list of items + +**Throws:** +- `java.lang.IllegalStateException` - if the data is not text + + +### asMethodDescriptors + +```java +public java.util.List asMethodDescriptors() + throws java.lang.IllegalStateException +``` +Convert the string data to a list of method descriptors. + +**Returns:** +- the list + +**Throws:** +- `java.lang.IllegalStateException` - if the data is not text + + +### asPropertyDescriptors + +```java +public java.util.List asPropertyDescriptors() + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Parse this response as a sequence of property descriptors. + +**Returns:** +- a set of property descriptors, which may be empty + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + + +### asPropertyDescriptors + +```java +public java.util.List asPropertyDescriptors(java.lang.String baseObjectName) + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Parse this response as a sequence of property descriptors. + +**Parameters:** +- `baseObjectName` - the object to retrieve information for; null for none + +**Returns:** +- a set of property descriptors, which may be empty + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + + +### asChunkDescriptor + +```java +public com.phoenix_int.aserver.client.v2.ChunkDescriptor asChunkDescriptor() + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Parse the response as a chunk descriptor. + +**Returns:** +- the chunk descriptor + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + + +### asValueDescriptors + +```java +public java.util.List asValueDescriptors() + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Parse the response as a list of value descriptors. + +**Returns:** +- the list, which may be empty + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + + +### asVersionHistory + +```java +public PHXComponentBranch asVersionHistory() + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Parse the response as a version history. + +**Returns:** +- the version history + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + + +### asHierarchy + +```java +public java.util.Map asHierarchy() + throws java.lang.IllegalStateException, + AnalysisServerException +``` +Parse the response as a variable hierarchy. + +**Returns:** +- the map from variable paths to values + +**Throws:** +- `java.lang.IllegalStateException` - if this is not a text response +- `AnalysisServerException` - if the data is not valid + +--- \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md new file mode 100644 index 0000000000..5498328045 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md @@ -0,0 +1,127 @@ +# Enum: AnalysisServerResponseType + +**Package:** `com.phoenix_int.aserver.client.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Enum + ↳ com.phoenix_int.aserver.client.v2.AnalysisServerResponseType +``` + +**Implemented Interfaces** + +- `java.io.Serializable`, `java.lang.Comparable` + +--- + +**Declaration** + +```java +public enum AnalysisServerResponseType +extends java.lang.Enum +``` +Enumeration representing response type. + +## Enum Constant Summary + +| Enum Constant and Description | +| --- | +| `ConnectionError`
A connection error. | +| `Extended`
An extended, hybrid string+binary response. | +| `Icon`
An icon. | +| `Normal`
A normal, string-based response. | +| `ServerError`
A server error. | +| `Unknown`
An unknown response type (default for new response objects). | + +## Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| `static AnalysisServerResponseType` | `valueOf(java.lang.String name)`
Returns the enum constant of this type with the specified name. | +| `static AnalysisServerResponseType[]` | `values()`
Returns an array containing the constants of this enum type, in the order they are declared. | + +### Methods inherited from class java.lang.Enum +`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf` + +### Methods inherited from class java.lang.Object +`getClass, notify, notifyAll, wait, wait, wait` + +## Enum Constant Detail + +### Normal + +```java +public static final AnalysisServerResponseType Normal +``` +A normal, string-based response. + +### Extended + +```java +public static final AnalysisServerResponseType Extended +``` +An extended, hybrid string+binary response. + +### ServerError + +```java +public static final AnalysisServerResponseType ServerError +``` +A server error. + +### Icon + +```java +public static final AnalysisServerResponseType Icon +``` +An icon. + +### ConnectionError + +```java +public static final AnalysisServerResponseType ConnectionError +``` +A connection error. + +### Unknown + +```java +public static final AnalysisServerResponseType Unknown +``` +An unknown response type (default for new response objects). + +## Method Detail + +### values + +```java +public static AnalysisServerResponseType[] values() +``` +Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: + +```java +for (AnalysisServerResponseType c : AnalysisServerResponseType.values()) + System.out.println(c); +``` + +**Returns:** +- an array containing the constants of this enum type, in the order they are declared + +### valueOf + +```java +public static AnalysisServerResponseType valueOf(java.lang.String name) +``` +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.) + +**Parameters:** +- `name` - the name of the enum constant to be returned. + +**Returns:** +- the enum constant with the specified name + +**Throws:** +- `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name +- `java.lang.NullPointerException` - if the argument is null \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md new file mode 100644 index 0000000000..b9afc2e129 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md @@ -0,0 +1,116 @@ +# Class: AnalysisServerVersion + +**Package:** `com.phoenix_int.aserver.client.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.client.v2.AnalysisServerVersion +``` + +**Implemented Interfaces** + +- `java.lang.Comparable` + +--- +**Declaration** + +```java +public class AnalysisServerVersion +extends java.lang.Object +implements java.lang.Comparable +``` +Server protocol version. Useful for determining if a server supports specific features. + +## Constructor Summary + +| Constructor and Description | +| --- | +| `AnalysisServerVersion(int major, int minor, int build)`
Constructor. | + +## Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| `int` | `compareTo(AnalysisServerVersion o)` | +| `boolean` | `equals(java.lang.Object obj)` | +| `int` | `getBuild()`
Get the build. | +| `int` | `getMajor()`
Get the major version. | +| `int` | `getMinor()`
Get the minor version. | +| `int` | `hashCode()` | +| `java.lang.String` | `toString()` | + +### Methods inherited from class java.lang.Object +`clone, finalize, getClass, notify, notifyAll, wait, wait, wait` + +## Constructor Detail + +### AnalysisServerVersion + +```java +public AnalysisServerVersion(int major, + int minor, + int build) +``` +Constructor. + +**Parameters:** +- `major` - the major version +- `minor` - the minor version +- `build` - the build number + +## Method Detail + +### getMajor + +```java +public int getMajor() +``` +Get the major version. + +### getMinor + +```java +public int getMinor() +``` +Get the minor version. + +### getBuild + +```java +public int getBuild() +``` +Get the build. + +### hashCode + +```java +public int hashCode() +``` +**Overrides:** +- `hashCode` in class `java.lang.Object` + +### equals + +```java +public boolean equals(java.lang.Object obj) +``` +**Overrides:** +- `equals` in class `java.lang.Object` + +### compareTo + +```java +public int compareTo(AnalysisServerVersion o) +``` +**Specified by:** +- `compareTo` in interface `java.lang.Comparable` + +### toString + +```java +public java.lang.String toString() +``` +**Overrides:** +- `toString` in class `java.lang.Object` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md new file mode 100644 index 0000000000..f37f490e5f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md @@ -0,0 +1,107 @@ +# Class: AnalysisServerWaitCallback + +**Package:** `com.phoenix_int.aserver.client.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.client.v2.AnalysisServerWaitCallback +``` + +**Implemented Interfaces** + +- `IAnalysisServerCallback` + +--- + +**Declaration** + +```java +public class AnalysisServerWaitCallback +extends java.lang.Object +implements IAnalysisServerCallback +``` +Callback object which uses a monitor to allow the caller to block until a response is received. + +## Constructor Summary + +| Constructor and Description | +| --- | +| `AnalysisServerWaitCallback()` | + +## Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| `AnalysisServerResponse` | `getResponse()`
Get the response, or null if it has not been received. | +| `boolean` | `responseReceived(AnalysisServerResponse response)`
Callback when a response is received. | +| `AnalysisServerResponse` | `waitForResponse()`
Wait until the response has been received, if it has not already. | +| `AnalysisServerResponse` | `waitForResponse(int timeout)`
Wait until the response has been received, if it has not already. | + +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` + +## Constructor Detail + +### AnalysisServerWaitCallback + +```java +public AnalysisServerWaitCallback() +``` + +## Method Detail + +### getResponse + +```java +public AnalysisServerResponse getResponse() +``` +Get the response, or null if it has not been received. + +### waitForResponse + +```java +public AnalysisServerResponse waitForResponse() + throws java.lang.InterruptedException +``` +Wait until the response has been received, if it has not already. + +**Returns:** +- the response + +**Throws:** +- `java.lang.InterruptedException` - if the current thread is interrupted during the wait + +### waitForResponse + +```java +public AnalysisServerResponse waitForResponse(int timeout) + throws java.lang.InterruptedException +``` +Wait until the response has been received, if it has not already. + +**Parameters:** +- `timeout` - the amount of time in ms to wait; 0 for infinite + +**Returns:** +- the response, or null if it has not yet been received + +**Throws:** +- `java.lang.InterruptedException` - if the current thread is interrupted during the wait + +### responseReceived + +```java +public boolean responseReceived(AnalysisServerResponse response) +``` +Callback when a response is received. + +**Parameters:** +- `response` - the response + +**Returns:** +- true if this callback should be removed + +**Specified by:** +- `responseReceived` in interface `IAnalysisServerCallback` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md new file mode 100644 index 0000000000..09edcee04a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md @@ -0,0 +1,111 @@ +## Class: AnalysisVariableValue + +**Package:** `com.phoenix_int.aserver.client.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.client.v2.AnalysisVariableValue +``` + +--- + +**Declaration** + +```java +public class AnalysisVariableValue +extends java.lang.Object +``` + +Class representing a variable value. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `AnalysisVariableValue(java.lang.String name, boolean isInput, java.lang.String type, java.lang.Object value, boolean isUrl)`
Constructor. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getName()`
Get the variable name. | +| `java.lang.String` | `getType()`
Get the type of the variable. | +| `java.lang.String` | `getUrl()`
Get the URL of the variable, or null if none. | +| `java.lang.Object` | `getValue()`
Get the value of the variable (null if URL). | +| `boolean` | `isBinary()`
Get whether this is binary data. | +| `boolean` | `isInput()`
Get whether this is an input. | + +### Methods inherited from class java.lang.Object + +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` + +## Constructor Detail + +### AnalysisVariableValue + +```java +public AnalysisVariableValue(java.lang.String name, + boolean isInput, + java.lang.String type, + java.lang.Object value, + boolean isUrl) + throws java.lang.NullPointerException +``` +Constructor. + +**Parameters:** +- `name` - the variable name +- `isInput` - whether this variable is an input +- `type` - the type of the variable, if specified +- `value` - the value of the variable (or the URL); use byte[] for binary data +- `isUrl` - whether this is a URL + +**Throws:** +- `java.lang.NullPointerException` - if name or value is null +- `java.lang.IllegalArgumentException` - if isBinary and isUrl are both true + +## Method Detail + +### getName + +```java +public java.lang.String getName() +``` +Get the variable name. + +### isInput + +```java +public boolean isInput() +``` +Get whether this is an input. + +### isBinary + +```java +public boolean isBinary() +``` +Get whether this is binary data. + +### getUrl + +```java +public java.lang.String getUrl() +``` +Get the URL of the variable, or null if none. + +### getType + +```java +public java.lang.String getType() +``` +Get the type of the variable. + +### getValue + +```java +public java.lang.Object getValue() +``` +Get the value of the variable (null if URL). Typically a `String` for text values or a `byte[]` for binary. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md new file mode 100644 index 0000000000..54ee13f35c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md @@ -0,0 +1,37 @@ +## Interface: IAnalysisServerCallback + +**Package:** `com.phoenix_int.aserver.client.v2` + +**All Known Implementing Classes:** +- [AnalysisServerWaitCallback](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.html) + +--- + +**Declaration** + +```java +public interface IAnalysisServerCallback +``` + +Callback for ModelCenter Remote Execution events. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `boolean` | `responseReceived(AnalysisServerResponse response)`
Callback when a response is received. | + +## Method Detail + +### responseReceived + +```java +boolean responseReceived(AnalysisServerResponse response) +``` +Callback when a response is received. + +**Parameters:** +- `response` - the response + +**Returns:** +- true if this callback should be removed \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md new file mode 100644 index 0000000000..ba5d057b88 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md @@ -0,0 +1,28 @@ +# Package com.phoenix_int.aserver.client.v2 + +## Interface Summary + +| Interface | Description | +| --- | --- | +| [IAnalysisServerCallback](../../../../../com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html) | Callback for ModelCenter Remote Execution events. | + +## Class Summary +| Class | Description | +| --- | --- | +| [AnalysisServerClient](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html) | ModelCenter Remote Execution client object. | +| [AnalysisServerResponse](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponse.html) | Implementation of PHXResponse along lines of PHXResponse in C++ code. | +| [AnalysisServerVersion](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerVersion.html) | Server protocol version. | +| [AnalysisServerWaitCallback](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.html) | Callback object which uses a monitor to allow the caller to block until a response is received. | +| [AnalysisVariableValue](../../../../../com/phoenix_int/aserver/client/v2/AnalysisVariableValue.html) | Class representing a variable value. | + +## Enum Summary + +| Enum | Description | +| --- | --- | +| [AnalysisServerResponseType](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.html) | Enumeration representing response type. | + +## Exception Summary + +| Exception | Description | +| --- | --- | +| [AnalysisServerException](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerException.html) | Exception thrown when a request fails on the server. | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md new file mode 100644 index 0000000000..1b7c703b38 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md @@ -0,0 +1,26 @@ +# Hierarchy For Package com.phoenix_int.aserver.client.v2 + +**Package Hierarchies:** +- [All Packages](../../../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - com.phoenix_int.aserver.client.v2.[AnalysisServerClient](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html)(implements java.lang.AutoCloseable) + - com.phoenix_int.aserver.client.v2.[AnalysisServerResponse](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponse.html) + - com.phoenix_int.aserver.client.v2.[AnalysisServerVersion](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerVersion.html)(implements java.lang.Comparable) + - com.phoenix_int.aserver.client.v2.[AnalysisServerWaitCallback](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.html)(implements com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](../../../../../com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html)) + - com.phoenix_int.aserver.client.v2.[AnalysisVariableValue](../../../../../com/phoenix_int/aserver/client/v2/AnalysisVariableValue.html) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - com.phoenix_int.aserver.client.v2.[AnalysisServerException](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerException.html) + +## Interface Hierarchy + +- com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](../../../../../com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html) + +## Enum Hierarchy + +- java.lang.Object + - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) + - com.phoenix_int.aserver.client.v2.[AnalysisServerResponseType](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md new file mode 100644 index 0000000000..e49358d80a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md @@ -0,0 +1,124 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Interface IPHXFactory +- --- +Deprecated.It is preferred to use`IPHXFactory2`, as this class has methods that can leak resources + +```java +public interface IPHXFactory +``` +A factory is a class that has the logic for turning a file on disk into a real component instance and for retrieving + component meta data.- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `PHXComponentDescription` | `describe(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir)`Deprecated.Describes the specified component. | +| `java.io.File` | `getFileFor(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir)`Deprecated.Returns a File object which points to the file on disk which contains the implementation of this component | +| `IPHXComponent` | `instantiate(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir)`Deprecated.It is preferred to use`IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)`as this method can lead + to resource leaks. | +| `java.util.Collection` | `listComponents(java.io.File dir, + java.lang.String virtualDir)`Deprecated.List out all of the identifiers (historically "class" names) for a given directory as a collection of strings. |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### listComponents + +```java +java.util.Collection listComponents(java.io.File dir, + java.lang.String virtualDir) +``` +Deprecated.List out all of the identifiers (historically "class" names) for a given directory as a collection of strings. + + Much of the documentation was added to this class retroactively and may be make assumptions or have other unknown + limitations. +**Parameters:** +: `dir`- a directory to search for components +**Returns:** +: an array of "class" names. For non-jar factories, this just means any sub-file identifier. Because a file + can have multiple components (at least jars can) this text it used to identify them. This text is later feed back + to this API via the other three methods in this interface. So really it just was a list of text that identify + sub-components inside a single file. Even though this is generic and not enforced by the compiler only lists of + strings should be used. + +- #### instantiate + +```java +@Deprecated +IPHXComponent instantiate(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + PHXServerSideException, + java.net.MalformedURLException, + java.io.IOException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException +``` +Deprecated.It is preferred to use`IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)`as this method can lead + to resource leaks.creates an instance of the specified component. +**Returns:** +: an instance of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the specified class does not exist +: `java.lang.IllegalAccessException`- the class can't be instantiated +: `java.lang.InstantiationException`- the class can't be instantiated +: `java.lang.reflect.InvocationTargetException`- if an exception occurs while intantiating the specified + class. +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `java.io.IOException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +- #### describe + +```java +PHXComponentDescription describe(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException +``` +Deprecated.Describes the specified component. Should throw ClassNotFoundException if unable to handle/parse the given file. + + Much of the documentation was added to this class retroactively and may be make assumptions or have other unknown + limitations. +**Parameters:** +: `dir`- the path on disk to the file to be described +: `compClass`- This is the same "class" string that was returned by the`listComponents`method. This + usually is not a class name, but it was originally but expanded beyond that -- it seems now just to be the + identifier that exceeds the file name (like a file that implements multiple components). +**Returns:** +: an instance of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- thrown if the class is not found, or the given factory is not able to + handle this file. Callers of this method often expect this exception if the factory cannot handle the given + file/compClass(id). +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` + +- #### getFileFor + +```java +java.io.File getFileFor(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.io.IOException +``` +Deprecated.Returns a File object which points to the file on disk which contains the implementation of this component +**Throws:** +: `java.lang.ClassNotFoundException` +: `java.io.IOException` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md new file mode 100644 index 0000000000..c45efc1050 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md @@ -0,0 +1,174 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Interface IPHXLibrarian +- **All Known Subinterfaces:** +: [IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) + +**All Known Implementing Classes:** +: [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html),[PHXDirectoryLibrarian](../../../../com/phoenix_int/aserver/library/PHXDirectoryLibrarian.html),[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html),[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html),[PHXUserDirLibrarian](../../../../com/phoenix_int/aserver/library/PHXUserDirLibrarian.html) + +--- +Deprecated.It is preferred to use`IPHXLibrarian2`as this class uses methods that can leak resources. + +```java +@Deprecated +public interface IPHXLibrarian +``` +This is an interface for classes that manage a directory heirarchy of available components. An instance of this class + is generated for each incoming connection. +**Version:** +: Dec 2001 +**Author:** +: Nathan P Sharp- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `cleanUp()`Deprecated.Tells this librarian to clean up any resources used. | +| `PHXComponentDescription` | `describe(java.lang.String compClass, + java.lang.String virtualDirName)`Deprecated.describes the specified component | +| `java.lang.String` | `getQueues(java.lang.String compClass, + java.lang.String virtualDirName)`Deprecated.gets the available run queues | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions)`Deprecated.Tells this librarian to configure itself based on the XML node passed in. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDirName)`Deprecated. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDirName, + java.lang.String connector, + java.lang.String queue)`Deprecated. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDirName)`Deprecated.lists components within a specified directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Deprecated.lists any available sub-directories from a particular directory |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### initialize + +```java +void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) + throws java.lang.Exception +``` +Deprecated.Tells this librarian to configure itself based on the XML node passed in. The XML node should be a + node whose format is specific to the particular type of librarian +**Throws:** +: `java.lang.Exception` + +- #### cleanUp + +```java +void cleanUp() +``` +Deprecated.Tells this librarian to clean up any resources used. + +- #### listComponents + +```java +java.util.Collection listComponents(java.lang.String virtualDirName) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +Deprecated.lists components within a specified directory +**Parameters:** +: `virtualDirName`- The directory the client asked for +**Returns:** +: a Collection of Strings +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### listDirectories + +```java +java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +Deprecated.lists any available sub-directories from a particular directory +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: a Collection of Strings +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### instantiate + +```java +@Deprecated +IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDirName) + throws java.lang.Exception +``` +Deprecated.creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the + request off to the IPHXFactory. +It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate + cases as they are handled in special ways by the librarian mounter and librarian combiner. +**Parameters:** +: `compClass`- the class name for the component +: `virtualDirName`- The directory the client asked for +**Returns:** +: an instance of the specified component class +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### instantiate + +```java +@Deprecated +IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDirName, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception +``` +Deprecated. +**Throws:** +: `java.lang.Exception` + +- #### describe + +```java +PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDirName) + throws java.lang.Exception +``` +Deprecated.describes the specified component +It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate + cases as they are handled in special ways by the librarian mounter and librarian combiner. +**Parameters:** +: `compClass`- the class name for the component +: `virtualDirName`- The directory the client asked for +**Returns:** +: a description of the specified component class +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong + +- #### getQueues + +```java +java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDirName) + throws java.lang.Exception +``` +Deprecated.gets the available run queues +It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate + cases as they are handled in special ways by the librarian mounter and librarian combiner. +**Parameters:** +: `compClass`- the class name for the component +: `virtualDirName`- The directory the client asked for +**Returns:** +: a list of queues for the specified component class +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md new file mode 100644 index 0000000000..0c05754ce0 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md @@ -0,0 +1,65 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Interface IPHXVersionedLibrarian +- **All Superinterfaces:** +: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html) + +**All Known Subinterfaces:** +: [IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) + +**All Known Implementing Classes:** +: [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html),[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html),[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html) + +--- +Deprecated.It is preferred to use`IPHXVersionedLibrarian3`as this class has methods that + can leak resources + +```java +@Deprecated +public interface IPHXVersionedLibrarian +extends IPHXLibrarian +``` +This extends the IPHXLibrarian interface to include version information + about components. +**Version:** +: Jan 2002 +**Author:** +: Nathan P Sharp- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir)`Deprecated.Gets all version information about a particular component | + +- ### Methods inherited from interface com.phoenix_int.aserver.library.IPHXLibrarian +`cleanUp,describe,getQueues,initialize,instantiate,instantiate,listComponents,listDirectories`- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### getComponentHistory + +```java +PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +Deprecated.Gets all version information about a particular component +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: An instance of PHXComponentBranch which contains + all the versions and sub-branches available +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md new file mode 100644 index 0000000000..7768bcdec1 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md @@ -0,0 +1,48 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Interface IPHXVersionedLibrarian2 +- **All Superinterfaces:** +: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html),[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html) + +**All Known Implementing Classes:** +: [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html),[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html),[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html) + +--- +Deprecated.It is preferred to use`IPHXVersionedLibrarian3`as this class supports + methods that can cause file leaks. + +```java +@Deprecated +public interface IPHXVersionedLibrarian2 +extends IPHXVersionedLibrarian +``` +This extends the IPHXLibrarian interface to include version information + about components. +**Version:** +: Feb 2006 +**Author:** +: Carlton Fraley- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getBranchesAndTags()`Deprecated.Fetches a list of all branches and tags | + +- ### Methods inherited from interface com.phoenix_int.aserver.library.IPHXVersionedLibrarian +`getComponentHistory` + +- ### Methods inherited from interface com.phoenix_int.aserver.library.IPHXLibrarian +`cleanUp,describe,getQueues,initialize,instantiate,instantiate,listComponents,listDirectories`- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### getBranchesAndTags + +```java +java.lang.String getBranchesAndTags() + throws java.lang.Exception +``` +Deprecated.Fetches a list of all branches and tags +**Throws:** +: `java.lang.Exception`- If anything goes wrong +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md new file mode 100644 index 0000000000..d588e77d6b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md @@ -0,0 +1,414 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXCVSLibrarian +- java.lang.Object +- - com.phoenix_int.aserver.library.PHXCVSLibrarian +- **All Implemented Interfaces:** +: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2,[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html), com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 + +--- + +```java +public class PHXCVSLibrarian +extends java.lang.Object +implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 +``` +Implementation of IPHXLibrarian which loads files out of CVS. + This class generates a directory in the scratch directory called + "CVSLIB" which contains its cache data. A single copy of the + latest version out of cvs is kept there for component browsing. + When a component is requested with "instantiate", it generates + a temp directory in CVSLIB and checks out the entire directory + that contains that component into the temp dir. The temp dir + gets deleted when the connection is dropped. In order to have + consistent files, it figures out the commit time for the + component requested, and then checks out all the files in the + directory from that same date. +The required configuration parameters are defined on the + initialize() method. + +This class requires passwordless access to cvs and does not + currently provide any access control functions (.mcre files + do not work). +**Version:** +: Jan 2002 +**Author:** +: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXCVSLibrarian()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `cleanUp()`Delete all the temp directories | +| `PHXComponentDescription` | `describe(java.lang.String compClass, + java.lang.String virtualDir)`describes the specified component. | +| `java.lang.String` | `getBranchesAndTags()`Does not support branching and tagging | +| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir)`Gets all version information about a particular component | +| `java.lang.String` | `getQueues(java.lang.String compClass, + java.lang.String virtualDir)`method for getting Queues from CenterLink, MCRE just returns blank string | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions)`There are 2 options for this class. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir)`creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir)`Creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Lists available sub-directories for the specified path | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXCVSLibrarian + +```java +public PHXCVSLibrarian() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### initialize + +```java +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) + throws java.lang.Exception +``` +There are 2 options for this class. The CVSROOT which should + be set as if you were using the command line tools and the module + in CVS which is the base for all the published components. The + startModule cannot be blank. + The XML format is: +```java + + + pathfinder:/shared/cvs + analyses + + +``` +**Specified by:** +: `initialize`in interface`IPHXLibrarian` +**Throws:** +: `java.lang.Exception` + +- #### cleanUp + +```java +public void cleanUp() +``` +Delete all the temp directories +**Specified by:** +: `cleanUp`in interface`IPHXLibrarian` + +- #### listComponents + +```java +public java.util.Collection listComponents(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +returns the components in a specific directory +**Specified by:** +: `listComponents`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: an array of class names +**Throws:** +: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned +: `PHXNoSuchCategoryException` + +- #### listDirectories + +```java +public java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +Lists available sub-directories for the specified path +**Specified by:** +: `listDirectories`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: a Collection of Strings +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +creates an instance of the specified component. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: an instance of the associated component class with the file + loaded +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `java.lang.IllegalAccessException`- cannot call constructor +: `java.lang.InstantiationException`- cannot call constructor +: `java.lang.reflect.InvocationTargetException`- if an exception + if the specified component exists, but is not of the right type, + or if an exception occurs while creating the class or loading + the setup file +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` +: `PHXNoSuchCategoryException` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the + request off to the IPHXFactory. +It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate + cases as they are handled in special ways by the librarian mounter and librarian combiner. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` +: `java.lang.reflect.InvocationTargetException` +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +: `connector`- name of the connector object to use +: `queue`- name of the queue object to use +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` +: `java.lang.reflect.InvocationTargetException` +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` +: `java.lang.reflect.InvocationTargetException` +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +- #### getComponentHistory + +```java +public PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + PHXNoSuchCategoryException, + java.io.IOException +``` +Description copied from interface:`IPHXVersionedLibrarian`Gets all version information about a particular component +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `getComponentHistory`in interface`IPHXVersionedLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: An instance of PHXComponentBranch which contains + all the versions and sub-branches available +**Throws:** +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.io.IOException` + +- #### describe + +```java +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + PHXNoSuchCategoryException +``` +describes the specified component. +TODO: + Currently all descriptions come from the head. +**Specified by:** +: `describe`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: a description of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` + +- #### getQueues + +```java +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +method for getting Queues from CenterLink, MCRE just returns blank string +**Specified by:** +: `getQueues`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: a list of queues for the specified component class +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong + +- #### getBranchesAndTags + +```java +public java.lang.String getBranchesAndTags() +``` +Does not support branching and tagging +**Specified by:** +: `getBranchesAndTags`in interface`IPHXVersionedLibrarian2` +**Returns:** +: always returns empty string +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md new file mode 100644 index 0000000000..0c9ed8cef8 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md @@ -0,0 +1,348 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXDirectoryLibrarian +- java.lang.Object +- - com.phoenix_int.aserver.library.PHXDirectoryLibrarian +- **All Implemented Interfaces:** +: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2 + +--- + +```java +public class PHXDirectoryLibrarian +extends java.lang.Object +implements com.phoenix_int.aserver.library.IPHXLibrarian2 +``` +This librarian provides a window into a directory on disk that contains wrapper and component files. +**Version:** +: Dec 2001 +**Author:** +: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXDirectoryLibrarian()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `cleanUp()`This class has no cleaning up to do | +| `PHXComponentDescription` | `describe(java.lang.String compClass, + java.lang.String virtualDir)`describes the specified component. | +| `java.lang.String` | `getQueues(java.lang.String compClass, + java.lang.String virtualDir)`method for getting Queues from CenterLink, MCRE just returns blank string | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions)`There is only 1 option for this class, "analysesPath" which must be a single directory that exists on the local + system. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir)`creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir)`Creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Lists available sub-directories for the specified path | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXDirectoryLibrarian + +```java +public PHXDirectoryLibrarian() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### initialize + +```java +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) + throws java.lang.Exception +``` +There is only 1 option for this class, "analysesPath" which must be a single directory that exists on the local + system. +The XML format is: + +```java + + + path1/here + + +``` +**Specified by:** +: `initialize`in interface`IPHXLibrarian` +**Throws:** +: `java.lang.Exception` + +- #### cleanUp + +```java +public void cleanUp() +``` +This class has no cleaning up to do +**Specified by:** +: `cleanUp`in interface`IPHXLibrarian` + +- #### listComponents + +```java +public java.util.Collection listComponents(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +returns the components in a specific directory +**Specified by:** +: `listComponents`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: an array of class names +**Throws:** +: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned +: `PHXNoSuchCategoryException` + +- #### listDirectories + +```java +public java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +Lists available sub-directories for the specified path +**Specified by:** +: `listDirectories`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: a Collection of Strings +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +creates an instance of the specified component. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: an instance of the associated component class with the file loaded +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `java.lang.IllegalAccessException`- cannot call constructor +: `java.lang.InstantiationException`- cannot call constructor +: `java.lang.reflect.InvocationTargetException`- if an exception if the specified component exists, but is + not of the right type, or if an exception occurs while creating the class or loading the setup file +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` +: `PHXNoSuchCategoryException` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the + request off to the IPHXFactory. +It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate + cases as they are handled in special ways by the librarian mounter and librarian combiner. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` +: `java.lang.reflect.InvocationTargetException` +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +: `connector`- name of the connector object to use +: `queue`- name of the queue object to use +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` +: `java.lang.reflect.InvocationTargetException` +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` +: `java.lang.reflect.InvocationTargetException` +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` +: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +- #### describe + +```java +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + PHXNoSuchCategoryException +``` +describes the specified component. +**Specified by:** +: `describe`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: a description of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.io.IOException` +: `PHXServerSideException` +: `java.net.MalformedURLException` + +- #### getQueues + +```java +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +method for getting Queues from CenterLink, MCRE just returns blank string +**Specified by:** +: `getQueues`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: a list of queues for the specified component class +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md new file mode 100644 index 0000000000..3e77ad1ff6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md @@ -0,0 +1,337 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXLibrarianCombiner +- java.lang.Object +- - com.phoenix_int.aserver.library.PHXLibrarianCombiner +- **All Implemented Interfaces:** +: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2,[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html), com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 + +--- + +```java +public class PHXLibrarianCombiner +extends java.lang.Object +implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 +``` +This class combines several sub-librarians, adding dir lists and component lists together. If there is a conflict in + component or directory name, the first librarian wins out, and no error is given. +**Version:** +: Dec 2001 +**Author:** +: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXLibrarianCombiner()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `addLibrarian(IPHXLibrarianl)`Adds a librarian to our list | +| `void` | `cleanUp()`Recursively tells kids to clean themselves up | +| `PHXComponentDescription` | `describe(java.lang.String compClass, + java.lang.String virtualDir)`describes the specified component. | +| `java.lang.String` | `getBranchesAndTags()`Fetches a list of all branches and tags | +| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir)`Gets all version information about a particular component | +| `java.lang.String` | `getQueues(java.lang.String compClass, + java.lang.String virtualDir)`get the queues for the specified component. | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions)`The XML initialization information for this class is simply a list of tags which contain + and tags inside. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir)`creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)` | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir)`Creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Returns sub-directories from a specified directory | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXLibrarianCombiner + +```java +public PHXLibrarianCombiner() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### addLibrarian + +```java +public void addLibrarian(IPHXLibrarian l) +``` +Adds a librarian to our list + +- #### initialize + +```java +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) + throws java.lang.Exception +``` +The XML initialization information for this class is simply a list of tags which contain + and tags inside. +Example: + +```java + + + + com.phoenix_int.aserver.library.PHXDirectoryLibrarian + ... + + + .... + + + +``` +**Specified by:** +: `initialize`in interface`IPHXLibrarian` +**Throws:** +: `java.lang.Exception` + +- #### cleanUp + +```java +public void cleanUp() +``` +Recursively tells kids to clean themselves up +**Specified by:** +: `cleanUp`in interface`IPHXLibrarian` + +- #### listComponents + +```java +public java.util.Collection listComponents(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +returns the components in a specific directory +**Specified by:** +: `listComponents`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: an array of class names +**Throws:** +: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned +: `PHXNoSuchCategoryException` + +- #### listDirectories + +```java +public java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +Returns sub-directories from a specified directory +**Specified by:** +: `listDirectories`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: a Collection of Strings +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +creates an instance of the specified component. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: an instance of the associated component class with the file loaded +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `java.lang.IllegalAccessException`- cannot call constructor +: `java.lang.InstantiationException`- cannot call constructor +: `java.lang.reflect.InvocationTargetException`- if an exception if the specified component exists, but is + not of the right type, or if an exception occurs while creating the class or loading the setup file +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.Exception`- If anything serious goes wrong + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception +``` + +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Throws:** +: `java.lang.Exception` + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +: `connector`- name of the connector object to use +: `queue`- name of the queue object to use +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### describe + +```java +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +describes the specified component. +**Specified by:** +: `describe`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: a description of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.Exception`- If anything goes wrong + +- #### getQueues + +```java +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +get the queues for the specified component. +**Specified by:** +: `getQueues`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: a list of queues of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.Exception`- If anything goes wrong + +- #### getComponentHistory + +```java +public PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +Description copied from interface:`IPHXVersionedLibrarian`Gets all version information about a particular component +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `getComponentHistory`in interface`IPHXVersionedLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: An instance of PHXComponentBranch which contains + all the versions and sub-branches available +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong + +- #### getBranchesAndTags + +```java +public java.lang.String getBranchesAndTags() + throws java.lang.Exception +``` +Description copied from interface:`IPHXVersionedLibrarian2`Fetches a list of all branches and tags +**Specified by:** +: `getBranchesAndTags`in interface`IPHXVersionedLibrarian2` +**Throws:** +: `java.lang.Exception`- If anything goes wrong +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md new file mode 100644 index 0000000000..13b6c1d297 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md @@ -0,0 +1,345 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXLibrarianMounter +- java.lang.Object +- - com.phoenix_int.aserver.library.PHXLibrarianMounter +- **All Implemented Interfaces:** +: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2,[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html), com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 + +--- + +```java +public class PHXLibrarianMounter +extends java.lang.Object +implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 +``` +This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be + "mounted" very similarly to the UNIX concept of mounting filesystems. +When a librarian is mounted to a particular location, any components and directories that are available via a + librarian mounted higher up in the directory tree are hidden. + +This class will automatically add empty directories as necessary to ensure that you can "browse" to a mount point. + For example, if you have not mounted anything to the root ("" or "/"), you can still mount to a subdirectory like + "mount/here" and this class will create the empty directory "mount". + +Only one librarian can be mounted in a given location. Use a PHXLibrarianCombiner to put multiple librarians in the + same place. +**Version:** +: Dec 2001 +**Author:** +: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXLibrarianMounter()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `addLibrarian(java.lang.String mountPoint,IPHXLibrarianl)`Creates a librarian mount. | +| `void` | `cleanUp()`Recursively calls cleanUp on all our mount points | +| `PHXComponentDescription` | `describe(java.lang.String compClass, + java.lang.String virtualDir)`describes the specified component. | +| `java.lang.String` | `getBranchesAndTags()`Fetches a list of all branches and tags | +| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir)`Gets all version information about a particular component | +| `java.lang.String` | `getQueues(java.lang.String compClass, + java.lang.String virtualDir)`gets queues for the specified component. | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions)`The XML initialization information for this class is simply a list of tags which contain + , , and tags inside. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir)`creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)` | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir)`Creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`lists any available sub-directories from a particular directory | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXLibrarianMounter + +```java +public PHXLibrarianMounter() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### addLibrarian + +```java +public void addLibrarian(java.lang.String mountPoint, + IPHXLibrarian l) +``` +Creates a librarian mount. + +- #### initialize + +```java +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) +``` +The XML initialization information for this class is simply a list of tags which contain + , , and tags inside. +Example: + +```java + + + + /mounthere + com.phoenix_int.aserver.library.PHXDirectoryLibrarian + ... + + + .... + + + +``` +**Specified by:** +: `initialize`in interface`IPHXLibrarian` + +- #### cleanUp + +```java +public void cleanUp() +``` +Recursively calls cleanUp on all our mount points +**Specified by:** +: `cleanUp`in interface`IPHXLibrarian` + +- #### listComponents + +```java +public java.util.Collection listComponents(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +returns the components in a specific directory +**Specified by:** +: `listComponents`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: an array of class names +**Throws:** +: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned +: `PHXNoSuchCategoryException` + +- #### listDirectories + +```java +public java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +Description copied from interface:`IPHXLibrarian`lists any available sub-directories from a particular directory +**Specified by:** +: `listDirectories`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: a Collection of Strings +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +creates an instance of the specified component. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: an instance of the associated component class with the file loaded +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `java.lang.IllegalAccessException`- cannot call constructor +: `java.lang.InstantiationException`- cannot call constructor +: `java.lang.reflect.InvocationTargetException`- if an exception if the specified component exists, but is + not of the right type, or if an exception occurs while creating the class or loading the setup file +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.Exception`- If anything serious goes wrong + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception +``` + +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Throws:** +: `java.lang.Exception` + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +: `connector`- name of the connector object to use +: `queue`- name of the queue object to use +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### describe + +```java +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +describes the specified component. +**Specified by:** +: `describe`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: a description of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.Exception`- If anything goes wrong + +- #### getQueues + +```java +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +gets queues for the specified component. +**Specified by:** +: `getQueues`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: a list of queues for the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.Exception`- If anything goes wrong + +- #### getComponentHistory + +```java +public PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +Description copied from interface:`IPHXVersionedLibrarian`Gets all version information about a particular component +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `getComponentHistory`in interface`IPHXVersionedLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: An instance of PHXComponentBranch which contains + all the versions and sub-branches available +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong + +- #### getBranchesAndTags + +```java +public java.lang.String getBranchesAndTags() + throws java.lang.Exception +``` +Description copied from interface:`IPHXVersionedLibrarian2`Fetches a list of all branches and tags +**Specified by:** +: `getBranchesAndTags`in interface`IPHXVersionedLibrarian2` +**Throws:** +: `java.lang.Exception`- If anything goes wrong +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md new file mode 100644 index 0000000000..279d55f965 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md @@ -0,0 +1,61 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXNoSuchAssociationException +- java.lang.Object +- - java.lang.Throwable +- - java.lang.Exception +- - com.phoenix_int.aserver.library.PHXNoSuchAssociationException +- **All Implemented Interfaces:** +: java.io.Serializable + +--- + +```java +public class PHXNoSuchAssociationException +extends java.lang.Exception +``` +An exception that is thrown when an invalid association + is specified. +**See Also:** +: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.library.PHXNoSuchAssociationException)- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXNoSuchAssociationException(java.lang.String name)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getInvalidAssociation()`retrieves the name that was invalid | + +- ### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXNoSuchAssociationException + +```java +public PHXNoSuchAssociationException(java.lang.String name) +``` + +**Parameters:** +: `name`- the name that had no association +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getInvalidAssociation + +```java +public java.lang.String getInvalidAssociation() +``` +retrieves the name that was invalid +**Returns:** +: the invalid name +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md new file mode 100644 index 0000000000..3af922fe8c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md @@ -0,0 +1,92 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXNoSuchCategoryException +- java.lang.Object +- - java.lang.Throwable +- - java.lang.Exception +- - com.phoenix_int.aserver.library.PHXNoSuchCategoryException +- **All Implemented Interfaces:** +: java.io.Serializable + +--- + +```java +public class PHXNoSuchCategoryException +extends java.lang.Exception +``` +An exception that is thrown when an invalid class category + is specified. +**See Also:** +: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.library.PHXNoSuchCategoryException)- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXNoSuchCategoryException(java.lang.String category)` | +| `PHXNoSuchCategoryException(java.lang.String msg, + java.lang.String category)`Constructor for this exception containing both a specific message and the category + which could not be found. | +| `PHXNoSuchCategoryException(java.lang.String msg, + java.lang.String category, + java.lang.Exception ex)`Constructor which takes a message, a category, and an inner exception. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getInvalidCategory()`retrieves the category name that was invalid | + +- ### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXNoSuchCategoryException + +```java +public PHXNoSuchCategoryException(java.lang.String category) +``` + +**Parameters:** +: `category`- the category name that was invalid + +- #### PHXNoSuchCategoryException + +```java +public PHXNoSuchCategoryException(java.lang.String msg, + java.lang.String category) +``` +Constructor for this exception containing both a specific message and the category + which could not be found. +**Parameters:** +: `msg`- - The message associated with this exception. +: `category`- - The category which couldn't be found. + +- #### PHXNoSuchCategoryException + +```java +public PHXNoSuchCategoryException(java.lang.String msg, + java.lang.String category, + java.lang.Exception ex) +``` +Constructor which takes a message, a category, and an inner exception. +**Parameters:** +: `msg`- - The message associated with this specific exception. +: `category`- - The category which could not be found. +: `ex`- - The inner exception. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getInvalidCategory + +```java +public java.lang.String getInvalidCategory() +``` +retrieves the category name that was invalid +**Returns:** +: the invalid category name +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md new file mode 100644 index 0000000000..0118b38926 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md @@ -0,0 +1,61 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXNoSuchIconException +- java.lang.Object +- - java.lang.Throwable +- - java.lang.Exception +- - com.phoenix_int.aserver.library.PHXNoSuchIconException +- **All Implemented Interfaces:** +: java.io.Serializable + +--- + +```java +public class PHXNoSuchIconException +extends java.lang.Exception +``` +An exception that is thrown when an invalid icon + is specified. +**See Also:** +: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.library.PHXNoSuchIconException)- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXNoSuchIconException(java.lang.String name)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getInvalidIcon()`retrieves the name that was invalid | + +- ### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXNoSuchIconException + +```java +public PHXNoSuchIconException(java.lang.String name) +``` + +**Parameters:** +: `name`- the name that had no icon +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getInvalidIcon + +```java +public java.lang.String getInvalidIcon() +``` +retrieves the name that was invalid +**Returns:** +: the invalid name +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md new file mode 100644 index 0000000000..307050dc07 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md @@ -0,0 +1,300 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.library +## Class PHXUserDirLibrarian +- java.lang.Object +- - com.phoenix_int.aserver.library.PHXUserDirLibrarian +- **All Implemented Interfaces:** +: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2 + +--- + +```java +public class PHXUserDirLibrarian +extends java.lang.Object +implements com.phoenix_int.aserver.library.IPHXLibrarian2 +``` +This librarian provides "user" directories by looking in a user path + or by reading /etc/passwd. It looks for "public_mcre" directories + inside of each users directory and provides a "virtual" directory + by the name "~" if it finds one. +**Version:** +: Dec 2001 +**Author:** +: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXUserDirLibrarian()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `cleanUp()`Tells this librarian to clean up any resources used. | +| `PHXComponentDescription` | `describe(java.lang.String compClass, + java.lang.String virtualDir)`describes the specified component. | +| `java.lang.String` | `getQueues(java.lang.String compClass, + java.lang.String virtualDir)`method for getting Queues from CenterLink, MCRE just returns blank string | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions)`There are 2 options for this class. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir)`creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir)`Creates an instance of the specified component. | +| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue)`Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`lists any available sub-directories from a particular directory | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXUserDirLibrarian + +```java +public PHXUserDirLibrarian() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### initialize + +```java +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) + throws java.lang.Exception +``` +There are 2 options for this class. The first is "userPath", which + is a semi-colon separated list of paths to search. Each path will + be searched for public_mcre directories ONE LEVEL DEEP from the + specified directory. +The other option is "smartUserScan", which tells this class to try + and read the user's home directories from /etc/passwd + +The XML format is: + +```java + + + path1/here;path2 + + + +``` +Note, the mere existance of the smartUserScan tag turns the option on. +**Specified by:** +: `initialize`in interface`IPHXLibrarian` +**Throws:** +: `java.lang.Exception` + +- #### cleanUp + +```java +public void cleanUp() +``` +Description copied from interface:`IPHXLibrarian`Tells this librarian to clean up any resources used. +**Specified by:** +: `cleanUp`in interface`IPHXLibrarian` + +- #### listComponents + +```java +public java.util.Collection listComponents(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +returns the components in a specific directory +**Specified by:** +: `listComponents`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: an array of class names +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### listDirectories + +```java +public java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException +``` +Description copied from interface:`IPHXLibrarian`lists any available sub-directories from a particular directory +**Specified by:** +: `listDirectories`in interface`IPHXLibrarian` +**Parameters:** +: `virtualDir`- The directory the client asked for +**Returns:** +: a Collection of Strings +**Throws:** +: `PHXNoSuchCategoryException` +: `com.phoenix_int.aserver.security.PHXAccessDeniedException` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception +``` +creates an instance of the specified component. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: an instance of the associated component class with the file + loaded +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `java.lang.IllegalAccessException`- cannot call constructor +: `java.lang.InstantiationException`- cannot call constructor +: `java.lang.reflect.InvocationTargetException`- if an exception + if the specified component exists, but is not of the right type, + or if an exception occurs while creating the class or loading + the setup file +: `java.lang.Exception` + +- #### instantiate + +```java +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the + request off to the IPHXFactory. +It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate + cases as they are handled in special ways by the librarian mounter and librarian combiner. +**Specified by:** +: `instantiate`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +: `connector`- name of the connector object to use +: `queue`- name of the queue object to use +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### instantiateManaged + +```java +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +Creates an instance of the specified component. + Typically a librarian will find the appropriate files + and pass the request off to the IPHXFactory. +It is important that this class throws + PHXNoSuchCategoryException and ClassNotFoundException + in the appropriate cases as they are handled + in special ways by the librarian mounter and librarian + combiner. +**Specified by:** +: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: an instance of the specified component class and its managed resources +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName + passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't + indicate a valid class for the specified directory +: `java.lang.Exception`- If anything serious goes wrong + +- #### describe + +```java +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +describes the specified component. +**Specified by:** +: `describe`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- the directory to search for the component class +**Returns:** +: a description of the specified component class +**Throws:** +: `java.lang.ClassNotFoundException`- if the class is not found +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.Exception`- If anything goes wrong + +- #### getQueues + +```java +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception +``` +method for getting Queues from CenterLink, MCRE just returns blank string +**Specified by:** +: `getQueues`in interface`IPHXLibrarian` +**Parameters:** +: `compClass`- the class name for the component +: `virtualDir`- The directory the client asked for +**Returns:** +: a list of queues for the specified component class +**Throws:** +: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid +: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory +: `java.lang.Exception`- If anything goes wrong +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-frame.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-frame.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md new file mode 100644 index 0000000000..0758fe1fdd --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md @@ -0,0 +1,35 @@ +# Package com.phoenix_int.aserver.library +Provides a library of available components and catgories (directories) and +factories for instantiating components. +See:Description +- | Interface | Description | +| --- | --- | +| [IPHXFactory](../../../../com/phoenix_int/aserver/library/IPHXFactory.html) | DeprecatedIt is preferred to use`IPHXFactory2`, as this class has methods that can leak resources | +| [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html) | DeprecatedIt is preferred to use`IPHXLibrarian2`as this class uses methods that can leak resources. | +| [IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html) | DeprecatedIt is preferred to use`IPHXVersionedLibrarian3`as this class has methods that + can leak resources | +| [IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) | DeprecatedIt is preferred to use`IPHXVersionedLibrarian3`as this class supports + methods that can cause file leaks. | +- | Class | Description | +| --- | --- | +| [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html) | Implementation of IPHXLibrarian which loads files out of CVS. | +| [PHXDirectoryLibrarian](../../../../com/phoenix_int/aserver/library/PHXDirectoryLibrarian.html) | This librarian provides a window into a directory on disk that contains wrapper and component files. | +| [PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html) | This class combines several sub-librarians, adding dir lists and component lists together. | +| [PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html) | This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be + "mounted" very similarly to the UNIX concept of mounting filesystems. | +| [PHXUserDirLibrarian](../../../../com/phoenix_int/aserver/library/PHXUserDirLibrarian.html) | This librarian provides "user" directories by looking in a user path + or by reading /etc/passwd. | +- | Exception | Description | +| --- | --- | +| [PHXNoSuchAssociationException](../../../../com/phoenix_int/aserver/library/PHXNoSuchAssociationException.html) | An exception that is thrown when an invalid association + is specified. | +| [PHXNoSuchCategoryException](../../../../com/phoenix_int/aserver/library/PHXNoSuchCategoryException.html) | An exception that is thrown when an invalid class category + is specified. | +| [PHXNoSuchIconException](../../../../com/phoenix_int/aserver/library/PHXNoSuchIconException.html) | An exception that is thrown when an invalid icon + is specified. | + +## Package com.phoenix_int.aserver.library Description +Provides a library of available components and catgories (directories) and +factories for instantiating components. Contains the +standard directory-based publishing technique as well as interfaces for writing +archiving and versioning plug-ins.Put @see and @since tags down here. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md new file mode 100644 index 0000000000..dab2df3528 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md @@ -0,0 +1,23 @@ +# Hierarchy For Package com.phoenix_int.aserver.library +Package Hierarchies: +- [All Packages](../../../../overview-tree.html) +## Class Hierarchy + +- java.lang.Object +- com.phoenix_int.aserver.library.[PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html)(implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) +- com.phoenix_int.aserver.library.[PHXDirectoryLibrarian](../../../../com/phoenix_int/aserver/library/PHXDirectoryLibrarian.html)(implements com.phoenix_int.aserver.library.IPHXLibrarian2) +- com.phoenix_int.aserver.library.[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html)(implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) +- com.phoenix_int.aserver.library.[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html)(implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) +- com.phoenix_int.aserver.library.[PHXUserDirLibrarian](../../../../com/phoenix_int/aserver/library/PHXUserDirLibrarian.html)(implements com.phoenix_int.aserver.library.IPHXLibrarian2) +- java.lang.Throwable (implements java.io.Serializable) +- java.lang.Exception +- com.phoenix_int.aserver.library.[PHXNoSuchAssociationException](../../../../com/phoenix_int/aserver/library/PHXNoSuchAssociationException.html) +- com.phoenix_int.aserver.library.[PHXNoSuchCategoryException](../../../../com/phoenix_int/aserver/library/PHXNoSuchCategoryException.html) +- com.phoenix_int.aserver.library.[PHXNoSuchIconException](../../../../com/phoenix_int/aserver/library/PHXNoSuchIconException.html) + +## Interface Hierarchy + +- com.phoenix_int.aserver.library.[IPHXFactory](../../../../com/phoenix_int/aserver/library/IPHXFactory.html) +- com.phoenix_int.aserver.library.[IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html) +- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html) +- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md new file mode 100644 index 0000000000..9993929fc2 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md @@ -0,0 +1,39 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.monitors +## Interface IPHXFileCallback +- --- + +```java +public interface IPHXFileCallback +``` +Callback interface to signal data available on a file being + monitored.- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `boolean` | `dataReady(java.lang.String data)`Called when data is ready | +| `boolean` | `fileTruncated()`Indicates that the file was truncated back to 0 bytes. |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### dataReady + +```java +boolean dataReady(java.lang.String data) +``` +Called when data is ready +**Parameters:** +: `data`- The available data +**Returns:** +: true to continue monitoring, false to abort monitoring + +- #### fileTruncated + +```java +boolean fileTruncated() +``` +Indicates that the file was truncated back to 0 bytes. +**Returns:** +: true to continue monitoring, false to abort monitoring +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md new file mode 100644 index 0000000000..16d9b055c7 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md @@ -0,0 +1,52 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.monitors +## Class PHXFileMonitor.FileMonitorChangeException +- java.lang.Object +- - java.lang.Throwable +- - java.lang.Exception +- - java.io.IOException +- - com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeException +- **All Implemented Interfaces:** +: java.io.Serializable + +**Enclosing class:** +: [PHXFileMonitor](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.html) + +--- + +```java +public class PHXFileMonitor.FileMonitorChangeException +extends java.io.IOException +``` + +**See Also:** +: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeException)- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `FileMonitorChangeException()` | +| `FileMonitorChangeException(java.lang.String msg)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +- ### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### FileMonitorChangeException + +```java +public FileMonitorChangeException() +``` + +- #### FileMonitorChangeException + +```java +public FileMonitorChangeException(java.lang.String msg) +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md new file mode 100644 index 0000000000..0f0cdb2988 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md @@ -0,0 +1,135 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.monitors +## Class PHXFileMonitor +- java.lang.Object +- - com.phoenix_int.aserver.monitors.PHXFileMonitor +- --- + +```java +public class PHXFileMonitor +extends java.lang.Object +``` +This class monitors a File for data by polling. It + reads off the stream in the normal manner until EOF, then + it enters a polling loop waiting for more data to become + available. This is akin to tail -f in UNIX, except that + it starts at the beginning of the file intead of near + the end. +This class is not designed to be re-used after ending + the current monitor. +**Version:** +: 2001 Oct +**Author:** +: Nathan P Sharp +**See Also:** +: [IPHXFileCallback](../../../../com/phoenix_int/aserver/monitors/IPHXFileCallback.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +| Modifier and Type | Class and Description | +| --- | --- | +| Modifier and Type | Class and Description | +| `class` | `PHXFileMonitor.FileMonitorChangeException` | +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXFileMonitor(PHXRawFilemonitor,IPHXFileCallbackcallback)` | +| `PHXFileMonitor(java.lang.String monitor,IPHXFileCallbackcallback)`Create a monitor | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `doMonitor()`Begin monitoring. | +| `void` | `endMonitor()`Signals this monitor to stop monitoring and return + as soon as possible. | +| `long` | `getPollDelay()` | +| `void` | `setPollDelay(long pd)`Poll Delay is how long to sleep in milliseconds between polling the + file for more data. | +| `void` | `signalFileChange()`Tells the thread to stop monitoring but to send an + error to the client saying that the file has been + changed. | +| `void` | `waitForMonitorDeath()` | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXFileMonitor + +```java +public PHXFileMonitor(java.lang.String monitor, + IPHXFileCallback callback) +``` +Create a monitor +**Parameters:** +: `monitor`- The filename of the file to monitor +: `callback`- The callback to call as data becomes + available + +- #### PHXFileMonitor + +```java +public PHXFileMonitor(PHXRawFile monitor, + IPHXFileCallback callback) +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### setPollDelay + +```java +public void setPollDelay(long pd) + throws java.lang.IllegalArgumentException +``` +Poll Delay is how long to sleep in milliseconds between polling the + file for more data. 1 second by default and cannot be set to under + 0.5 seconds. +**Throws:** +: `java.lang.IllegalArgumentException` + +- #### getPollDelay + +```java +public long getPollDelay() +``` + +- #### endMonitor + +```java +public void endMonitor() +``` +Signals this monitor to stop monitoring and return + as soon as possible. + +- #### waitForMonitorDeath + +```java +public void waitForMonitorDeath() +``` + +- #### signalFileChange + +```java +public void signalFileChange() +``` +Tells the thread to stop monitoring but to send an + error to the client saying that the file has been + changed. +This class WAITS for the monitor to stop monitoring + on the sub-thread before it returns. + +- #### doMonitor + +```java +public void doMonitor() + throws java.io.IOException +``` +Begin monitoring. Does not return until the monitor + is halted. +**Throws:** +: `java.io.IOException` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md new file mode 100644 index 0000000000..7ad927fb1c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md @@ -0,0 +1,76 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.monitors +## Class PHXMonitorableStream.MonitorWriter +- java.lang.Object +- - java.io.Writer +- - com.phoenix_int.aserver.monitors.PHXMonitorableStream.MonitorWriter +- **All Implemented Interfaces:** +: java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable + +**Enclosing class:** +: [PHXMonitorableStream](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.html) + +--- + +```java +public class PHXMonitorableStream.MonitorWriter +extends java.io.Writer +```- =========== FIELD SUMMARY =========== +- ### Field Summary + +- ### Fields inherited from class java.io.Writer +`lock` +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `close()` | +| `void` | `flush()` | +| `void` | `write(char[] buf, + int pos, + int len)` | + +- ### Methods inherited from class java.io.Writer +`append, append, append, write, write, write, write` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### flush + +```java +public void flush() +``` + +**Specified by:** +: `flush`in interface`java.io.Flushable` +**Specified by:** +: `flush`in class`java.io.Writer` + +- #### close + +```java +public void close() +``` + +**Specified by:** +: `close`in interface`java.io.Closeable` +**Specified by:** +: `close`in interface`java.lang.AutoCloseable` +**Specified by:** +: `close`in class`java.io.Writer` + +- #### write + +```java +public void write(char[] buf, + int pos, + int len) +``` + +**Specified by:** +: `write`in class`java.io.Writer` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md new file mode 100644 index 0000000000..c0faf33c86 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md @@ -0,0 +1,142 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.monitors +## Class PHXMonitorableStream +- java.lang.Object +- - com.phoenix_int.aserver.monitors.PHXMonitorableStream +- --- + +```java +public class PHXMonitorableStream +extends java.lang.Object +``` +This class represents a stream of data which may be monitored + by a client which supports progress monitors. To use this class, + implement the IPHXMonitorable interface and return instances of + this class. +```java + + public class monitorableComp implements IPHXAnalysis, IPHXMonitorable + { + private PHXMonitorableStream mon1 = new PHXMonitorableStream(); + private PHXMonitorableStream mon2 = new PHXMonitorableStream(); + . + . + . + public execute() throws Exception + { + //Do Stuff + mon1.clear(); + mon2.clear(); + mon1.append("Starting"); + Writer w = mon2.getWriter(); + w.write("Beginning first phase"); + ... + } + public PHXProcessInfo[] listProcesses() throws IOException + { + throws IOException("Not supported"); + } + public String[] listMonitorableFiles() throws IOException; + { + String[] mons = new String[2]; + mons[0] = "monitor1"; + mons[1] = "monitor2"; + return mons; + } + public Object getMonitor(String m) + throws PHXNoSuchObjectException; + { + if ( "monitor1".equals(m) ) + return mon1; + if ( "monitor2".equals(m) ) + return mon2; + throw new PHXNoSuchObjectException(m); + } + } + +```- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +| Modifier and Type | Class and Description | +| --- | --- | +| Modifier and Type | Class and Description | +| `class` | `PHXMonitorableStream.MonitorWriter` | +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXMonitorableStream()`Default Constructor | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `addMonitorListener(IPHXFileCallbackcb)`Adds a listener which gets events based on changes to this + monitor | +| `void` | `append(java.lang.String text)`Appends a string to this monitor | +| `void` | `clear()`Clears the contents of this monitor | +| `java.lang.String` | `getString()`Gets the current contents of the stream | +| `java.io.Writer` | `getWriter()`Gets a java.io.Writer which when written to appends onto + this monitor | +| `void` | `removeMonitorListener(IPHXFileCallbackcb)`Removes a listener from this monitor | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXMonitorableStream + +```java +public PHXMonitorableStream() +``` +Default Constructor +============ METHOD DETAIL ========== +- ### Method Detail + +- #### addMonitorListener + +```java +public void addMonitorListener(IPHXFileCallback cb) +``` +Adds a listener which gets events based on changes to this + monitor + +- #### removeMonitorListener + +```java +public void removeMonitorListener(IPHXFileCallback cb) +``` +Removes a listener from this monitor + +- #### getWriter + +```java +public java.io.Writer getWriter() +``` +Gets a java.io.Writer which when written to appends onto + this monitor + +- #### clear + +```java +public void clear() +``` +Clears the contents of this monitor + +- #### getString + +```java +public java.lang.String getString() +``` +Gets the current contents of the stream + +- #### append + +```java +public void append(java.lang.String text) +``` +Appends a string to this monitor +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-frame.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-frame.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md new file mode 100644 index 0000000000..8c1c08787b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md @@ -0,0 +1,20 @@ +# Package com.phoenix_int.aserver.monitors +Provides interfaces and classes for adding process and output monitoring +of components. +See:Description +- | Interface | Description | +| --- | --- | +| [IPHXFileCallback](../../../../com/phoenix_int/aserver/monitors/IPHXFileCallback.html) | Callback interface to signal data available on a file being + monitored. | +- | Class | Description | +| --- | --- | +| [PHXFileMonitor](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.html) | This class monitors a File for data by polling. | +| [PHXMonitorableStream](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.html) | This class represents a stream of data which may be monitored + by a client which supports progress monitors. | +- | Exception | Description | +| --- | --- | +| Exception | Description | + +## Package com.phoenix_int.aserver.monitors Description +Provides interfaces and classes for adding process and output monitoring +of components.Put @see and @since tags down here. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md new file mode 100644 index 0000000000..ca3a33de36 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md @@ -0,0 +1,18 @@ +# Hierarchy For Package com.phoenix_int.aserver.monitors +Package Hierarchies: +- [All Packages](../../../../overview-tree.html) +## Class Hierarchy + +- java.lang.Object +- com.phoenix_int.aserver.monitors.[PHXFileMonitor](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.html) +- com.phoenix_int.aserver.monitors.[PHXMonitorableStream](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.html) +- java.lang.Throwable (implements java.io.Serializable) +- java.lang.Exception +- java.io.IOException +- com.phoenix_int.aserver.monitors.[PHXFileMonitor.FileMonitorChangeException](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.html) +- java.io.Writer (implements java.lang.Appendable, java.io.Closeable, java.io.Flushable) +- com.phoenix_int.aserver.monitors.[PHXMonitorableStream.MonitorWriter](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.html) + +## Interface Hierarchy + +- com.phoenix_int.aserver.monitors.[IPHXFileCallback](../../../../com/phoenix_int/aserver/monitors/IPHXFileCallback.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md new file mode 100644 index 0000000000..5a95b435c7 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md @@ -0,0 +1,48 @@ +# Package: com.phoenix_int.aserver + +This package provides interfaces and classes for server-side components and infrastructure in the ModelCenter environment. It includes APIs for component execution, monitoring, run sharing, file management, and related server operations. + +The `com.phoenix_int.aserver` package contains the following key interfaces and classes: + + +## Interface Summary +| Interface | Description | +|------|-------------| +| `IPHXAlwaysWriteable` | Interface for components that are always writeable. | +| `IPHXAnalysis` | Interface for analysis components. | +| `IPHXComponent` | Base interface for all server-side components. | +| `IPHXDriver` | Interface for driver components. | +| `IPHXHaltableComponent` | Interface for components that can be halted. | +| `IPHXMonitorable` | Interface for monitorable components. | +| `IPHXRunQueue` | Interface for managing run queues. | +| `IPHXSelfManager` | Interface for self-managing components. | +| `IPHXSelfManager2` | Extended self-manager interface. | +| `IPHXSelfManager3` | Further extended self-manager interface. | +| `IPHXSetupFromFile` | Interface for components that can be set up from a file. | + +## Class Summary +| Class | Description | +|------|-------------| +| `PHXComponentBranch` | This class represents a branch on a revision history tree for a version controlled component. | +| `PHXComponentDescription` | A class for holding description information about an component class. | +| `PHXComponentVersion` | This class represents a version on a revision history tree for a version controlled component. | +| `PHXGroup` | A utility class for holding sub-variables. | +| `PHXInvokeReturn` | A utility class for holding return information from an invoked function. | +| `PHXMethodDescriptor` | A utility class used by PHXSelfManager to indicate which methods it can invoke. | +| `PHXPropertyDescriptor` | A utility class used by PHXSelfManager to indicate which properties it manages. | +| `PHXRunShare` | This class handles runshare capabilities for any component which needs it. | +| `PHXSimpleSelfManager` | This is a class that implements most of the functionality of a self-managing component. | +| `PHXSimpleSelfManager2` | This is a class that implements most of the functionality of a self-managing component. | +| `PHXSimpleSelfManager3` | This is a class that implements most of the functionality of a self-managing component. | +| `PHXVariableInfo` | This is a utility class for holding parsing information about a variable. | + +## Exception Summary +| Exception | Description | +|-----------|-------------| +| `PHXDFTException` | | +| `PHXInvalidNameException` | An exception that is thrown when trying to create a new object using an invalid name. | +| `PHXNameAlreadyInUseException` | An exception that is thrown when trying to create a new object with a name that already exists. | +| `PHXNoSuchObjectException` | An exception that is thrown when an object cannot be found. | +| `PHXNoSuchWriteableObjectException` | An exception that the PHXObjectManager throws when it can't find an object. | +| `ProcessHaltedException` | Exception indicating that the request cannot be handled because the associated process was halted. | + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md new file mode 100644 index 0000000000..9402e43a98 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md @@ -0,0 +1,44 @@ +# Hierarchy For Package com.phoenix_int.aserver + +**Package Hierarchies** +- [All Packages](../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - com.phoenix_int.aserver.[PHXComponentBranch](../../../com/phoenix_int/aserver/PHXComponentBranch.html) + - com.phoenix_int.aserver.[PHXComponentDescription](../../../com/phoenix_int/aserver/PHXComponentDescription.html) + - com.phoenix_int.aserver.[PHXComponentVersion](../../../com/phoenix_int/aserver/PHXComponentVersion.html) + - com.phoenix_int.aserver.[PHXGroup](../../../com/phoenix_int/aserver/PHXGroup.html) + - com.phoenix_int.aserver.[PHXInvokeReturn](../../../com/phoenix_int/aserver/PHXInvokeReturn.html) + - com.phoenix_int.aserver.[PHXMethodDescriptor](../../../com/phoenix_int/aserver/PHXMethodDescriptor.html) + - com.phoenix_int.aserver.[PHXPropertyDescriptor](../../../com/phoenix_int/aserver/PHXPropertyDescriptor.html) + - com.phoenix_int.aserver.[PHXRunShare](../../../com/phoenix_int/aserver/PHXRunShare.html) (implements com.phoenix_int.aserver.[IPHXMonitorable](../../../com/phoenix_int/aserver/IPHXMonitorable.html), com.phoenix_int.aserver.trace.IPHXTraceGenerator) + - com.phoenix_int.aserver.[PHXRunShare.RunInfo](../../../com/phoenix_int/aserver/PHXRunShare.RunInfo.html) + - com.phoenix_int.aserver.[PHXSimpleSelfManager](../../../com/phoenix_int/aserver/PHXSimpleSelfManager.html) (implements com.phoenix_int.aserver.[IPHXComponent](../../../com/phoenix_int/aserver/IPHXComponent.html), com.phoenix_int.aserver.[IPHXSelfManager](../../../com/phoenix_int/aserver/IPHXSelfManager.html)) + - com.phoenix_int.aserver.[PHXSimpleSelfManager2](../../../com/phoenix_int/aserver/PHXSimpleSelfManager2.html) (implements com.phoenix_int.aserver.[IPHXSelfManager2](../../../com/phoenix_int/aserver/IPHXSelfManager2.html)) + - com.phoenix_int.aserver.[PHXSimpleSelfManager3](../../../com/phoenix_int/aserver/PHXSimpleSelfManager3.html) (implements com.phoenix_int.aserver.IPHXConnector, com.phoenix_int.aserver.[IPHXSelfManager3](../../../com/phoenix_int/aserver/IPHXSelfManager3.html)) + - com.phoenix_int.aserver.[PHXVariableInfo](../../../com/phoenix_int/aserver/PHXVariableInfo.html) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - java.io.IOException + - com.phoenix_int.aserver.[ProcessHaltedException](../../../com/phoenix_int/aserver/ProcessHaltedException.html) + - com.phoenix_int.aserver.[PHXDFTException](../../../com/phoenix_int/aserver/PHXDFTException.html) + - com.phoenix_int.aserver.[PHXInvalidNameException](../../../com/phoenix_int/aserver/PHXInvalidNameException.html) + - com.phoenix_int.aserver.[PHXNameAlreadyInUseException](../../../com/phoenix_int/aserver/PHXNameAlreadyInUseException.html) + - com.phoenix_int.aserver.[PHXNoSuchObjectException](../../../com/phoenix_int/aserver/PHXNoSuchObjectException.html) + - com.phoenix_int.aserver.[PHXNoSuchWriteableObjectException](../../../com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.html) + +## Interface Hierarchy + +- com.phoenix_int.aserver.[IPHXAlwaysWriteable](../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html) +- com.phoenix_int.aserver.[IPHXComponent](../../../com/phoenix_int/aserver/IPHXComponent.html) + - com.phoenix_int.aserver.[IPHXAnalysis](../../../com/phoenix_int/aserver/IPHXAnalysis.html) + - com.phoenix_int.aserver.[IPHXDriver](../../../com/phoenix_int/aserver/IPHXDriver.html) +- com.phoenix_int.aserver.[IPHXHaltableComponent](../../../com/phoenix_int/aserver/IPHXHaltableComponent.html) +- com.phoenix_int.aserver.[IPHXMonitorable](../../../com/phoenix_int/aserver/IPHXMonitorable.html) +- com.phoenix_int.aserver.[IPHXRunQueue](../../../com/phoenix_int/aserver/IPHXRunQueue.html) +- com.phoenix_int.aserver.[IPHXSelfManager](../../../com/phoenix_int/aserver/IPHXSelfManager.html) + - com.phoenix_int.aserver.[IPHXSelfManager2](../../../com/phoenix_int/aserver/IPHXSelfManager2.html) + - com.phoenix_int.aserver.[IPHXSelfManager3](../../../com/phoenix_int/aserver/IPHXSelfManager3.html) +- com.phoenix_int.aserver.[IPHXSetupFromFile](../../../com/phoenix_int/aserver/IPHXSetupFromFile.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md new file mode 100644 index 0000000000..7496f8d3e6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md @@ -0,0 +1,56 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Interface IPHXDescription +- **All Known Subinterfaces:** +: [IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) + +**All Known Implementing Classes:** +: [PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html),[PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html) + +--- + +```java +public interface IPHXDescription +``` +Interface for types with descriptions +Example usage: + +```java + + IPHXType var = wrapper.getVariable("myVar"); + if (var instanceof IPHXDescription) + { + ((IPHXDescription)var).setDescription("my variable"); + } + +``` +**Author:** +: bdurham- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getDescription()`Get the variable description | +| `void` | `setDescription(java.lang.String desc)`Set the variable description. |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### getDescription + +```java +java.lang.String getDescription() +``` +Get the variable description +**Returns:** +: description + +- #### setDescription + +```java +void setDescription(java.lang.String desc) +``` +Set the variable description. + This should be a short, one-line description. +**Parameters:** +: `desc`- the description +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md new file mode 100644 index 0000000000..7047e6e55a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md @@ -0,0 +1,62 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Interface IPHXFormat +- **All Known Implementing Classes:** +: [PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html) + +--- + +```java +public interface IPHXFormat +``` +Interface for variables that support formats +Example usage: + +```java + + IPHXType var = wrapper.getVariable("myVar"); + if (var instanceof IPHXFormat) + { + ((IPHXFormat)var).setFormat("0.0"); + } + +``` +**Author:** +: bdurham- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getFormat()`Get the format string for the variable | +| `boolean` | `hasFormat()`Whether or not the variable has a format | +| `void` | `setFormat(java.lang.String format)`Set the format string for the variable |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### getFormat + +```java +java.lang.String getFormat() +``` +Get the format string for the variable +**Returns:** +: format string + +- #### hasFormat + +```java +boolean hasFormat() +``` +Whether or not the variable has a format +**Returns:** +: true if variable has a format + +- #### setFormat + +```java +void setFormat(java.lang.String format) +``` +Set the format string for the variable +**Parameters:** +: `format`- format string +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md new file mode 100644 index 0000000000..e47bb296f3 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md @@ -0,0 +1,130 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Interface IPHXRefPropInfo +- **All Superinterfaces:** +: [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html) + +**All Known Implementing Classes:** +: [PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html),[PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html) + +--- + +```java +public interface IPHXRefPropInfo +extends IPHXDescription +``` +This interface provides information about a reference property: +- **name**: String +- **type**: String +- **enumValues**: String[] +- **description**: String +- **title**: String +- **input**: boolean +where type may be any of the following: +- "long" +- "double" +- "boolean" +- "string" +**Author:** +: Woyak- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `enumValuesFromString(java.lang.String enumValues)` | +| `java.lang.String[]` | `getEnumValues()`lists enum values | +| `boolean` | `getInput()`retrieves an indicator of whether the ref prop is an input + or an output. | +| `java.lang.String` | `getName()`retrieves the name of the variable | +| `java.lang.String` | `getTitle()`retrieves a title of the ref prop. | +| `java.lang.String` | `getType()`retrieves the current type of the variable | +| `void` | `setEnumValues(java.lang.String[] enumValues)`sets the enum values | +| `void` | `setInput(boolean value)`sets an indicator for the ref prop | +| `void` | `setTitle(java.lang.String value)`sets a title of the ref prop | + +- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXDescription +`getDescription,setDescription`- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### getName + +```java +java.lang.String getName() +``` +retrieves the name of the variable +**Returns:** +: the name of the variable + +- #### getType + +```java +java.lang.String getType() +``` +retrieves the current type of the variable +**Returns:** +: the value of the variable + +- #### getTitle + +```java +java.lang.String getTitle() +``` +retrieves a title of the ref prop. Used by ModelCenter when + displaying the variable in certain dialogs +**Returns:** +: a title for the ref prop + +- #### setTitle + +```java +void setTitle(java.lang.String value) +``` +sets a title of the ref prop +**Parameters:** +: `value`- a title for the ref prop + +- #### getInput + +```java +boolean getInput() +``` +retrieves an indicator of whether the ref prop is an input + or an output. If it's an output, the driver component + will calculate a value for it. +**Returns:** +: an indicator if the ref prop is an input + +- #### setInput + +```java +void setInput(boolean value) +``` +sets an indicator for the ref prop +**Parameters:** +: `value`- an indicator for the ref prop + +- #### getEnumValues + +```java +java.lang.String[] getEnumValues() +``` +lists enum values +**Returns:** +: an array of enum values + +- #### setEnumValues + +```java +void setEnumValues(java.lang.String[] enumValues) +``` +sets the enum values +**Parameters:** +: `enumValues`- an array of enum values + +- #### enumValuesFromString + +```java +void enumValuesFromString(java.lang.String enumValues) +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md new file mode 100644 index 0000000000..5910b7cc4e --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md @@ -0,0 +1,50 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Interface IPHXType +- **All Known Subinterfaces:** +: [IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IRuntimeVariable](../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) + +**All Known Implementing Classes:** +: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) + +--- + +```java +public interface IPHXType +``` +The interface for all Phoenix types. Phoenix types are + usually composite classes that provide subproperties for things + like descriptions, units, etc. Implementing this interface permits + the ModelCenter Remote Execution to set and get values directly from the object + even though the value may actually be stored as a sub-property. +**Author:** +: Woyak- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `fromString(java.lang.String value)`Set the value for the variable using a string | +| `java.lang.String` | `toString()`Gets the value for the variable |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### fromString + +```java +void fromString(java.lang.String value) +``` +Set the value for the variable using a string +**Parameters:** +: `value`- the value of the variable + +- #### toString + +```java +java.lang.String toString() +``` +Gets the value for the variable +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: the value as a String +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md new file mode 100644 index 0000000000..0003b6dfe6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md @@ -0,0 +1,158 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Interface IPHXType2.IVisitor +- **Type Parameters:** +: `T`- The results type from the visitation. + +**Enclosing interface:** +: [IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) + +--- + +```java +public static interface IPHXType2.IVisitor +``` +The interface of a visitor into an IPHXType2. +A part of the visitor pattern. + +**Note:**PHXFile, PHXFloatArray, PHXInteger, PHXIntegerArray, PHXObjectArray, PHXReference and PHXScriptObject are + not supported by the visitor pattern of IPXHType2.- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `T` | `visit(PHXBooleanhost)`Visit a PHXBoolean. | +| `T` | `visit(PHXBooleanArrayhost)`Visit a PHXBooleanArray. | +| `T` | `visit(PHXDoublehost)`Visit a PHXDouble. | +| `T` | `visit(PHXDoubleArrayhost)`Visit a PHXDoubleArray. | +| `T` | `visit(PHXGeometryhost)`Visit a PHXGeometry. | +| `T` | `visit(PHXLonghost)`Visit a PHXLong. | +| `T` | `visit(PHXLongArrayhost)`Visit a PHXLongArray. | +| `T` | `visit(PHXRawFilehost)`Visit a PHXRawFile. | +| `T` | `visit(PHXRawFileArrayhost)`Visit a PHXRawFileArray. | +| `T` | `visit(PHXStringhost)`Visit a PHXString. | +| `T` | `visit(PHXStringArrayhost)`Visit a PHXStringArray. |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### visit + +```java +T visit(PHXBoolean host) +``` +Visit a PHXBoolean. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXLong host) +``` +Visit a PHXLong. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXDouble host) +``` +Visit a PHXDouble. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXString host) +``` +Visit a PHXString. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXRawFile host) +``` +Visit a PHXRawFile. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXGeometry host) +``` +Visit a PHXGeometry. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXBooleanArray host) +``` +Visit a PHXBooleanArray. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXLongArray host) +``` +Visit a PHXLongArray. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXDoubleArray host) +``` +Visit a PHXDoubleArray. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXStringArray host) +``` +Visit a PHXStringArray. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. + +- #### visit + +```java +T visit(PHXRawFileArray host) +``` +Visit a PHXRawFileArray. +**Parameters:** +: `host`- The host of the visit. +**Returns:** +: The results of the visitation. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md new file mode 100644 index 0000000000..299381e310 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md @@ -0,0 +1,82 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Interface IPHXType2 +- **All Superinterfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html) + +**All Known Subinterfaces:** +: [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) + +**All Known Implementing Classes:** +: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) + +--- + +```java +public interface IPHXType2 +extends IPHXType +``` +The interface for Phoenix types which use PHXStringBuffer instead of String for performance. +**Author:** +: nsharp +**See Also:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +| Modifier and Type | Interface and Description | +| --- | --- | +| Modifier and Type | Interface and Description | +| `static interface` | `IPHXType2.IVisitor`The interface of a visitor into an IPHXType2. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `void` | `fromString2(PHXStringBuffersb)`Configures the type based on a PHXStringBuffer representation of the type | +| `PHXStringBuffer` | `toString2()`Gets a PHXStringBuffer representation of the type | + +- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType +`fromString,toString`- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### toString2 + +```java +PHXStringBuffer toString2() + throws java.io.IOException +``` +Gets a PHXStringBuffer representation of the type +**Returns:** +: PHXStringBuffer representation of the type +**Throws:** +: `java.io.IOException` + +- #### fromString2 + +```java +void fromString2(PHXStringBuffer sb) + throws java.io.IOException, + PHXGetByUrlException +``` +Configures the type based on a PHXStringBuffer representation of the type +**Parameters:** +: `sb`- representation of the type to use +**Throws:** +: `java.io.IOException` +: `PHXGetByUrlException` + +- #### Accept + +```java + T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md new file mode 100644 index 0000000000..6bf1b7fdae --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md @@ -0,0 +1,55 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Interface IPHXUnits +- **All Known Subinterfaces:** +: [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) + +**All Known Implementing Classes:** +: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) + +--- + +```java +public interface IPHXUnits +``` +Interface for PHX variables that support units +Example usage: + +```java + + IPHXType var = wrapper.getVariable("myVar"); + if (var instanceof IPHXUnits) + { + ((IPHXUnits)var).setUnits("m"); + } + +``` +**Author:** +: bdurham- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getUnits()`Get the units string for the variable | +| `void` | `setUnits(java.lang.String units)`Set the units string for the variable |- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### getUnits + +```java +java.lang.String getUnits() +``` +Get the units string for the variable +**Returns:** +: units string + +- #### setUnits + +```java +void setUnits(java.lang.String units) +``` +Set the units string for the variable +**Parameters:** +: `units`- units for the variable +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md new file mode 100644 index 0000000000..60c2cd19d6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md @@ -0,0 +1,100 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXAppearance +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXAppearance +- --- + +```java +public class PHXAppearance +extends java.lang.Object +``` +This is a utility class for holding appearance properties. The class + is used by the PHXGeomInfo class +**Author:** +: Woyak, 10/98- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXAppearance(boolean hasColor)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `double` | `getBlue()` | +| `double` | `getGreen()` | +| `boolean` | `getHasColor()` | +| `double` | `getRed()` | +| `void` | `setBlue(double v)` | +| `void` | `setColor(double r, + double g, + double b)` | +| `void` | `setGreen(double v)` | +| `void` | `setRed(double v)` | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXAppearance + +```java +public PHXAppearance(boolean hasColor) +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getRed + +```java +public double getRed() +``` + +- #### getGreen + +```java +public double getGreen() +``` + +- #### getBlue + +```java +public double getBlue() +``` + +- #### getHasColor + +```java +public boolean getHasColor() +``` + +- #### setRed + +```java +public void setRed(double v) +``` + +- #### setGreen + +```java +public void setGreen(double v) +``` + +- #### setBlue + +```java +public void setBlue(double v) +``` + +- #### setColor + +```java +public void setColor(double r, + double g, + double b) +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md new file mode 100644 index 0000000000..2ad25ce51d --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md @@ -0,0 +1,246 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXBoolean +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXBoolean +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- + +```java +public class PHXBoolean +extends PHXSimpleType +``` +The Phoenix type for booleans. This class adds the following + features to the PHXSimpleType: +- **value**: boolean +- **valueStr**: the source string for the value, + useful for error checking when the value is NaN +**Author:** +: Woyak +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXBoolean()`initializes value to false | +| `PHXBoolean(boolean value)`Initializes the value to the specified value. | +| `PHXBoolean(PHXBooleanother)`Clone another PHXBoolean's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `PHXBoolean` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | +| `boolean` | `getValue()`retrieves the current value of the variable | +| `java.lang.String` | `getValueStr()`retrieves the string value of this variable as passed into the + last call to fromString(). | +| `static boolean` | `parse(java.lang.Object value)`a utility function to convert a string to a boolean value | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`indicates whether the object should accept bad values in the + fromString() method without throwning an exception. | +| `void` | `setValue(boolean v)`sets the value for the variable | +| `java.lang.String` | `toString()`converts the variable to a string | +| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXBoolean + +```java +public PHXBoolean() +``` +initializes value to false + +- #### PHXBoolean + +```java +public PHXBoolean(boolean value) +``` +Initializes the value to the specified value. +**Parameters:** +: `value`- + +- #### PHXBoolean + +```java +public PHXBoolean(PHXBoolean other) +``` +Clone another PHXBoolean's value and metadata. +**Parameters:** +: `other`- the other PHXBoolean to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getValue + +```java +public boolean getValue() +``` +retrieves the current value of the variable +**Returns:** +: the value of the variable + +- #### getValueStr + +```java +public java.lang.String getValueStr() +``` +retrieves the string value of this variable as passed into the + last call to fromString(). This may not be equivalent to the current + value of the variable. +**Returns:** +: the string last used to set the variable + +- #### setValue + +```java +public void setValue(boolean v) +``` +sets the value for the variable +**Parameters:** +: `v`- the value + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +converts the variable to a PHXStringBuffer +**Returns:** +: a PHXStringBuffer representation of the variable + +- #### toString + +```java +public java.lang.String toString() +``` +converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +converts a PHXStringBuffer representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +converts a String representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### parse + +```java +public static boolean parse(java.lang.Object value) +``` +a utility function to convert a string to a boolean value +**Parameters:** +: `value`- the string +**Returns:** +: a boolean value + +- #### setIgnoreConversionErrors + +```java +public void setIgnoreConversionErrors(boolean ignoreConversionErrors) +``` +indicates whether the object should accept bad values in the + fromString() method without throwning an exception. The raw + values is stored in property valueStr regardless. +**Parameters:** +: `ignoreConversionErrors`- true if errors should be ignored + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXBoolean createCopy() +``` +Description copied from class:`PHXSimpleType`Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md new file mode 100644 index 0000000000..a4a593ef4b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md @@ -0,0 +1,259 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXBooleanArray +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html)> +- - com.phoenix_int.aserver.types.PHXBooleanArray +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html)> + +--- + +```java +public class PHXBooleanArray +extends PHXSimpleArray +``` +Class wraps an array of PHXBoolean variables + for the ScriptWrapper utility. +**Version:** +: May 2002 +**Author:** +: Nathan P Sharp +**See Also:** +: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +=========== FIELD SUMMARY =========== +- ### Field Summary + +- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data,_lockDims,_lockResize` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXBooleanArray()` | +| `PHXBooleanArray(java.lang.Object data)` | +| `PHXBooleanArray(PHXBooleanArrayother)`Clone another PHXBooleanArray's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | +| `PHXBooleanArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified + class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `boolean` | `getBooleanValue(int index)`Gets the value of an element as a boolean | +| `boolean` | `getBooleanValue(int[] index)`Gets the value of an element as a boolean | +| `PHXBoolean` | `getValue(int[] index)`Gets the value of an element as a PHXBoolean object | +| `void` | `setValue(int[] index, + boolean val)`Sets the value of an element as a boolean | +| `void` | `setValue(int[] index,PHXBooleanval)`Sets the value of an element as a PHXBoolean object | +| `void` | `setValue(int index, + boolean val)`Sets the value of an element as a boolean | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData,_getMetaData,_setMetaData,_setMetaData,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +- ### Methods inherited from interface java.lang.Iterable +`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXBooleanArray + +```java +public PHXBooleanArray() +``` + +- #### PHXBooleanArray + +```java +public PHXBooleanArray(java.lang.Object data) +``` + +- #### PHXBooleanArray + +```java +public PHXBooleanArray(PHXBooleanArray other) +``` +Clone another PHXBooleanArray's value and metadata. +**Parameters:** +: `other`- the other PHXBooleanArray to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### dataTypeOK + +```java +protected boolean dataTypeOK(java.lang.Class c) +``` +Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified + class is acceptable as an array element component type. +**Specified by:** +: `dataTypeOK`in class`PHXSimpleArray` + +- #### allocateElement + +```java +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. + If the class type in question has a default constructor, + there is no need to override this. +**Overrides:** +: `allocateElement`in class`PHXSimpleArray` +**Throws:** +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### getValue + +```java +public PHXBoolean getValue(int[] index) +``` +Gets the value of an element as a PHXBoolean object +**Specified by:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### getBooleanValue + +```java +public boolean getBooleanValue(int index) +``` +Gets the value of an element as a boolean +**Parameters:** +: `index`- 1D array index +**Returns:** +: referenced array value +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### getBooleanValue + +```java +public boolean getBooleanValue(int[] index) +``` +Gets the value of an element as a boolean +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### setValue + +```java +public void setValue(int[] index, + PHXBoolean val) +``` +Sets the value of an element as a PHXBoolean object +**Specified by:** +: `setValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +: `val`- value to set + +- #### setValue + +```java +public void setValue(int index, + boolean val) +``` +Sets the value of an element as a boolean +**Parameters:** +: `index`- 1D array index +: `val`- value to set +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### setValue + +```java +public void setValue(int[] index, + boolean val) +``` +Sets the value of an element as a boolean +**Parameters:** +: `index`- nD array index +: `val`- value to set + +- #### elementFromString + +```java +protected java.lang.Object elementFromString(java.lang.String val) +``` +Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. This is only used when the element type does not + implement IPHXType or IPHXType2. For primitives, return + the wrapper objects. +**Specified by:** +: `elementFromString`in class`PHXSimpleArray` + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXBooleanArray createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md new file mode 100644 index 0000000000..cb997285c6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md @@ -0,0 +1,62 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXDataCollector +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXDataCollector +- --- + +```java +public class PHXDataCollector +extends java.lang.Object +``` +A class for Driver Components to tell ModelCenter what to do with the + DataCollector while the component is running. +**Author:** +: Woyak, 2/00- =========== FIELD SUMMARY =========== +- ### Field Summary + +| Modifier and Type | Field and Description | +| --- | --- | +| Modifier and Type | Field and Description | +| `boolean` | `collect` | +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXDataCollector()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `boolean` | `getCollect()` | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ FIELD DETAIL =========== +- ### Field Detail + +- #### collect + +```java +public boolean collect +``` +========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXDataCollector + +```java +public PHXDataCollector() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getCollect + +```java +public boolean getCollect() +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md new file mode 100644 index 0000000000..a8c1c5f24b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md @@ -0,0 +1,519 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXDouble +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXDouble +- **All Implemented Interfaces:** +: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- + +```java +public class PHXDouble +extends PHXSimpleType +implements IPHXFormat +``` +The Phoenix type for doubles. This class adds the following + features to the PHXSimpleType: +- **value**: double +- **valueStr**: the source string for the value, + useful for error checking when the value is NaN +- **hasUpperValue**: boolean +- **upperValue**: double +- **hasLowerValue**: boolean +- **lowerValue**: double +- **enumValues**: double[] +- **enumValues**: string[] +If the variable has an upper or lower bound and an attempt + is made to store an invalid value, then an exception will + be thrown. +**Author:** +: Woyak +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXDouble()`initializes value to zero without upper or lower bounds | +| `PHXDouble(double value)`Initializes value to specified value without upper or lower bounds. | +| `PHXDouble(PHXDoubleother)`Clone another PHXDouble's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_copyMetadataFromOther(PHXDoubleother)`Clone another PHXDouble's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `static java.lang.String` | `arrayToString(double[] sa)` | +| `PHXDouble` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | +| `void` | `fromString3(java.lang.String value, + java.util.function.ToDoubleFunction converter)`converts a String representation to the internal value using specified converter | +| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | +| `double[]` | `getEnumValues()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a + comma separated string | +| `java.lang.String` | `getFormat()`Get the format string for the variable | +| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | +| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | +| `double` | `getLowerBound()`retrieves the current lower bound value | +| `double` | `getUpperBound()`retrieves the current upper bound value | +| `double` | `getValue()`retrieves the current value of the variable | +| `java.lang.String` | `getValueStr()`retrieves the string value of this variable as passed into the + last call to fromString(). | +| `boolean` | `hasFormat()`Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | +| `void` | `setEnumValues(double[] values)`Sets the enumeration list of valid values. | +| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration List with values. | +| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | +| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`indicates whether the object should accept bad values in the + fromString() method without throwning an exception. | +| `void` | `setLowerBound(double value)`sets the lower bound. | +| `void` | `setLowerBound(java.lang.String value)` | +| `void` | `setUpperBound(double value)`sets the upper bound. | +| `void` | `setUpperBound(java.lang.String value)` | +| `void` | `setValue(double v)`sets the value for the variable | +| `java.lang.String` | `toString()`converts the variable to a string | +| `java.lang.String` | `toString(int width)`Converts the value to a string with the best possible formatting, e.g. | +| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXDouble + +```java +public PHXDouble() +``` +initializes value to zero without upper or lower bounds + +- #### PHXDouble + +```java +public PHXDouble(double value) +``` +Initializes value to specified value without upper or lower bounds. +**Parameters:** +: `value`- + +- #### PHXDouble + +```java +public PHXDouble(PHXDouble other) +``` +Clone another PHXDouble's value and metadata. +**Parameters:** +: `other`- the other PHXDouble to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### _copyMetadataFromOther + +```java +protected final void _copyMetadataFromOther(PHXDouble other) +``` +Clone another PHXDouble's metadata. +**Parameters:** +: `other`- the other PHXDouble + +- #### getValue + +```java +public double getValue() +``` +retrieves the current value of the variable +**Returns:** +: the value of the variable + +- #### getValueStr + +```java +public java.lang.String getValueStr() +``` +retrieves the string value of this variable as passed into the + last call to fromString(). This may not be equivalent to the current + value of the variable. +**Returns:** +: the string last used to set the variable + +- #### setValue + +```java +public void setValue(double v) +``` +sets the value for the variable +**Parameters:** +: `v`- the value + +- #### setUpperBound + +```java +public void setUpperBound(double value) +``` +sets the upper bound. The hasUpperBound value is set to true +**Parameters:** +: `value`- the upper bound + +- #### setUpperBound + +```java +public void setUpperBound(java.lang.String value) +``` + +- #### getUpperBound + +```java +public double getUpperBound() +``` +retrieves the current upper bound value +**Returns:** +: the upper bound + +- #### setLowerBound + +```java +public void setLowerBound(double value) +``` +sets the lower bound. The hasLowerBound value is set to true +**Parameters:** +: `value`- the lower bound + +- #### setLowerBound + +```java +public void setLowerBound(java.lang.String value) +``` + +- #### getLowerBound + +```java +public double getLowerBound() +``` +retrieves the current lower bound value +**Returns:** +: the lower bound + +- #### setHasUpperBound + +```java +public void setHasUpperBound(boolean value) +``` +sets the hasUpperBound flag +**Parameters:** +: `value`- true or false + +- #### getHasUpperBound + +```java +public boolean getHasUpperBound() +``` +retrieves the hasUpperBound flag +**Returns:** +: true or false + +- #### setHasLowerBound + +```java +public void setHasLowerBound(boolean value) +``` +sets the hasLowerBound flag +**Parameters:** +: `value`- true or false + +- #### getHasLowerBound + +```java +public boolean getHasLowerBound() +``` +retrieves the hasLowerBound flag +**Returns:** +: true or false + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +converts the variable to a PHXStringBuffer +**Specified by:** +: `toString2`in interface`IPHXType2` +**Returns:** +: the PHXStringBuffer representation of the variable + +- #### toString + +```java +public java.lang.String toString() +``` +converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +converts a PHXStringBuffer representation to the internal value +**Specified by:** +: `fromString2`in interface`IPHXType2` +**Parameters:** +: `value`- the value to convert + +- #### fromString3 + +```java +public void fromString3(java.lang.String value, + java.util.function.ToDoubleFunction converter) +``` +converts a String representation to the internal value using specified converter +**Parameters:** +: `value`- the value to convert +: `converter`- functional interface used to convert String value to a double + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +converts a String representation to the internal value +**Specified by:** +: `fromString`in interface`IPHXType` +**Parameters:** +: `value`- the value to convert + +- #### toString + +```java +public java.lang.String toString(int width) + throws PHXNumberFormatException +``` +Converts the value to a string with the best possible formatting, e.g. + scientific or absolute values based on the width available. +**Parameters:** +: `width`- the number of characters print to +**Returns:** +: the formatted string value +**Throws:** +: `PHXNumberFormatException` + +- #### setIgnoreConversionErrors + +```java +public void setIgnoreConversionErrors(boolean ignoreConversionErrors) +``` +indicates whether the object should accept bad values in the + fromString() method without throwning an exception. The raw + values is stored in property valueStr regardless. +**Parameters:** +: `ignoreConversionErrors`- true if errors should be ignored + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration List with values. +**Parameters:** +: `values`- A comma seperrated string of enumeration values + +- #### setEnumValues + +```java +public void setEnumValues(double[] values) +``` +Sets the enumeration list of valid values. +**Parameters:** +: `values`- An array of double values + +- #### getEnumValues + +```java +public double[] getEnumValues() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumValuesStr + +```java +public java.lang.String getEnumValuesStr() +``` +Interface function to pass out the enumeration array as a + comma separated string +**Returns:** +: comma separated string of the possible values of the list + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration aliases list with values. +**Parameters:** +: `values`- A comma seperated string of enumeration aliases + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String[] values) +``` +Sets the enumeration aliases list +**Parameters:** +: `values`- An array of strings + +- #### getEnumAliases + +```java +public java.lang.String[] getEnumAliases() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumAliasesStr + +```java +public java.lang.String getEnumAliasesStr() +``` +An interface function for the enumeration array +**Returns:** +: an comma separated string of the possible values of the list + +- #### setFormat + +```java +public void setFormat(java.lang.String format) +``` +Set the format string for the variable +**Specified by:** +: `setFormat`in interface`IPHXFormat` +**Parameters:** +: `format`- format string + +- #### getFormat + +```java +public java.lang.String getFormat() +``` +Get the format string for the variable +**Specified by:** +: `getFormat`in interface`IPHXFormat` +**Returns:** +: format string + +- #### hasFormat + +```java +public boolean hasFormat() +``` +Whether or not the variable has a format +**Specified by:** +: `hasFormat`in interface`IPHXFormat` +**Returns:** +: true if variable has a format + +- #### arrayToString + +```java +public static java.lang.String arrayToString(double[] sa) +``` + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. + + NOTE: two PHXDoubles are considered naturally equal if they are the same to within 5 significant figures. The + equals natural algorithm uses a relative error or epsilon comparison for equality. This should NOT be confused + with a true double equality comparison and should not be used as such! It is only intended to verify that values + specified in PACJ configurations are roughly equal to instantiated component values. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Specified by:** +: `Accept`in interface`IPHXType2` +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXDouble createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md new file mode 100644 index 0000000000..a4798d35bc --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md @@ -0,0 +1,537 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXDoubleArray +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html)> +- - com.phoenix_int.aserver.types.PHXDoubleArray +- **All Implemented Interfaces:** +: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html)> + +--- + +```java +public class PHXDoubleArray +extends PHXSimpleArray +implements IPHXFormat +``` +Class wraps an array of PHXDouble variables + for the ScriptWrapper utility. +**Version:** +: May 2002 +**Author:** +: Nathan P Sharp +**See Also:** +: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +=========== FIELD SUMMARY =========== +- ### Field Summary + +- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data,_lockDims,_lockResize` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXDoubleArray()` | +| `PHXDoubleArray(java.lang.Object data)` | +| `PHXDoubleArray(PHXDoubleArrayother)`Clone another PHXDoubleArray's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. | +| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data + in this object. | +| `void` | `_sort(PHXDoubleArrayarray, + boolean ascend)` | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | +| `PHXDoubleArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified + class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `double` | `getAvg()` | +| `double` | `getDoubleValue(int index)`Gets an element as a double | +| `double` | `getDoubleValue(int[] index)`Gets an element as a double | +| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | +| `double[]` | `getEnumValues()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a + comma separated string | +| `java.lang.String` | `getFormat()`Get the format string for the variable | +| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | +| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | +| `double` | `getLowerBound()`retrieves the current lower bound value | +| `double` | `getMax()` | +| `double` | `getMin()` | +| `double` | `getUpperBound()`retrieves the current upper bound value | +| `PHXDouble` | `getValue(int[] index)`gets an element as a PHXDouble object | +| `boolean` | `hasFormat()`Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | +| `void` | `setEnumValues(double[] values)`Sets the enumeration list of valid values. | +| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration List with values. | +| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | +| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | +| `void` | `setLowerBound(double value)`sets the lower bound. | +| `void` | `setUpperBound(double value)`sets the upper bound. | +| `void` | `setValue(int[] index, + double val)`sets an element as a double | +| `void` | `setValue(int[] index,PHXDoubleval)`sets an element as a PHXDouble object | +| `void` | `setValue(int index, + double val)`sets an element as a double | +| `void` | `sort()` | +| `void` | `sortReverse()` | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData,_setMetaData,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +- ### Methods inherited from interface java.lang.Iterable +`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXDoubleArray + +```java +public PHXDoubleArray() +``` + +- #### PHXDoubleArray + +```java +public PHXDoubleArray(java.lang.Object data) +``` + +- #### PHXDoubleArray + +```java +public PHXDoubleArray(PHXDoubleArray other) +``` +Clone another PHXDoubleArray's value and metadata. +**Parameters:** +: `other`- the other PHXDoubleArray to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### dataTypeOK + +```java +protected boolean dataTypeOK(java.lang.Class c) +``` +Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified + class is acceptable as an array element component type. +**Specified by:** +: `dataTypeOK`in class`PHXSimpleArray` + +- #### allocateElement + +```java +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. + If the class type in question has a default constructor, + there is no need to override this. +**Overrides:** +: `allocateElement`in class`PHXSimpleArray` +**Throws:** +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### setUpperBound + +```java +public void setUpperBound(double value) +``` +sets the upper bound. The hasUpperBound value is set to true +**Parameters:** +: `value`- the upper bound + +- #### getUpperBound + +```java +public double getUpperBound() +``` +retrieves the current upper bound value +**Returns:** +: the upper bound +**Throws:** +: `java.lang.IllegalStateException`- Thrown if + there is no upper bound defined. + +- #### setLowerBound + +```java +public void setLowerBound(double value) +``` +sets the lower bound. The hasLowerBound value is set to true +**Parameters:** +: `value`- the lower bound + +- #### getLowerBound + +```java +public double getLowerBound() +``` +retrieves the current lower bound value +**Returns:** +: the lower bound + +- #### setHasUpperBound + +```java +public void setHasUpperBound(boolean value) +``` +sets the hasUpperBound flag +**Parameters:** +: `value`- true or false + +- #### getHasUpperBound + +```java +public boolean getHasUpperBound() +``` +retrieves the hasUpperBound flag +**Returns:** +: true or false + +- #### setHasLowerBound + +```java +public void setHasLowerBound(boolean value) +``` +sets the hasLowerBound flag +**Parameters:** +: `value`- true or false + +- #### getHasLowerBound + +```java +public boolean getHasLowerBound() +``` +retrieves the hasLowerBound flag +**Returns:** +: true or false + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration List with values. +**Parameters:** +: `values`- A comma seperrated string of enumeration values + +- #### setEnumValues + +```java +public void setEnumValues(double[] values) +``` +Sets the enumeration list of valid values. +**Parameters:** +: `values`- An array of double values + +- #### getEnumValues + +```java +public double[] getEnumValues() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumValuesStr + +```java +public java.lang.String getEnumValuesStr() +``` +Interface function to pass out the enumeration array as a + comma separated string +**Returns:** +: comma separated string of the possible values of the list + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration aliases list with values. +**Parameters:** +: `values`- A comma seperated string of enumeration aliases + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String[] values) +``` +Sets the enumeration aliases list +**Parameters:** +: `values`- An array of strings + +- #### getEnumAliases + +```java +public java.lang.String[] getEnumAliases() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumAliasesStr + +```java +public java.lang.String getEnumAliasesStr() +``` +An interface function for the enumeration array +**Returns:** +: an comma separated string of the possible values of the list + +- #### setFormat + +```java +public void setFormat(java.lang.String format) +``` +Set the format string for the variable +**Specified by:** +: `setFormat`in interface`IPHXFormat` +**Parameters:** +: `format`- format string + +- #### getFormat + +```java +public java.lang.String getFormat() +``` +Get the format string for the variable +**Specified by:** +: `getFormat`in interface`IPHXFormat` +**Returns:** +: format string + +- #### hasFormat + +```java +public boolean hasFormat() +``` +Whether or not the variable has a format +**Specified by:** +: `hasFormat`in interface`IPHXFormat` +**Returns:** +: true if variable has a format + +- #### _setMetaData + +```java +protected void _setMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data + in this object. Override this to set additional + information in sub-classes. Be sure to call + super._setMetaData(PHXSimpleType) +**Overrides:** +: `_setMetaData`in class`PHXSimpleArray` + +- #### _getMetaData + +```java +protected void _getMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. Override this in order to add + more custom meta data in sub-classes. Be sure to cal + super._getMetaData(PHXSimpleType), though! +**Overrides:** +: `_getMetaData`in class`PHXSimpleArray` + +- #### getValue + +```java +public PHXDouble getValue(int[] index) +``` +gets an element as a PHXDouble object +**Specified by:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### getDoubleValue + +```java +public double getDoubleValue(int index) +``` +Gets an element as a double +**Parameters:** +: `index`- 1D array index +**Returns:** +: referenced array value +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### getDoubleValue + +```java +public double getDoubleValue(int[] index) +``` +Gets an element as a double +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### setValue + +```java +public void setValue(int[] index, + PHXDouble val) +``` +sets an element as a PHXDouble object +**Specified by:** +: `setValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +: `val`- value to set + +- #### setValue + +```java +public void setValue(int index, + double val) +``` +sets an element as a double +**Parameters:** +: `index`- 1D array index +: `val`- value to set + +- #### setValue + +```java +public void setValue(int[] index, + double val) +``` +sets an element as a double +**Parameters:** +: `index`- nD array index +: `val`- value to set + +- #### elementFromString + +```java +protected java.lang.Object elementFromString(java.lang.String val) +``` +Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. This is only used when the element type does not + implement IPHXType or IPHXType2. For primitives, return + the wrapper objects. +**Specified by:** +: `elementFromString`in class`PHXSimpleArray` + +- #### getMax + +```java +public double getMax() +``` + +- #### getMin + +```java +public double getMin() +``` + +- #### getAvg + +```java +public double getAvg() +``` + +- #### sortReverse + +```java +public void sortReverse() +``` + +- #### sort + +```java +public void sort() +``` + +- #### _sort + +```java +public void _sort(PHXDoubleArray array, + boolean ascend) +``` + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Specified by:** +: `Accept`in interface`IPHXType2` +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXDoubleArray createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md new file mode 100644 index 0000000000..0b1e8ce7fa --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md @@ -0,0 +1,289 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXFile +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXFile +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- +Deprecated. + +```java +@Deprecated +public class PHXFile +extends PHXSimpleType +``` +Internal data type used for certain types of files. End + users should use PHXRawFile to implement file variables + in their custom components. +- **name**: String +- **contents**: String +**Author:** +: Woyak, 6/98 +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXFile()`Deprecated. | +| `PHXFile(PHXFileother)`Deprecated.Clone another PHXFile's value and metadata. | +| `PHXFile(java.lang.String fileName)`Deprecated. | +| `PHXFile(java.lang.String baseName, + java.lang.String name)`Deprecated. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Deprecated.Accept a Visitor. | +| `PHXFile` | `createCopy()`Deprecated.Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Deprecated.Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Deprecated.Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`Deprecated.converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`Deprecated.converts a PHXStringBuffer representation to the internal value | +| `java.lang.String` | `getContents()`Deprecated.retrieves the contents of the file | +| `java.lang.String` | `getName()`Deprecated.retrieves the name of the file | +| `java.lang.String` | `getNameCoded()`Deprecated.retrieves the name of the file in coded form (without $variables + replaced) | +| `boolean` | `hasChanged()`Deprecated.checks to see if the file has changed since the last time + getContents() was called | +| `void` | `markAsRead()`Deprecated.call this function after you manually get the contents of the + file. | +| `void` | `setBaseName(java.lang.String v)`Deprecated.sets the base name of the file | +| `void` | `setName(java.lang.String v)`Deprecated.sets the name of the file | +| `void` | `setStringReplacer(PHXStringReplacerr)`Deprecated.specifies a PHXStringReplacer object for use in forming the + full file name. | +| `java.lang.String` | `toString()`Deprecated.converts the variable to a string | +| `PHXStringBuffer` | `toString2()`Deprecated.converts the variable to a string | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXFile + +```java +public PHXFile() +``` +Deprecated. + +- #### PHXFile + +```java +public PHXFile(java.lang.String fileName) +``` +Deprecated. + +- #### PHXFile + +```java +public PHXFile(java.lang.String baseName, + java.lang.String name) +``` +Deprecated. + +- #### PHXFile + +```java +public PHXFile(PHXFile other) +``` +Deprecated.Clone another PHXFile's value and metadata. +**Parameters:** +: `other`- the other PHXFile to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getName + +```java +public java.lang.String getName() +``` +Deprecated.retrieves the name of the file +**Returns:** +: the name of the file + +- #### getNameCoded + +```java +public java.lang.String getNameCoded() +``` +Deprecated.retrieves the name of the file in coded form (without $variables + replaced) +**Returns:** +: the name of the file in coded form + +- #### setName + +```java +public void setName(java.lang.String v) +``` +Deprecated.sets the name of the file +**Parameters:** +: `v`- the name + +- #### setBaseName + +```java +public void setBaseName(java.lang.String v) +``` +Deprecated.sets the base name of the file +**Parameters:** +: `v`- the name + +- #### setStringReplacer + +```java +public void setStringReplacer(PHXStringReplacer r) +``` +Deprecated.specifies a PHXStringReplacer object for use in forming the + full file name. +**Parameters:** +: `r`- the string replacer object + +- #### getContents + +```java +public java.lang.String getContents() + throws java.io.IOException +``` +Deprecated.retrieves the contents of the file +**Returns:** +: the contents of the file +**Throws:** +: `java.io.IOException` + +- #### markAsRead + +```java +public void markAsRead() +``` +Deprecated.call this function after you manually get the contents of the + file. The function records it's name and timestamp for use with + the hasChanged() function + +- #### hasChanged + +```java +public boolean hasChanged() +``` +Deprecated.checks to see if the file has changed since the last time + getContents() was called +**Returns:** +: true if the timestamp of the file is new, or if the + file name has changed + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +Deprecated.converts the variable to a string +**Returns:** +: a PHXStringBuffer representation of the variable + +- #### toString + +```java +public java.lang.String toString() +``` +Deprecated.converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +Deprecated.converts a PHXStringBuffer representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +Deprecated.converts a String representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Deprecated.Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Deprecated.Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Deprecated.Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXFile createCopy() +``` +Deprecated.Description copied from class:`PHXSimpleType`Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md new file mode 100644 index 0000000000..08bfb224bb --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md @@ -0,0 +1,83 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXGeomInfo +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXGeomInfo +- --- + +```java +public class PHXGeomInfo +extends java.lang.Object +``` +this is a utility class that mirrors the structures in ModelCenter. If you + want to calculate values for certain geometry information such as CGs, + instantiate this class and set the values for the desired parameters. + ModelCenter will then use these parameters instead of letting the user + specify values or calculating them itself. +**Author:** +: Woyak 10/98- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXGeomInfo()` | +| `PHXGeomInfo(boolean hasRotation, + boolean hasTranslation, + boolean hasColor, + boolean hasCentroid, + boolean hasVolume, + boolean hasSurfaceArea, + boolean hasMass)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `PHXAppearance` | `getAppearance()` | +| `PHXMassProperties` | `getMassProperties()` | +| `PHXOrientation` | `getOrientation()` | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXGeomInfo + +```java +public PHXGeomInfo() +``` + +- #### PHXGeomInfo + +```java +public PHXGeomInfo(boolean hasRotation, + boolean hasTranslation, + boolean hasColor, + boolean hasCentroid, + boolean hasVolume, + boolean hasSurfaceArea, + boolean hasMass) +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getOrientation + +```java +public PHXOrientation getOrientation() +``` + +- #### getAppearance + +```java +public PHXAppearance getAppearance() +``` + +- #### getMassProperties + +```java +public PHXMassProperties getMassProperties() +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md new file mode 100644 index 0000000000..73970f098e --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md @@ -0,0 +1,249 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXGeometry +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXGeometry +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- + +```java +public class PHXGeometry +extends PHXSimpleType +``` +The Phoenix type for geometry. This class has the following + properties: +- **data**: String - a String representation of the data +- **format**: String - the type of data +- **description**: String +If the variable has an upper or lower bound and an attempt + is made to store an invalid value, then an exception will + be thrown. +**Author:** +: Woyak +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXGeometry()` | +| `PHXGeometry(PHXGeometryother)`Clone another PHXGeometry's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `PHXGeometry` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | +| `java.lang.String` | `getData()`retrieves the current value for the geometry data | +| `java.lang.String` | `getDescription()`retrieves the description of the variable | +| `java.lang.String` | `getFormat()`retrieves the format for the geometry data | +| `void` | `setData(java.lang.String d)`sets the value for the variable | +| `void` | `setDescription(java.lang.String d)`sets the description for the variable. | +| `void` | `setFormat(java.lang.String d)`sets the format for the variable. | +| `java.lang.String` | `toString()`converts the variable to a string | +| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXGeometry + +```java +public PHXGeometry() +``` + +- #### PHXGeometry + +```java +public PHXGeometry(PHXGeometry other) +``` +Clone another PHXGeometry's value and metadata. +**Parameters:** +: `other`- the other PHXGeometry to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getData + +```java +public java.lang.String getData() +``` +retrieves the current value for the geometry data +**Returns:** +: the geometry data + +- #### setData + +```java +public void setData(java.lang.String d) +``` +sets the value for the variable +**Parameters:** +: `d`- the value + +- #### getFormat + +```java +public java.lang.String getFormat() +``` +retrieves the format for the geometry data +**Returns:** +: the format of the geometry data + +- #### setFormat + +```java +public void setFormat(java.lang.String d) + throws PHXInvalidTypeException +``` +sets the format for the variable. The format is a String description of the representation of the data - + specifying a new format only stores a new value for the format +**Parameters:** +: `d`- the value +**Throws:** +: `PHXInvalidTypeException` + +- #### getDescription + +```java +public java.lang.String getDescription() +``` +retrieves the description of the variable +**Overrides:** +: `getDescription`in class`PHXSimpleType` +**Returns:** +: a description geometry data + +- #### setDescription + +```java +public void setDescription(java.lang.String d) +``` +sets the description for the variable. This should be a short, + one-line description. +**Overrides:** +: `setDescription`in class`PHXSimpleType` +**Parameters:** +: `d`- the description + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +converts the variable to a PHXStringBuffer +**Returns:** +: a PHXStringBuffer representation of the variable + +- #### toString + +```java +public java.lang.String toString() +``` +converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +converts a PHXStringBuffer representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +converts a String representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXGeometry createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md new file mode 100644 index 0000000000..1da480532a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md @@ -0,0 +1,487 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXInteger +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXInteger +- **All Implemented Interfaces:** +: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- +Deprecated. + +```java +@Deprecated +public class PHXInteger +extends PHXSimpleType +implements IPHXFormat +``` +**THIS CLASS IS DEPRECATED IN FAVOR OF PHXLong** +The Phoenix type for integers. This class adds the following + features to the PHXSimpleType: + +- **value**: int +- **valueStr**: the source string for the value, + useful for error checking when the value is NaN +- **hasUpperValue**: boolean +- **upperValue**: int +- **hasLowerValue**: boolean +- **lowerValue**: int +- **enumValues**: int[] +- **enumAliases**: String[] +If the variable has an upper or lower bound and an attempt + is made to store an invalid value, then an exception will + be thrown. +**Author:** +: Woyak +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXInteger()`Deprecated. | +| `PHXInteger(PHXIntegerother)`Deprecated.Clone another PHXInteger's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_copyMetadataFromOther(PHXIntegerother)`Deprecated.Clone another PHXInteger's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Deprecated.Accept a Visitor. | +| `static java.lang.String` | `arrayToString(int[] sa)`Deprecated. | +| `PHXInteger` | `createCopy()`Deprecated.Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Deprecated.Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Deprecated.Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`Deprecated.converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`Deprecated.converts a String representation to the internal value | +| `java.lang.String[]` | `getEnumAliases()`Deprecated.An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`Deprecated.An interface function for the enumeration array | +| `int[]` | `getEnumValues()`Deprecated.Interface function to pass out the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`Deprecated.Interface function to pass out the enumeration array as a + comma separated string | +| `java.lang.String` | `getFormat()`Deprecated.Get the format string for the variable | +| `boolean` | `getHasFormat()`Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXInteger.html#hasFormat--) | +| `boolean` | `getHasLowerBound()`Deprecated.retrieves the hasLowerBound flag | +| `boolean` | `getHasUpperBound()`Deprecated.retrieves the hasUpperBound flag | +| `int` | `getLowerBound()`Deprecated.retrieves the current lower bound value | +| `int` | `getUpperBound()`Deprecated.retrieves the current upper bound value | +| `int` | `getValue()`Deprecated.retrieves the current value of the variable | +| `java.lang.String` | `getValueStr()`Deprecated.retrieves the string value of this variable as passed into the + last call to fromString(). | +| `boolean` | `hasFormat()`Deprecated.Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`Deprecated.takes a comma seperated string of values and fills the + enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`Deprecated.Sets the enumeration aliases list | +| `void` | `setEnumValues(int[] values)`Deprecated.Sets the enumeration list of valid values. | +| `void` | `setEnumValues(java.lang.String strEnumList)`Deprecated.sets the possible values a variable may be | +| `void` | `setFormat(java.lang.String format)`Deprecated.Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`Deprecated.sets the hasLowerBound flag | +| `void` | `setHasUpperBound(boolean value)`Deprecated.sets the hasUpperBound flag | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`Deprecated.indicates whether the object should accept bad values in the + fromString() method without throwning an exception. | +| `void` | `setLowerBound(int value)`Deprecated.sets the lower bound. | +| `void` | `setLowerBound(java.lang.String value)`Deprecated. | +| `void` | `setUpperBound(int value)`Deprecated.sets the upper bound. | +| `void` | `setUpperBound(java.lang.String value)`Deprecated. | +| `void` | `setValue(int v)`Deprecated.sets the value for the variable | +| `java.lang.String` | `toString()`Deprecated.converts the variable to a string | +| `PHXStringBuffer` | `toString2()`Deprecated.converts the variable to a PHXStringBuffer | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXInteger + +```java +public PHXInteger() +``` +Deprecated. + +- #### PHXInteger + +```java +public PHXInteger(PHXInteger other) +``` +Deprecated.Clone another PHXInteger's value and metadata. +**Parameters:** +: `other`- the other PHXInteger to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### _copyMetadataFromOther + +```java +protected final void _copyMetadataFromOther(PHXInteger other) +``` +Deprecated.Clone another PHXInteger's metadata. +**Parameters:** +: `other`- the other PHXInteger + +- #### getValue + +```java +public int getValue() +``` +Deprecated.retrieves the current value of the variable +**Returns:** +: the value of the variable + +- #### getValueStr + +```java +public java.lang.String getValueStr() +``` +Deprecated.retrieves the string value of this variable as passed into the + last call to fromString(). This may not be equivalent to the current + value of the variable. +**Returns:** +: the string last used to set the variable + +- #### setValue + +```java +public void setValue(int v) +``` +Deprecated.sets the value for the variable +**Parameters:** +: `v`- the value + +- #### setUpperBound + +```java +public void setUpperBound(int value) +``` +Deprecated.sets the upper bound. The hasUpperBound value is set to true +**Parameters:** +: `value`- the upper bound + +- #### setUpperBound + +```java +public void setUpperBound(java.lang.String value) +``` +Deprecated. + +- #### getUpperBound + +```java +public int getUpperBound() +``` +Deprecated.retrieves the current upper bound value +**Returns:** +: the upper bound + +- #### setLowerBound + +```java +public void setLowerBound(int value) +``` +Deprecated.sets the lower bound. The hasLowerBound value is set to true +**Parameters:** +: `value`- the lower bound + +- #### setLowerBound + +```java +public void setLowerBound(java.lang.String value) +``` +Deprecated. + +- #### getLowerBound + +```java +public int getLowerBound() +``` +Deprecated.retrieves the current lower bound value +**Returns:** +: the lower bound + +- #### setHasUpperBound + +```java +public void setHasUpperBound(boolean value) +``` +Deprecated.sets the hasUpperBound flag +**Parameters:** +: `value`- true or false + +- #### getHasUpperBound + +```java +public boolean getHasUpperBound() +``` +Deprecated.retrieves the hasUpperBound flag +**Returns:** +: true or false + +- #### setHasLowerBound + +```java +public void setHasLowerBound(boolean value) +``` +Deprecated.sets the hasLowerBound flag +**Parameters:** +: `value`- true or false + +- #### getHasLowerBound + +```java +public boolean getHasLowerBound() +``` +Deprecated.retrieves the hasLowerBound flag +**Returns:** +: true or false + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +Deprecated.converts the variable to a PHXStringBuffer +**Specified by:** +: `toString2`in interface`IPHXType2` +**Returns:** +: a PHXStringBuffer representation of the variable + +- #### toString + +```java +public java.lang.String toString() +``` +Deprecated.converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +Deprecated.converts a String representation to the internal value +**Specified by:** +: `fromString2`in interface`IPHXType2` +**Parameters:** +: `value`- the value to convert + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +Deprecated.converts a String representation to the internal value +**Specified by:** +: `fromString`in interface`IPHXType` +**Parameters:** +: `value`- the value to convert + +- #### setIgnoreConversionErrors + +```java +public void setIgnoreConversionErrors(boolean ignoreConversionErrors) +``` +Deprecated.indicates whether the object should accept bad values in the + fromString() method without throwning an exception. The raw + values is stored in property valueStr regardless. +**Parameters:** +: `ignoreConversionErrors`- true if errors should be ignored + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String strEnumList) +``` +Deprecated.sets the possible values a variable may be +**Parameters:** +: `strEnumList`- the comma sepperated list to convert to values + +- #### setEnumValues + +```java +public void setEnumValues(int[] values) +``` +Deprecated.Sets the enumeration list of valid values. +**Parameters:** +: `values`- An array of double values + +- #### getEnumValues + +```java +public int[] getEnumValues() +``` +Deprecated.Interface function to pass out the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumValuesStr + +```java +public java.lang.String getEnumValuesStr() +``` +Deprecated.Interface function to pass out the enumeration array as a + comma separated string +**Returns:** +: comma separated string of the possible values of the list + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String values) +``` +Deprecated.takes a comma seperated string of values and fills the + enumeration aliases list with values. +**Parameters:** +: `values`- A comma seperated string of enumeration aliases + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String[] values) +``` +Deprecated.Sets the enumeration aliases list +**Parameters:** +: `values`- An array of strings + +- #### getEnumAliases + +```java +public java.lang.String[] getEnumAliases() +``` +Deprecated.An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumAliasesStr + +```java +public java.lang.String getEnumAliasesStr() +``` +Deprecated.An interface function for the enumeration array +**Returns:** +: an comma separated string of the possible values of the list + +- #### getHasFormat + +```java +@Deprecated +public boolean getHasFormat() +``` +Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXInteger.html#hasFormat--) + +- #### hasFormat + +```java +public boolean hasFormat() +``` +Deprecated.Whether or not the variable has a format +**Specified by:** +: `hasFormat`in interface`IPHXFormat` +**Returns:** +: true if variable has a format + +- #### setFormat + +```java +public void setFormat(java.lang.String format) +``` +Deprecated.Set the format string for the variable +**Specified by:** +: `setFormat`in interface`IPHXFormat` +**Parameters:** +: `format`- format string + +- #### getFormat + +```java +public java.lang.String getFormat() +``` +Deprecated.Get the format string for the variable +**Specified by:** +: `getFormat`in interface`IPHXFormat` +**Returns:** +: format string + +- #### arrayToString + +```java +public static java.lang.String arrayToString(int[] sa) +``` +Deprecated. + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Deprecated.Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Deprecated.Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Deprecated.Accept a Visitor. +**Specified by:** +: `Accept`in interface`IPHXType2` +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXInteger createCopy() +``` +Deprecated.Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md new file mode 100644 index 0000000000..50689b3ab7 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md @@ -0,0 +1,57 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXInvalidTypeException +- java.lang.Object +- - java.lang.Throwable +- - java.lang.Exception +- - com.phoenix_int.aserver.types.PHXInvalidTypeException +- **All Implemented Interfaces:** +: java.io.Serializable + +--- + +```java +public class PHXInvalidTypeException +extends java.lang.Exception +``` +An exception that is thrown when trying to use a bad type +**See Also:** +: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.types.PHXInvalidTypeException)- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXInvalidTypeException(java.lang.String type)`Create an invalid type exception | +| `PHXInvalidTypeException(java.lang.String type, + java.lang.Throwable cause)`Create an invalid type exception with a cause | +========== METHOD SUMMARY =========== +- ### Method Summary + +- ### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXInvalidTypeException + +```java +public PHXInvalidTypeException(java.lang.String type) +``` +Create an invalid type exception +**Parameters:** +: `type`- the bad type + +- #### PHXInvalidTypeException + +```java +public PHXInvalidTypeException(java.lang.String type, + java.lang.Throwable cause) +``` +Create an invalid type exception with a cause +**Parameters:** +: `type`- the bad type +: `cause`- the exception that caused this exception +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md new file mode 100644 index 0000000000..a02ae930f0 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md @@ -0,0 +1,492 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXLong +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXLong +- **All Implemented Interfaces:** +: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- + +```java +public class PHXLong +extends PHXSimpleType +implements IPHXFormat +``` +The Phoenix type for longs. This class adds the following + features to the PHXSimpleType: +- **value**: long +- **valueStr**: the source string for the value, + useful for error checking when the value is NaN +- **hasUpperValue**: boolean +- **upperValue**: long +- **hasLowerValue**: boolean +- **lowerValue**: long +- **enumValues**: long[] +- **enumAliases**: String[] +If the variable has an upper or lower bound and an attempt + is made to store an invalid value, then an exception will + be thrown. +**Author:** +: Woyak +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXLong()`Initializes value to 0. | +| `PHXLong(long value)`Initializes value to the specified value | +| `PHXLong(PHXLongother)`Clone another PHXLong's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_copyMetadataFromOther(PHXLongother)`Clone another PHXLong's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `static java.lang.String` | `arrayToString(long[] sa)` | +| `PHXLong` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | +| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | +| `long[]` | `getEnumValues()`Interface function to pass out the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a + comma separated string | +| `java.lang.String` | `getFormat()`Get the format string for the variable | +| `boolean` | `getHasFormat()`Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXLong.html#hasFormat--) | +| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | +| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | +| `long` | `getLowerBound()`retrieves the current lower bound value | +| `long` | `getUpperBound()`retrieves the current upper bound value | +| `long` | `getValue()`retrieves the current value of the variable | +| `java.lang.String` | `getValueStr()`retrieves the string value of this variable as passed into the + last call to fromString(). | +| `boolean` | `hasFormat()`Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`Takes an array of strings which represent aliases for + the enumValues. | +| `void` | `setEnumValues(long[] values)`sets the possible values a variable may be | +| `void` | `setEnumValues(java.lang.String strEnumList)`sets the possible values a variable may be | +| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | +| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`indicates whether the object should accept bad values in the + fromString() method without throwning an exception. | +| `void` | `setLowerBound(long value)`sets the lower bound. | +| `void` | `setLowerBound(java.lang.String value)` | +| `void` | `setUpperBound(long value)`sets the upper bound. | +| `void` | `setUpperBound(java.lang.String value)` | +| `void` | `setValue(long v)`sets the value for the variable | +| `java.lang.String` | `toString()`converts the variable to a string | +| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXLong + +```java +public PHXLong() +``` +Initializes value to 0. + +- #### PHXLong + +```java +public PHXLong(long value) +``` +Initializes value to the specified value +**Parameters:** +: `value`- the value to use + +- #### PHXLong + +```java +public PHXLong(PHXLong other) +``` +Clone another PHXLong's value and metadata. +**Parameters:** +: `other`- the other PHXLong to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### _copyMetadataFromOther + +```java +protected final void _copyMetadataFromOther(PHXLong other) +``` +Clone another PHXLong's metadata. +**Parameters:** +: `other`- the other PHXLong + +- #### getValue + +```java +public long getValue() +``` +retrieves the current value of the variable +**Returns:** +: the value of the variable + +- #### getValueStr + +```java +public java.lang.String getValueStr() +``` +retrieves the string value of this variable as passed into the + last call to fromString(). This may not be equivalent to the current + value of the variable. +**Returns:** +: the string last used to set the variable + +- #### setValue + +```java +public void setValue(long v) +``` +sets the value for the variable +**Parameters:** +: `v`- the value + +- #### setUpperBound + +```java +public void setUpperBound(long value) +``` +sets the upper bound. The hasUpperBound value is set to true +**Parameters:** +: `value`- the upper bound + +- #### setUpperBound + +```java +public void setUpperBound(java.lang.String value) +``` + +- #### getUpperBound + +```java +public long getUpperBound() +``` +retrieves the current upper bound value +**Returns:** +: the upper bound + +- #### setLowerBound + +```java +public void setLowerBound(long value) +``` +sets the lower bound. The hasLowerBound value is set to true +**Parameters:** +: `value`- the lower bound + +- #### setLowerBound + +```java +public void setLowerBound(java.lang.String value) +``` + +- #### getLowerBound + +```java +public long getLowerBound() +``` +retrieves the current lower bound value +**Returns:** +: the lower bound + +- #### setHasUpperBound + +```java +public void setHasUpperBound(boolean value) +``` +sets the hasUpperBound flag +**Parameters:** +: `value`- true or false + +- #### getHasUpperBound + +```java +public boolean getHasUpperBound() +``` +retrieves the hasUpperBound flag +**Returns:** +: true or false + +- #### setHasLowerBound + +```java +public void setHasLowerBound(boolean value) +``` +sets the hasLowerBound flag +**Parameters:** +: `value`- true or false + +- #### getHasLowerBound + +```java +public boolean getHasLowerBound() +``` +retrieves the hasLowerBound flag +**Returns:** +: true or false + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +converts the variable to a PHXStringBuffer +**Specified by:** +: `toString2`in interface`IPHXType2` +**Returns:** +: a PHXStringBuffer representation of the variable + +- #### toString + +```java +public java.lang.String toString() +``` +converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +converts a PHXStringBuffer representation to the internal value +**Specified by:** +: `fromString2`in interface`IPHXType2` +**Parameters:** +: `value`- the value to convert + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +converts a String representation to the internal value +**Specified by:** +: `fromString`in interface`IPHXType` +**Parameters:** +: `value`- the value to convert + +- #### setIgnoreConversionErrors + +```java +public void setIgnoreConversionErrors(boolean ignoreConversionErrors) +``` +indicates whether the object should accept bad values in the + fromString() method without throwning an exception. The raw + values is stored in property valueStr regardless. +**Parameters:** +: `ignoreConversionErrors`- true if errors should be ignored + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String strEnumList) +``` +sets the possible values a variable may be +**Parameters:** +: `strEnumList`- the comma sepperated list to convert to values + +- #### setEnumValues + +```java +public void setEnumValues(long[] values) +``` +sets the possible values a variable may be +**Parameters:** +: `values`- Array of longs which represents valid values + +- #### getEnumValues + +```java +public long[] getEnumValues() +``` +Interface function to pass out the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumValuesStr + +```java +public java.lang.String getEnumValuesStr() +``` +Interface function to pass out the enumeration array as a + comma separated string +**Returns:** +: comma separated string of the possible values of the list + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String[] values) +``` +Takes an array of strings which represent aliases for + the enumValues. +**Parameters:** +: `values`- A String array of enumeration aliases + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration aliases list with values. +**Parameters:** +: `values`- A comma seperated string of enumeration aliases + +- #### getEnumAliases + +```java +public java.lang.String[] getEnumAliases() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumAliasesStr + +```java +public java.lang.String getEnumAliasesStr() +``` +An interface function for the enumeration array +**Returns:** +: an comma separated string of the possible values of the list + +- #### getHasFormat + +```java +@Deprecated +public boolean getHasFormat() +``` +Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXLong.html#hasFormat--) + +- #### hasFormat + +```java +public boolean hasFormat() +``` +Whether or not the variable has a format +**Specified by:** +: `hasFormat`in interface`IPHXFormat` +**Returns:** +: true if variable has a format + +- #### setFormat + +```java +public void setFormat(java.lang.String format) +``` +Set the format string for the variable +**Specified by:** +: `setFormat`in interface`IPHXFormat` +**Parameters:** +: `format`- format string + +- #### getFormat + +```java +public java.lang.String getFormat() +``` +Get the format string for the variable +**Specified by:** +: `getFormat`in interface`IPHXFormat` +**Returns:** +: format string + +- #### arrayToString + +```java +public static java.lang.String arrayToString(long[] sa) +``` + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Specified by:** +: `Accept`in interface`IPHXType2` +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXLong createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md new file mode 100644 index 0000000000..a687c4bb2c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md @@ -0,0 +1,561 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXLongArray +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html)> +- - com.phoenix_int.aserver.types.PHXLongArray +- **All Implemented Interfaces:** +: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html)> + +--- + +```java +public class PHXLongArray +extends PHXSimpleArray +implements IPHXFormat +``` +Class wraps an array of PHXLong variables + for the ScriptWrapper utility. +**Version:** +: May 2002 +**Author:** +: Nathan P Sharp +**See Also:** +: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +=========== FIELD SUMMARY =========== +- ### Field Summary + +- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data,_lockDims,_lockResize` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXLongArray()` | +| `PHXLongArray(java.lang.Object data)` | +| `PHXLongArray(PHXLongArrayother)`Clone another PHXLongArray's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. | +| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data + in this object. | +| `void` | `_sort(PHXLongArrayarray, + boolean ascend)` | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | +| `PHXLongArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified + class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `double` | `getAvg()` | +| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | +| `long[]` | `getEnumValues()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a + comma separated string | +| `java.lang.String` | `getFormat()`Get the format string for the variable | +| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | +| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | +| `long` | `getLongValue(int index)`Gets the value of an element as a long | +| `long` | `getLongValue(int[] index)`Gets the value of an element as a long | +| `long` | `getLowerBound()`retrieves the current lower bound value | +| `long` | `getMax()` | +| `long` | `getMin()` | +| `long` | `getUpperBound()`retrieves the current upper bound value | +| `PHXLong` | `getValue(int index)`Gets the value of an element as a PHXLong object | +| `PHXLong` | `getValue(int[] index)`Gets the value of an element as a PHXLong object | +| `boolean` | `hasFormat()`Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | +| `void` | `setEnumValues(long[] values)`sets the possible values a variable may be | +| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration List with values. | +| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | +| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | +| `void` | `setLowerBound(long value)`sets the lower bound. | +| `void` | `setUpperBound(long value)`sets the upper bound. | +| `void` | `setValue(int[] index, + long val)`Sets the value of an element as a PHXLong object | +| `void` | `setValue(int[] index,PHXLongval)`Sets the value of an element as a PHXLong object | +| `void` | `setValue(int index, + long val)`Sets the value of an element as a PHXLong object | +| `void` | `sort()` | +| `void` | `sortReverse()` | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData,_setMetaData,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +- ### Methods inherited from interface java.lang.Iterable +`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXLongArray + +```java +public PHXLongArray() +``` + +- #### PHXLongArray + +```java +public PHXLongArray(java.lang.Object data) +``` + +- #### PHXLongArray + +```java +public PHXLongArray(PHXLongArray other) +``` +Clone another PHXLongArray's value and metadata. +**Parameters:** +: `other`- the other PHXLongArray to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### dataTypeOK + +```java +protected boolean dataTypeOK(java.lang.Class c) +``` +Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified + class is acceptable as an array element component type. +**Specified by:** +: `dataTypeOK`in class`PHXSimpleArray` + +- #### allocateElement + +```java +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. + If the class type in question has a default constructor, + there is no need to override this. +**Overrides:** +: `allocateElement`in class`PHXSimpleArray` +**Throws:** +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### setUpperBound + +```java +public void setUpperBound(long value) +``` +sets the upper bound. The hasUpperBound value is set to true +**Parameters:** +: `value`- the upper bound + +- #### getUpperBound + +```java +public long getUpperBound() +``` +retrieves the current upper bound value +**Returns:** +: the upper bound +**Throws:** +: `java.lang.IllegalStateException`- Thrown if + there is no upper bound defined. + +- #### setLowerBound + +```java +public void setLowerBound(long value) +``` +sets the lower bound. The hasLowerBound value is set to true +**Parameters:** +: `value`- the lower bound + +- #### getLowerBound + +```java +public long getLowerBound() +``` +retrieves the current lower bound value +**Returns:** +: the lower bound + +- #### setHasUpperBound + +```java +public void setHasUpperBound(boolean value) +``` +sets the hasUpperBound flag +**Parameters:** +: `value`- true or false + +- #### getHasUpperBound + +```java +public boolean getHasUpperBound() +``` +retrieves the hasUpperBound flag +**Returns:** +: true or false + +- #### setHasLowerBound + +```java +public void setHasLowerBound(boolean value) +``` +sets the hasLowerBound flag +**Parameters:** +: `value`- true or false + +- #### getHasLowerBound + +```java +public boolean getHasLowerBound() +``` +retrieves the hasLowerBound flag +**Returns:** +: true or false + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration List with values. +**Parameters:** +: `values`- A comma seperrated string of enumeration values + +- #### setEnumValues + +```java +public void setEnumValues(long[] values) +``` +sets the possible values a variable may be +**Parameters:** +: `values`- Array of longs which represents valid values + +- #### getEnumValues + +```java +public long[] getEnumValues() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumValuesStr + +```java +public java.lang.String getEnumValuesStr() +``` +Interface function to pass out the enumeration array as a + comma separated string +**Returns:** +: comma separated string of the possible values of the list + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration aliases list with values. +**Parameters:** +: `values`- A comma seperated string of enumeration aliases + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String[] values) +``` +Sets the enumeration aliases list +**Parameters:** +: `values`- An array of strings + +- #### getEnumAliases + +```java +public java.lang.String[] getEnumAliases() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumAliasesStr + +```java +public java.lang.String getEnumAliasesStr() +``` +An interface function for the enumeration array +**Returns:** +: an comma separated string of the possible values of the list + +- #### setFormat + +```java +public void setFormat(java.lang.String format) +``` +Set the format string for the variable +**Specified by:** +: `setFormat`in interface`IPHXFormat` +**Parameters:** +: `format`- format string + +- #### getFormat + +```java +public java.lang.String getFormat() +``` +Get the format string for the variable +**Specified by:** +: `getFormat`in interface`IPHXFormat` +**Returns:** +: format string + +- #### hasFormat + +```java +public boolean hasFormat() +``` +Description copied from interface:`IPHXFormat`Whether or not the variable has a format +**Specified by:** +: `hasFormat`in interface`IPHXFormat` +**Returns:** +: true if variable has a format + +- #### _setMetaData + +```java +protected void _setMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data + in this object. Override this to set additional + information in sub-classes. Be sure to call + super._setMetaData(PHXSimpleType) +**Overrides:** +: `_setMetaData`in class`PHXSimpleArray` + +- #### _getMetaData + +```java +protected void _getMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. Override this in order to add + more custom meta data in sub-classes. Be sure to cal + super._getMetaData(PHXSimpleType), though! +**Overrides:** +: `_getMetaData`in class`PHXSimpleArray` + +- #### getValue + +```java +public PHXLong getValue(int index) +``` +Gets the value of an element as a PHXLong object +**Overrides:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- 1D array index +**Returns:** +: referenced array value +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### getValue + +```java +public PHXLong getValue(int[] index) +``` +Gets the value of an element as a PHXLong object +**Specified by:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### getLongValue + +```java +public long getLongValue(int index) +``` +Gets the value of an element as a long +**Parameters:** +: `index`- 1D array index +**Returns:** +: referenced array value +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### getLongValue + +```java +public long getLongValue(int[] index) +``` +Gets the value of an element as a long +**Parameters:** +: `index`- 1D array index +**Returns:** +: referenced array value +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### setValue + +```java +public void setValue(int[] index, + PHXLong val) +``` +Sets the value of an element as a PHXLong object +**Specified by:** +: `setValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- 1D array index +: `val`- value to set +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### setValue + +```java +public void setValue(int index, + long val) +``` +Sets the value of an element as a PHXLong object +**Parameters:** +: `index`- 1D array index +: `val`- value to set +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### setValue + +```java +public void setValue(int[] index, + long val) +``` +Sets the value of an element as a PHXLong object +**Parameters:** +: `index`- 1D array index +: `val`- value to set +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### elementFromString + +```java +protected java.lang.Object elementFromString(java.lang.String val) +``` +Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. This is only used when the element type does not + implement IPHXType or IPHXType2. For primitives, return + the wrapper objects. +**Specified by:** +: `elementFromString`in class`PHXSimpleArray` + +- #### getMax + +```java +public long getMax() +``` + +- #### getMin + +```java +public long getMin() +``` + +- #### getAvg + +```java +public double getAvg() +``` + +- #### sortReverse + +```java +public void sortReverse() +``` + +- #### sort + +```java +public void sort() +``` + +- #### _sort + +```java +public void _sort(PHXLongArray array, + boolean ascend) +``` + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Specified by:** +: `Accept`in interface`IPHXType2` +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXLongArray createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md new file mode 100644 index 0000000000..63838a59ba --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md @@ -0,0 +1,176 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXMassProperties +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXMassProperties +- --- + +```java +public class PHXMassProperties +extends java.lang.Object +``` +This is a utility class for holding mass property information. The + class is used by the PHXGeomInfo class +**Author:** +: Woyak, 10/98- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXMassProperties(boolean hasCG, + boolean hasVolume, + boolean hasSurfaceArea, + boolean hasMass)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `java.lang.String` | `getCG()` | +| `double` | `getcgX()` | +| `double` | `getcgY()` | +| `double` | `getcgZ()` | +| `boolean` | `getHasCG()` | +| `boolean` | `getHasMass()` | +| `boolean` | `getHasSurfaceArea()` | +| `boolean` | `getHasVolume()` | +| `double` | `getMass()` | +| `double` | `getSurfaceArea()` | +| `double` | `getVolume()` | +| `void` | `setCG(double x, + double y, + double z)` | +| `void` | `setcgX(double v)` | +| `void` | `setcgY(double v)` | +| `void` | `setcgZ(double v)` | +| `void` | `setMass(double v)` | +| `void` | `setSurfaceArea(double v)` | +| `void` | `setVolume(double v)` | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXMassProperties + +```java +public PHXMassProperties(boolean hasCG, + boolean hasVolume, + boolean hasSurfaceArea, + boolean hasMass) +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getcgX + +```java +public double getcgX() +``` + +- #### getcgY + +```java +public double getcgY() +``` + +- #### getcgZ + +```java +public double getcgZ() +``` + +- #### getVolume + +```java +public double getVolume() +``` + +- #### getSurfaceArea + +```java +public double getSurfaceArea() +``` + +- #### getMass + +```java +public double getMass() +``` + +- #### getHasCG + +```java +public boolean getHasCG() +``` + +- #### getHasVolume + +```java +public boolean getHasVolume() +``` + +- #### getHasSurfaceArea + +```java +public boolean getHasSurfaceArea() +``` + +- #### getHasMass + +```java +public boolean getHasMass() +``` + +- #### setcgX + +```java +public void setcgX(double v) +``` + +- #### setcgY + +```java +public void setcgY(double v) +``` + +- #### setcgZ + +```java +public void setcgZ(double v) +``` + +- #### setVolume + +```java +public void setVolume(double v) +``` + +- #### setSurfaceArea + +```java +public void setSurfaceArea(double v) +``` + +- #### setMass + +```java +public void setMass(double v) +``` + +- #### setCG + +```java +public void setCG(double x, + double y, + double z) +``` + +- #### getCG + +```java +public java.lang.String getCG() +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md new file mode 100644 index 0000000000..801b3d4d7f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md @@ -0,0 +1,44 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXNumberFormatException +- java.lang.Object +- - java.lang.Throwable +- - java.lang.Exception +- - com.phoenix_int.aserver.types.PHXNumberFormatException +- **All Implemented Interfaces:** +: java.io.Serializable + +--- + +```java +public class PHXNumberFormatException +extends java.lang.Exception +``` +Like a NumberFormatException except that it isn't a runtime exception + and must be caught +**Author:** +: Scott Woyak, 10-09 +**See Also:** +: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.types.PHXNumberFormatException)- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXNumberFormatException(java.lang.String msg)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +- ### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXNumberFormatException + +```java +public PHXNumberFormatException(java.lang.String msg) +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md new file mode 100644 index 0000000000..4a377dab44 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md @@ -0,0 +1,235 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXObjectArray +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) +- - com.phoenix_int.aserver.types.PHXObjectArray +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable + +--- + +```java +public class PHXObjectArray +extends PHXSimpleArray +``` +Placeholder for an array of any random Java Object. + This class is useful to keep the system from choking on + random array types, but not designed for customer use. +**Version:** +: Oct 2002 +**Author:** +: Nathan P Sharp +**See Also:** +: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +=========== FIELD SUMMARY =========== +- ### Field Summary + +- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data,_lockDims,_lockResize` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXObjectArray()` | +| `PHXObjectArray(java.lang.Object data)` | +| `PHXObjectArray(PHXObjectArrayother)`Clone another PHXObjectArray's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | +| `PHXObjectArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified + class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `PHXSimpleType` | `getValue(int[] index)`Gets the value of an element as an object of the appropriate subtype + Must be overridden in subclasses | +| `void` | `setValue(int[] index,PHXSimpleTypeval)`Sets an element as an object of the appropriate PHXSimpleType + Must be overridden in subclasses | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData,_getMetaData,_setMetaData,_setMetaData,checkRectangular,copy,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +- ### Methods inherited from interface java.lang.Iterable +`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXObjectArray + +```java +public PHXObjectArray() +``` + +- #### PHXObjectArray + +```java +public PHXObjectArray(java.lang.Object data) +``` + +- #### PHXObjectArray + +```java +public PHXObjectArray(PHXObjectArray other) +``` +Clone another PHXObjectArray's value and metadata. +**Parameters:** +: `other`- the other PHXObjectArray to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### dataTypeOK + +```java +protected boolean dataTypeOK(java.lang.Class c) +``` +Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified + class is acceptable as an array element component type. +**Specified by:** +: `dataTypeOK`in class`PHXSimpleArray` + +- #### allocateElement + +```java +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. + If the class type in question has a default constructor, + there is no need to override this. +**Overrides:** +: `allocateElement`in class`PHXSimpleArray` +**Throws:** +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### elementFromString + +```java +protected java.lang.Object elementFromString(java.lang.String val) +``` +Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. This is only used when the element type does not + implement IPHXType or IPHXType2. For primitives, return + the wrapper objects. +**Specified by:** +: `elementFromString`in class`PHXSimpleArray` + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. + + Array comparison is handled as follows: + 1) Compare the number of dimensions between the two arrays + 2) Compare the length of dimensions between the two arrays + 3) Compare the values in each of the two arrays + Iff these three conditions are met, the two arrays are considered naturally equal. +**Overrides:** +: `equalsNatural`in class`PHXSimpleArray` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### getValue + +```java +public PHXSimpleType getValue(int[] index) +``` +Gets the value of an element as an object of the appropriate subtype + Must be overridden in subclasses +**Specified by:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### setValue + +```java +public void setValue(int[] index, + PHXSimpleType val) +``` +Sets an element as an object of the appropriate PHXSimpleType + Must be overridden in subclasses +**Specified by:** +: `setValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +: `val`- value to set + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXObjectArray createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md new file mode 100644 index 0000000000..4694e2fb6f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md @@ -0,0 +1,144 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXOrientation +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXOrientation +- --- + +```java +public class PHXOrientation +extends java.lang.Object +``` +This is a utility class for holding orientation information. The + class is used as one of the parts of the PHXGeomInfo class +**Author:** +: Woyak, 10/98- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXOrientation(boolean hasRotation, + boolean hasTranslation)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `boolean` | `getHasRotation()` | +| `boolean` | `getHasTranslation()` | +| `double` | `getRotX()` | +| `double` | `getRotY()` | +| `double` | `getRotZ()` | +| `double` | `getTransX()` | +| `double` | `getTransY()` | +| `double` | `getTransZ()` | +| `void` | `setRotX(double v)` | +| `void` | `setRotY(double v)` | +| `void` | `setRotZ(double v)` | +| `void` | `setTransX(double v)` | +| `void` | `setTransY(double v)` | +| `void` | `setTransZ(double v)` | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXOrientation + +```java +public PHXOrientation(boolean hasRotation, + boolean hasTranslation) +``` + +**Parameters:** +: `hasRotation`- true if the object uses the rotation variables +: `hasTranslation`- true if the object uses the translation variables +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getRotX + +```java +public double getRotX() +``` + +- #### getRotY + +```java +public double getRotY() +``` + +- #### getRotZ + +```java +public double getRotZ() +``` + +- #### getHasRotation + +```java +public boolean getHasRotation() +``` + +- #### getTransX + +```java +public double getTransX() +``` + +- #### getTransY + +```java +public double getTransY() +``` + +- #### getTransZ + +```java +public double getTransZ() +``` + +- #### getHasTranslation + +```java +public boolean getHasTranslation() +``` + +- #### setRotX + +```java +public void setRotX(double v) +``` + +- #### setRotY + +```java +public void setRotY(double v) +``` + +- #### setRotZ + +```java +public void setRotZ(double v) +``` + +- #### setTransX + +```java +public void setTransX(double v) +``` + +- #### setTransY + +```java +public void setTransY(double v) +``` + +- #### setTransZ + +```java +public void setTransZ(double v) +``` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md new file mode 100644 index 0000000000..5fb6cf7453 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md @@ -0,0 +1,896 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXRawFile +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXRawFile +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.AutoCloseable + +--- + +```java +public class PHXRawFile +extends PHXSimpleType +implements IPHXType2, java.lang.AutoCloseable +``` +The Phoenix type for Files. The working contents of the file are kept in a temporary file on + disk, where changes are made before they are manually synced to the actual file. Read the + documentation for each method to make sure it is doing what you expect it to. + + The temporary file containing the contents can optionally be maintained by calling[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--). + + In that case, calling code becomes responsible for deleting the contents of the file. +**Author:** +: Woyak, 9/98- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXRawFile()` | +| `PHXRawFile(PHXRawFileother)`Clone another PHXRawFile's value and metadata. | +| `PHXRawFile(java.lang.String fileName)` | +| `PHXRawFile(java.lang.String baseName, + java.lang.String name)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_setContentFromOther(PHXRawFilevariable)` | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `void` | `addMonitor(PHXFileMonitorfm)`PHXFileMonitor is used to monitor changes to a file + as it is being created as in the UNIX 'tail -f' + command. | +| `void` | `backupFile()`Backup the actual file on disk. | +| `void` | `backupFile(java.lang.String fileName)`Backup the actual file on disk. | +| `void` | `close()` | +| `PHXRawFile` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `void` | `deleteContents()`Releases the handle to the temporary file. | +| `void` | `deleteFile()`Deletes the actual file from disk. | +| `void` | `deleteFile(java.lang.String fileName)`Deletes the actual file from disk. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `protected void` | `finalize()`Although close should be called manually before garbage collection, do so here as a backup. | +| `void` | `fromAPIObject(java.util.Map object, + com.phoenix_int.functional.FunctionThrows fileStore)`Populate this instance from a string-string map. | +| `void` | `fromFile()`Loads the contents of the actual file on disk into the temporary file. | +| `void` | `fromFile(java.lang.String filename)`Sets the filename and then loads the contents of the actual file on disk into the temporary + file. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`Sets the file temporary file contents to the value of the string. | +| `void` | `fromString2(PHXStringBuffernewContents)`Sets the file temporary file contents to the value of the PHXStringBuffer. | +| `java.lang.String` | `getBaseName()`gets the base name of the file | +| `java.lang.String` | `getContents()`Retrieves the contents of the temporary file. | +| `java.nio.charset.Charset` | `getEncoding()`Get the encoding of the contents. | +| `java.lang.String` | `getFileExtension()`Returns the extension of the file that this object represents | +| `java.util.UUID` | `getID()`Get the ID set on this file when the contents were set. | +| `boolean` | `getIsBinary()`Tells whether or not the the file is binary. | +| `java.lang.String` | `getMimeType()` | +| `java.lang.String` | `getName()`retrieves the name of the file | +| `java.lang.String` | `getNameCoded()`retrieves the name of the file in coded form (without $variables + replaced) | +| `java.io.File` | `getTemporaryFile()`Get the current temporary file; if _needRead is true this will load the contents from the + actual file into the temporary. | +| `com.phoenix_int.util.ManagedFileHandle` | `getTemporaryFileHandle()`Get an additional reference to the temporary file containing the current value, or null if there is no temp file currently. | +| `java.lang.String` | `getURL()`Tells whether the file is meant to be transferred by proxy | +| `java.io.InputStream` | `getValueStream()`Deprecated.using toString2().getInputStream() is prefered. | +| `long` | `getValueStreamLen()`Gets the length of a stream to the temporary file contents. | +| `boolean` | `hasChanged()`Checks to see if the actual file has changed since the last time getContents() was called. | +| `void` | `markAsRead()`Call this function after you manually get the contents of the actual file. | +| `void` | `readFile()`Loads the contents of the actual file on disk into the temporary file. | +| `void` | `readFile(boolean useDFT)`Loads the contents of the actual file on disk into the temporary file. | +| `void` | `readFile(java.lang.String filename)`Sets the filename and then loads the contents of the actual file on disk into the temporary + file. | +| `void` | `removeMonitor(PHXFileMonitorfm)`Removes a file monitor from our list | +| `void` | `setBaseName(java.lang.String v)`sets the base name of the file | +| `void` | `setContents(java.io.File tempFile)`Sets the contents of the temporary file to an existing file. | +| `void` | `setContents(java.io.File tempFile, + java.util.UUID newId, + java.lang.String mimeType, + java.nio.charset.Charset encoding)`Sets the contents of the temporary file to an existing file. | +| `void` | `setContents(com.phoenix_int.util.ManagedFileHandle tempFile, + java.util.UUID newId, + java.lang.String mimeType, + java.nio.charset.Charset encoding)`Sets the contents of the temporary file to an existing ManagedFileHandle. | +| `void` | `setContents(PHXStringBuffercontents)`Sets the contents of the temporary file. | +| `void` | `setContents(java.lang.String contents)`Sets the contents of the temporary file. | +| `void` | `setFileExtension(java.lang.String extension)`Sets the extension of the file that this object represents. | +| `void` | `setIsBinary(boolean m)`Forces this file to be binary or not. | +| `void` | `setMetaData(PHXRawFilemetaData)` | +| `void` | `setMimeType(java.lang.String m)` | +| `void` | `setName(java.lang.String v)`sets the name of the file | +| `void` | `setNeedWrite(boolean needWrite)` | +| `void` | `setStringReplacer(PHXStringReplacerr)`specifies a PHXStringReplacer object for use in forming the + full file name. | +| `void` | `setURL(java.lang.String url)`sets whether the file is meant to be transferred by proxy or not | +| `boolean` | `synched()`Is this file variable's value consistent with the actual file on disk? | +| `java.util.Map` | `toAPIObject(com.phoenix_int.functional.FunctionThrows fileStore)`Convert this instance to a string-string map appropriate for serialization. | +| `void` | `toFile()`Writes from the temp file to the actual file. | +| `void` | `toFile(java.lang.String fileName)`Sets the filename and then writes from the temp file to the actual file. | +| `java.lang.String` | `toString()`converts the variable to a string | +| `PHXStringBuffer` | `toString2()`Gets a PHXStringBuffer representation of the contents of the temporary file. | +| `void` | `unmanageTempFile()`Ensure that the file containing the current contents is not deleted when the last handle to it is released. | +| `void` | `writeFile()`Writes from the temp file to the actual file. | +| `void` | `writeFile(java.lang.String fileName)`Sets the filename and then writes from the temp file to the actual file. | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXRawFile + +```java +public PHXRawFile() +``` + +- #### PHXRawFile + +```java +public PHXRawFile(java.lang.String fileName) +``` + +- #### PHXRawFile + +```java +public PHXRawFile(java.lang.String baseName, + java.lang.String name) +``` + +- #### PHXRawFile + +```java +public PHXRawFile(PHXRawFile other) +``` +Clone another PHXRawFile's value and metadata. +**Parameters:** +: `other`- the other PHXRawFile to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getName + +```java +public java.lang.String getName() +``` +retrieves the name of the file +**Returns:** +: the name of the file + +- #### getID + +```java +public java.util.UUID getID() +``` +Get the ID set on this file when the contents were set. + Reading the same contents does not guarantee that the ID will be the same. +**Returns:** +: the ID + +- #### addMonitor + +```java +public void addMonitor(PHXFileMonitor fm) +``` +PHXFileMonitor is used to monitor changes to a file + as it is being created as in the UNIX 'tail -f' + command. Unfortunately in Windows, this creates + a file lock which prevents deleting the file. + Therefore, we keep a list of all the monitors + currently monitoring us, and we signal them + anytime that our filename or base name changes + so they can stop monitoring. + +- #### removeMonitor + +```java +public void removeMonitor(PHXFileMonitor fm) +``` +Removes a file monitor from our list + +- #### synched + +```java +public boolean synched() +``` +Is this file variable's value consistent with the actual file on disk? + +- #### setNeedWrite + +```java +public void setNeedWrite(boolean needWrite) +``` + +- #### setURL + +```java +public void setURL(java.lang.String url) +``` +sets whether the file is meant to be transferred by proxy or not +**Parameters:** +: `url`- the new URL + +- #### getNameCoded + +```java +public java.lang.String getNameCoded() +``` +retrieves the name of the file in coded form (without $variables + replaced) +**Returns:** +: the name of the file in coded form + +- #### getFileExtension + +```java +public java.lang.String getFileExtension() +``` +Returns the extension of the file that this object represents + +- #### unmanageTempFile + +```java +public void unmanageTempFile() +``` +Ensure that the file containing the current contents is not deleted when the last handle to it is released. + Note that the contents can be reset by[setContents(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setContents-java.lang.String-),[setName(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setName-java.lang.String-)and[readFile(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#readFile-java.lang.String-)= + overloads. This function affects only the current contents. Once the contents are changed, they are stored in a different temp file. + That file will receive separate tracking and may be deleted unless this function is called again. + +- #### setFileExtension + +```java +public void setFileExtension(java.lang.String extension) + throws java.io.IOException +``` +Sets the extension of the file that this object represents. +It is preferred that you use setName() and let the system automatically + figure out the extension based on what you pass in. Then, you can + use readFile() and writeFile() without passing filenames to those + calls. This allows for progress monitoring to work correctly in + all cases. +**Throws:** +: `java.io.IOException` + +- #### setName + +```java +public void setName(java.lang.String v) + throws java.io.IOException +``` +sets the name of the file +**Parameters:** +: `v`- the name +**Throws:** +: `java.io.IOException` + +- #### setBaseName + +```java +public void setBaseName(java.lang.String v) + throws java.io.IOException +``` +sets the base name of the file +**Parameters:** +: `v`- the name +**Throws:** +: `java.io.IOException` + +- #### getBaseName + +```java +public java.lang.String getBaseName() +``` +gets the base name of the file +**Returns:** +: the name + +- #### setStringReplacer + +```java +public void setStringReplacer(PHXStringReplacer r) +``` +specifies a PHXStringReplacer object for use in forming the + full file name. +**Parameters:** +: `r`- the string replacer object + +- #### getIsBinary + +```java +public boolean getIsBinary() +``` +Tells whether or not the the file is binary. + Simply switches on whether or not the mime type starts + with text. + +- #### getURL + +```java +public java.lang.String getURL() +``` +Tells whether the file is meant to be transferred by proxy + +- #### setIsBinary + +```java +public void setIsBinary(boolean m) +``` +Forces this file to be binary or not. + If this causes the mode to change, will set the + mime type to text/plain or application/octet-stream + as appropriate. + +- #### getMimeType + +```java +public java.lang.String getMimeType() +``` + +- #### setMimeType + +```java +public void setMimeType(java.lang.String m) +``` + +- #### setContents + +```java +public void setContents(java.lang.String contents) + throws java.io.IOException +``` +Sets the contents of the temporary file. The actual file is not modified until the + writeFile() method is issued. Remember that when dealing with text files, setContents + handles Java style strings, which must be in bare LF, or Unix style newline format. + In binary format, setContents should be the base64 encoded data. + + The handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Parameters:** +: `contents`- the contents of the file +**Throws:** +: `java.io.IOException` + +- #### setContents + +```java +public void setContents(PHXStringBuffer contents) + throws java.io.IOException +``` +Sets the contents of the temporary file. The actual file is not modified until the + writeFile() method is issued. Remember that when dealing with text files, setContents + handles Java style strings, which must be in bare LF, or Unix style newline format. + In binary format, setContents should be the base64 encoded data. + + The handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Parameters:** +: `contents`- the contents of the file +**Throws:** +: `java.io.IOException` + +- #### setContents + +```java +public void setContents(java.io.File tempFile) +``` +Sets the contents of the temporary file to an existing file. The actual file is not modified + until the writeFile() method is issued. + + The specified file is placed into a new`ManagedFileHandle`. + + The handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Parameters:** +: `tempFile`- the temp file holding with the desired contents already on disk + +- #### setContents + +```java +public void setContents(java.io.File tempFile, + java.util.UUID newId, + java.lang.String mimeType, + java.nio.charset.Charset encoding) +``` +Sets the contents of the temporary file to an existing file. The actual file is not modified + until the writeFile() method is issued. + + The specified file is placed into a new`ManagedFileHandle`. + + The handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Parameters:** +: `tempFile`- the temp file holding with the desired contents already on disk +: `newId`- the new ID to set. + This will typically be a new UUID (you may use[setContents(java.io.File)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setContents-java.io.File-)for convenience) +: `mimeType`- the mimetype of the contents, if known (may be null) +: `encoding`- the encoding of the file, if known + +- #### setContents + +```java +public void setContents(com.phoenix_int.util.ManagedFileHandle tempFile, + java.util.UUID newId, + java.lang.String mimeType, + java.nio.charset.Charset encoding) +``` +Sets the contents of the temporary file to an existing ManagedFileHandle. The actual file is not modified + until the writeFile() method is issued. + + A new reference to the specified`ManagedFileHandle`is created. The reference is released when the instance + is closed,[deleteContents()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#deleteContents--)is called, or the contents are replaced by another[setContents(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setContents-java.lang.String-)overload. +**Parameters:** +: `tempFile`- a handle to a temporary file containing the value for the variable. + This may be null for files with no contents. +: `newId`- the new ID to set. This will typically be a new random UUID, unless these contents are being + transferred from another PHXRawFile or similar structure which has maintained the ID. +: `mimeType`- the mimetype of the contents, if known (may be null) +: `encoding`- the encoding of the contents, if known (may be null if unknown or the file is not text) + +- #### getEncoding + +```java +public java.nio.charset.Charset getEncoding() +``` +Get the encoding of the contents. + This function may return null if the encoding of the contents is unknown, + or if the contents are binary and not text-based. +**Returns:** +: the encoding of the contents, if applicable and known + +- #### getContents + +```java +public java.lang.String getContents() + throws java.io.IOException +``` +Retrieves the contents of the temporary file. If _needRead is true this will load the + contents from the actual file into the temporary file. +**Returns:** +: the contents of the file, or an empty string if no file exists. +**Throws:** +: `java.io.IOException` + +- #### getTemporaryFile + +```java +public java.io.File getTemporaryFile() + throws java.io.IOException +``` +Get the current temporary file; if _needRead is true this will load the contents from the + actual file into the temporary. +**Returns:** +: the file, or null if there are no contents +**Throws:** +: `java.io.IOException`- on error + +- #### getTemporaryFileHandle + +```java +public com.phoenix_int.util.ManagedFileHandle getTemporaryFileHandle() +``` +Get an additional reference to the temporary file containing the current value, or null if there is no temp file currently. + Note that, according to the convention for`ManagedFileHandle`, the caller receives the results of`ManagedFileHandle.createNewReference()`, and is responsible for calling`ManagedFileHandle.close()`. +**Returns:** +: an additional reference to the temporary file handle, or null if no temporary file is in use + +- #### fromFile + +```java +public void fromFile(java.lang.String filename) + throws java.io.IOException +``` +Sets the filename and then loads the contents of the actual file on disk into the temporary + file. It is preferred that you use setName() when you create a PHXRawFile and then + use readFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. + + The handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### readFile + +```java +public void readFile(java.lang.String filename) + throws java.io.IOException +``` +Sets the filename and then loads the contents of the actual file on disk into the temporary + file. It is preferred that you use setName() when you create a PHXRawFile and then + use readFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. + + The handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### fromFile + +```java +public void fromFile() + throws java.io.IOException +``` +Loads the contents of the actual file on disk into the temporary file. Functionally equivalent + to readFile(). + + The handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### readFile + +```java +public void readFile(boolean useDFT) + throws java.io.IOException +``` +Loads the contents of the actual file on disk into the temporary file. +**Parameters:** +: `useDFT`- If true, the file won't really be read but instead its + existence will be verified and a flag set. + + If the file is read, the handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### deleteFile + +```java +public void deleteFile(java.lang.String fileName) + throws java.io.IOException +``` +Deletes the actual file from disk. Does not affect the temporary file. +**Parameters:** +: `fileName`- the file to delete +**Throws:** +: `java.io.IOException` + +- #### deleteFile + +```java +public void deleteFile() +``` +Deletes the actual file from disk. Does not affect the temporary file. + +- #### deleteContents + +```java +public void deleteContents() +``` +Releases the handle to the temporary file. This may delete the file if nobody else is holding a ManagedFileHandle. + +- #### backupFile + +```java +public void backupFile(java.lang.String fileName) + throws java.io.IOException +``` +Backup the actual file on disk. File is at the same location with ".bac" + appended to the end. If a file by that name already exists, it is deleted + prior to moving. +**Parameters:** +: `fileName`- the file to backup +**Throws:** +: `java.io.IOException` + +- #### backupFile + +```java +public void backupFile() +``` +Backup the actual file on disk. File is at the same location with ".bac" + appended to the end. If a file by that name already exists, it is deleted + prior to moving. + +- #### readFile + +```java +public void readFile() + throws java.io.IOException +``` +Loads the contents of the actual file on disk into the temporary file. + + If the file is read, the handle to the previous contents is released, + potentially deleting it if no other references are being held. + Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### markAsRead + +```java +public void markAsRead() +``` +Call this function after you manually get the contents of the actual file. The function + records it's name and timestamp for use with the hasChanged() function. + +- #### hasChanged + +```java +public boolean hasChanged() +``` +Checks to see if the actual file has changed since the last time getContents() was called. +**Returns:** +: true if the timestamp of the file is new, or if the file name has changed + +- #### toFile + +```java +public void toFile(java.lang.String fileName) + throws java.io.IOException +``` +Sets the filename and then writes from the temp file to the actual file. It is preferred + that you use setName() when you create a PHXRawFile and then + use writeFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### writeFile + +```java +public void writeFile(java.lang.String fileName) + throws java.io.IOException +``` +Sets the filename and then writes from the temp file to the actual file. It is preferred + that you use setName() when you create a PHXRawFile and then + use writeFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### toFile + +```java +public void toFile() + throws java.io.IOException +``` +Writes from the temp file to the actual file. +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### writeFile + +```java +public void writeFile() + throws java.io.IOException +``` +Writes from the temp file to the actual file. +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### getValueStreamLen + +```java +public long getValueStreamLen() + throws java.io.IOException +``` +Gets the length of a stream to the temporary file contents. +**Returns:** +: The length of a stream returned by the getValueStream method. +**Throws:** +: `java.io.IOException` + +- #### getValueStream + +```java +@Deprecated +public java.io.InputStream getValueStream() + throws java.io.IOException +``` +Deprecated.using toString2().getInputStream() is prefered.Gets an InputStream to the working contents of the file. Reads the contents from the actual + file into the temp file if necessary. +**Returns:** +: An InputStream to the file contents, encoded in Base64. +**Throws:** +: `java.io.IOException`- thrown if the file can't be read. + +- #### toString2 + +```java +public PHXStringBuffer toString2() + throws java.io.IOException +``` +Gets a PHXStringBuffer representation of the contents of the temporary file. +**Specified by:** +: `toString2`in interface`IPHXType2` +**Returns:** +: PHXStringBuffer representation of the type +**Throws:** +: `java.io.IOException` + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer newContents) + throws java.io.IOException, + PHXGetByUrlException +``` +Sets the file temporary file contents to the value of the PHXStringBuffer. +**Specified by:** +: `fromString2`in interface`IPHXType2` +**Parameters:** +: `newContents`- the new contents of the file +**Throws:** +: `java.io.IOException` +: `PHXGetByUrlException` + +- #### toAPIObject + +```java +public  java.util.Map toAPIObject(com.phoenix_int.functional.FunctionThrows fileStore) + throws EX extends java.lang.Throwable, + java.io.IOException +``` +Convert this instance to a string-string map appropriate for serialization. +**Type Parameters:** +: `EX`- the type of exception thrown by the file-store function +**Parameters:** +: `fileStore`- a file-store function that may be used to capture the file value out-of-band. +**Returns:** +: a map that is appropriate for serialization +**Throws:** +: `java.io.IOException`- if a delayed DFT read occurs and causes an exception +: `EX`- when thrown by the file-store function +: `EX extends java.lang.Throwable` + +- #### fromAPIObject + +```java +public  void fromAPIObject(java.util.Map object, + com.phoenix_int.functional.FunctionThrows fileStore) + throws EX extends java.lang.Throwable +``` +Populate this instance from a string-string map. +**Type Parameters:** +: `EX`- the type of exception thrown by the file-store function +**Parameters:** +: `object`- the string-string map. +: `fileStore`- a function that can reverse the storage used when the original object was serialized. + Note that, according to the convention for`ManagedFileHandle`, this function ([fromAPIObject(java.util.Map, com.phoenix_int.functional.FunctionThrows)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#fromAPIObject-java.util.Map-com.phoenix_int.functional.FunctionThrows-)) becomes + responsible for closing the returned handle. +**Throws:** +: `EX`- when thrown by the file-store function +: `EX extends java.lang.Throwable` + +- #### toString + +```java +public java.lang.String toString() +``` +converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +Sets the file temporary file contents to the value of the string. +**Specified by:** +: `fromString`in interface`IPHXType` +**Parameters:** +: `value`- the value to use + +- #### setMetaData + +```java +public void setMetaData(PHXRawFile metaData) +``` + +- #### finalize + +```java +protected void finalize() + throws java.lang.Throwable +``` +Although close should be called manually before garbage collection, do so here as a backup. + Note that Java makes no guarantee that any object is ever actually garbage collected; + if the JVM exits without running GC and picking up this object, the finalizer will never be called. + We cannot rely on Java GC as a defense against leaking PHXRawFile objects. +**Overrides:** +: `finalize`in class`java.lang.Object` +**Throws:** +: `java.lang.Throwable` + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### _setContentFromOther + +```java +protected final void _setContentFromOther(PHXRawFile variable) +``` + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Specified by:** +: `Accept`in interface`IPHXType2` +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### close + +```java +public void close() +``` + +**Specified by:** +: `close`in interface`java.lang.AutoCloseable` + +- #### createCopy + +```java +public PHXRawFile createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md new file mode 100644 index 0000000000..a7731dc17b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md @@ -0,0 +1,984 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXRawFileArray +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) +- - com.phoenix_int.aserver.types.PHXRawFileArray +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable + +--- + +```java +public class PHXRawFileArray +extends PHXSimpleArray +``` +Wraps an array of PHXRawFile variables + for the ScriptWrapper utility. +**Version:** +: June 23, 2010 +**Author:** +: jdaley +**See Also:** +: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +=========== FIELD SUMMARY =========== +- ### Field Summary + +- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data,_lockDims,_lockResize` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXRawFileArray()` | +| `PHXRawFileArray(java.lang.Object data)` | +| `PHXRawFileArray(PHXRawFileArrayother)`Clone another PHXRawFileArray's value and metadata. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. | +| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data + in this object. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | +| `PHXRawFileArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified + class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromFile(int index)`loads the file from disk for an element of an 1D array. | +| `void` | `fromFile(int[] index)`loads the file from disk for an element of an array. | +| `void` | `fromFile(int[] index, + java.lang.String fileName)`Sets the filename and then reads from disk for an element of an array. | +| `void` | `fromFile(int index, + java.lang.String fileName)`Sets the filename and then reads from disk for an element of an 1D array. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(int[] index, + java.lang.String value)`converts a String representation to the internal value + for an element of an array | +| `void` | `fromString(int index, + java.lang.String value)`converts a String representation to the internal value + for an element of an 1D array | +| `java.lang.String` | `getBaseName()`gets the base name of the files stored in the array | +| `java.lang.String` | `getContents(int index)`retrieves the contents of the file for an element of an 1D array | +| `java.lang.String` | `getContents(int[] index)`retrieves the contents of the file for an element of an array | +| `java.lang.String` | `getFileExtension(int index)`Returns the extension of the file for an element of an 1D array | +| `java.lang.String` | `getFileExtension(int[] index)`Returns the extension of the file for an element of an array | +| `boolean` | `getIsBinary()`Tells whether or not the array contains binary files or not. | +| `java.lang.String` | `getMimeType()`get mime type of the files in the array + Currently all elements of an array should have + the same mime type. | +| `java.lang.String` | `getName(int index)`retrieves the name of the file for an element of an 1D array | +| `java.lang.String` | `getName(int[] index)`retrieves the name of the file for an element of an array | +| `java.lang.String` | `getNameCoded(int index)`retrieves the name of the file in coded form (without $variables + replaced) for an element of an 1D array | +| `java.lang.String` | `getNameCoded(int[] index)`retrieves the name of the file in coded form (without $variables + replaced) for an element of an array | +| `java.lang.String[]` | `getNames()`get file names of the elements as an array | +| `java.lang.String[]` | `getNamesCoded()`get coded file names of the elements as an array | +| `java.lang.String` | `getNamesCodedString()`get coded file names of the elements as a comma separated string | +| `java.lang.String` | `getNamesString()`get file names as a comma separated list | +| `java.lang.String[]` | `getURLs()`get URLs of the elements as an array | +| `java.lang.String` | `getURLsString()`get URLs of the elements as a comma separated string | +| `PHXRawFile` | `getValue(int index)`a utility function to return the internal PHXRawFile + that represents the array element for the 1D array. | +| `PHXRawFile` | `getValue(int[] index)`a utility function to return the internal PHXRawFile + that represents the array element for the array. | +| `boolean` | `hasChanged(int index)`checks to see if the file has changed since the last time + getContents() was called for an element of an 1D array | +| `boolean` | `hasChanged(int[] index)`checks to see if the file has changed since the last time + getContents() was called for an element of an array | +| `void` | `markAsRead(int index)`set markAsRead flag for an element for an 1D array + call this function after you manually get the contents of the + file. | +| `void` | `markAsRead(int[] index)`set markAsRead flag for an element for an array + call this function after you manually get the contents of the + file. | +| `void` | `readFile(int index)`loads the file from disk for an element of an 1D array. | +| `void` | `readFile(int[] index)`loads the file from disk for an element of an array. | +| `void` | `setBaseName(java.lang.String name)`sets the base name of files for this array | +| `void` | `setContents(int[] index, + java.lang.String contents)`sets the contents of the file for an array element for an array. | +| `void` | `setContents(int index, + java.lang.String contents)`sets the contents of the file for an array element for an 1D array. | +| `void` | `setFileExtension(int[] index, + java.lang.String extension)`Sets the extension of the file for an element of an array | +| `void` | `setFileExtension(int index, + java.lang.String extension)`Sets the extension of the file for an element of an 1D array | +| `void` | `setIsBinary(boolean value)`Forces elements of this array to be binary or not. | +| `void` | `setMimeType(java.lang.String value)`Set mime type the array + Currently all elements of an array should have + the same mime type. | +| `void` | `setName(int[] index, + java.lang.String name)`sets the name of the file for an element of an array | +| `void` | `setName(int index, + java.lang.String name)`sets the name of the file for an element of an 1D array | +| `void` | `setValue(int[] index,PHXRawFileval)`a utility function to set the internal PHXRawFile + that represents the array element for the array. | +| `void` | `setValue(int[] index,PHXSimpleTypeval)`Sets an element as an object of the appropriate PHXSimpleType + Must be overridden in subclasses | +| `void` | `setValue(int[] index, + java.lang.String val)`a utility function to set the value of an array element for the 1D array. | +| `void` | `setValue(int index,PHXRawFileval)`a utility function to set the internal PHXRawFile + that represents the array element for the 1D array. | +| `void` | `setValue(int index, + java.lang.String val)`a utility function to set the value of an array element for the 1D array. | +| `void` | `toFile(int index)`writes the file to disk for an element of an 1D array | +| `void` | `toFile(int[] index)`writes the file to disk for an element of an array | +| `void` | `toFile(int[] index, + java.lang.String fileName)`sets the filename and then writes the file to disk for an element of + an array. | +| `void` | `toFile(int index, + java.lang.String fileName)`sets the filename and then writes the file to disk for an element of + an 1D array. | +| `java.lang.String` | `toString(int index)`converts an element of the 1D array to a string | +| `java.lang.String` | `toString(int[] index)`converts an element of the array to a string | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData,_setMetaData,checkRectangular,copy,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString2,toString2,toString2,validElement` + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +- ### Methods inherited from interface java.lang.Iterable +`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXRawFileArray + +```java +public PHXRawFileArray() +``` + +- #### PHXRawFileArray + +```java +public PHXRawFileArray(java.lang.Object data) +``` + +- #### PHXRawFileArray + +```java +public PHXRawFileArray(PHXRawFileArray other) +``` +Clone another PHXRawFileArray's value and metadata. +**Parameters:** +: `other`- the other PHXRawFileArray to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getName + +```java +public java.lang.String getName(int index) +``` +retrieves the name of the file for an element of an 1D array +**Parameters:** +: `index`- array index +**Returns:** +: the name of the file + +- #### getName + +```java +public java.lang.String getName(int[] index) +``` +retrieves the name of the file for an element of an array +**Parameters:** +: `index`- array index +**Returns:** +: the name of the file + +- #### getNameCoded + +```java +public java.lang.String getNameCoded(int index) +``` +retrieves the name of the file in coded form (without $variables + replaced) for an element of an 1D array +**Parameters:** +: `index`- array index +**Returns:** +: the name of the file in coded form + +- #### getNameCoded + +```java +public java.lang.String getNameCoded(int[] index) +``` +retrieves the name of the file in coded form (without $variables + replaced) for an element of an array +**Parameters:** +: `index`- array index +**Returns:** +: the name of the file in coded form + +- #### getFileExtension + +```java +public java.lang.String getFileExtension(int index) +``` +Returns the extension of the file for an element of an 1D array +**Parameters:** +: `index`- array index +**Returns:** +: extension + +- #### getFileExtension + +```java +public java.lang.String getFileExtension(int[] index) +``` +Returns the extension of the file for an element of an array +**Parameters:** +: `index`- array index +**Returns:** +: extension + +- #### setFileExtension + +```java +public void setFileExtension(int index, + java.lang.String extension) + throws java.io.IOException +``` +Sets the extension of the file for an element of an 1D array +It is preferred that you use setName() and let the system automatically + figure out the extension based on what you pass in. Then, you can + use readFile() and writeFile() without passing filenames to those + calls. This allows for progress monitoring to work correctly in + all cases. +**Parameters:** +: `index`- array index +: `extension`- file extension +**Throws:** +: `java.io.IOException` + +- #### setFileExtension + +```java +public void setFileExtension(int[] index, + java.lang.String extension) + throws java.io.IOException +``` +Sets the extension of the file for an element of an array +It is preferred that you use setName() and let the system automatically + figure out the extension based on what you pass in. Then, you can + use readFile() and writeFile() without passing filenames to those + calls. This allows for progress monitoring to work correctly in + all cases. +**Parameters:** +: `index`- array index +: `extension`- file extension +**Throws:** +: `java.io.IOException` + +- #### setName + +```java +public void setName(int index, + java.lang.String name) + throws java.io.IOException +``` +sets the name of the file for an element of an 1D array +**Parameters:** +: `index`- array index +: `name`- file name +**Throws:** +: `java.io.IOException` + +- #### setName + +```java +public void setName(int[] index, + java.lang.String name) + throws java.io.IOException +``` +sets the name of the file for an element of an array +**Parameters:** +: `index`- array index +: `name`- file name +**Throws:** +: `java.io.IOException` + +- #### setBaseName + +```java +public void setBaseName(java.lang.String name) + throws java.io.IOException +``` +sets the base name of files for this array +**Parameters:** +: `name`- base name +**Throws:** +: `java.io.IOException` + +- #### getBaseName + +```java +public java.lang.String getBaseName() +``` +gets the base name of the files stored in the array +**Returns:** +: the name + +- #### getIsBinary + +```java +public boolean getIsBinary() +``` +Tells whether or not the array contains binary files or not. + Simply switches on whether or not the mime type starts + with text. Currently all elements of an array should have + the same binaryness. +**Returns:** +: true if the file is binary + +- #### setIsBinary + +```java +public void setIsBinary(boolean value) +``` +Forces elements of this array to be binary or not. + If this causes the mode to change, will set the + mime type to text/plain or application/octet-stream + as appropriate. Currently all elements of an array should have + the same binaryness. +**Parameters:** +: `value`- the value to set + +- #### getMimeType + +```java +public java.lang.String getMimeType() +``` +get mime type of the files in the array + Currently all elements of an array should have + the same mime type. +**Returns:** +: mime type + +- #### setMimeType + +```java +public void setMimeType(java.lang.String value) +``` +Set mime type the array + Currently all elements of an array should have + the same mime type. +**Parameters:** +: `value`- the mimeType mime type + +- #### getNames + +```java +public java.lang.String[] getNames() +``` +get file names of the elements as an array +**Returns:** +: list of file names + +- #### getNamesString + +```java +public java.lang.String getNamesString() +``` +get file names as a comma separated list +**Returns:** +: list of file names + +- #### getNamesCoded + +```java +public java.lang.String[] getNamesCoded() +``` +get coded file names of the elements as an array +**Returns:** +: list of coded file names + +- #### getNamesCodedString + +```java +public java.lang.String getNamesCodedString() +``` +get coded file names of the elements as a comma separated string +**Returns:** +: list of coded file names + +- #### getURLs + +```java +public java.lang.String[] getURLs() +``` +get URLs of the elements as an array +**Returns:** +: list of file URLs + +- #### getURLsString + +```java +public java.lang.String getURLsString() +``` +get URLs of the elements as a comma separated string +**Returns:** +: list of file URLs + +- #### setContents + +```java +public void setContents(int index, + java.lang.String contents) + throws java.io.IOException +``` +sets the contents of the file for an array element for an 1D array. + The actual file is not modified until the writeFile() method + is issued. + Remember that when dealing with text files, + setContents handles Java style strings, which + must be in bare LF, or Unix style newline format. + In binary format, setContents should be the + base64 encoded data. +**Parameters:** +: `index`- array index +: `contents`- the contents of the file +**Throws:** +: `java.io.IOException` + +- #### setContents + +```java +public void setContents(int[] index, + java.lang.String contents) + throws java.io.IOException +``` +sets the contents of the file for an array element for an array. + The actual file is not modified until the writeFile() method + is issued. + Remember that when dealing with text files, + setContents handles Java style strings, which + must be in bare LF, or Unix style newline format. + In binary format, setContents should be the + base64 encoded data. +**Parameters:** +: `index`- array index +: `contents`- the contents of the file +**Throws:** +: `java.io.IOException` + +- #### getContents + +```java +public java.lang.String getContents(int index) + throws java.lang.Exception +``` +retrieves the contents of the file for an element of an 1D array +**Parameters:** +: `index`- array index +**Returns:** +: the contents of the file +**Throws:** +: `java.lang.Exception` + +- #### getContents + +```java +public java.lang.String getContents(int[] index) + throws java.io.IOException +``` +retrieves the contents of the file for an element of an array +**Parameters:** +: `index`- array index +**Returns:** +: the contents of the file +**Throws:** +: `java.io.IOException` + +- #### fromFile + +```java +public void fromFile(int index) + throws java.io.IOException +``` +loads the file from disk for an element of an 1D array. +**Parameters:** +: `index`- array index +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### fromFile + +```java +public void fromFile(int[] index) + throws java.io.IOException +``` +loads the file from disk for an element of an array. +**Parameters:** +: `index`- array index +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### readFile + +```java +public void readFile(int index) + throws java.io.IOException +``` +loads the file from disk for an element of an 1D array. +**Parameters:** +: `index`- array index +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### readFile + +```java +public void readFile(int[] index) + throws java.io.IOException +``` +loads the file from disk for an element of an array. +**Parameters:** +: `index`- array index +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### fromFile + +```java +public void fromFile(int index, + java.lang.String fileName) + throws java.io.IOException +``` +Sets the filename and then reads from disk for an element of an 1D array. + It is preferred that you use setName() when you create a PHXRawFile and then + use readFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. +**Parameters:** +: `index`- array index +: `fileName`- file name +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### fromFile + +```java +public void fromFile(int[] index, + java.lang.String fileName) + throws java.io.IOException +``` +Sets the filename and then reads from disk for an element of an array. + It is preferred that you use setName() when you create a PHXRawFile and then + use readFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. +**Parameters:** +: `index`- array index +: `fileName`- file name +**Throws:** +: `java.io.IOException`- thrown if the file can't be loaded. + +- #### markAsRead + +```java +public void markAsRead(int index) +``` +set markAsRead flag for an element for an 1D array + call this function after you manually get the contents of the + file. The function records it's name and timestamp for use with + the hasChanged() function +**Parameters:** +: `index`- array index + +- #### markAsRead + +```java +public void markAsRead(int[] index) +``` +set markAsRead flag for an element for an array + call this function after you manually get the contents of the + file. The function records it's name and timestamp for use with + the hasChanged() function +**Parameters:** +: `index`- array index + +- #### hasChanged + +```java +public boolean hasChanged(int index) +``` +checks to see if the file has changed since the last time + getContents() was called for an element of an 1D array +**Parameters:** +: `index`- array index +**Returns:** +: true if the timestamp of the file is new, or if the + file name has changed + +- #### hasChanged + +```java +public boolean hasChanged(int[] index) +``` +checks to see if the file has changed since the last time + getContents() was called for an element of an array +**Parameters:** +: `index`- array index +**Returns:** +: true if the timestamp of the file is new, or if the + file name has changed + +- #### toFile + +```java +public void toFile(int index, + java.lang.String fileName) + throws java.io.IOException +``` +sets the filename and then writes the file to disk for an element of + an 1D array. It is preferred + that you use setName() when you create a PHXRawFile and then + use writeFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. +**Parameters:** +: `index`- array index +: `fileName`- name of the file to write +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### toFile + +```java +public void toFile(int[] index, + java.lang.String fileName) + throws java.io.IOException +``` +sets the filename and then writes the file to disk for an element of + an array. It is preferred + that you use setName() when you create a PHXRawFile and then + use writeFile() without passing a filename to it. This allows + progress monitoring to work correctly in all cases. +**Parameters:** +: `index`- array index +: `fileName`- name of the file to write +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### toFile + +```java +public void toFile(int index) + throws java.io.IOException +``` +writes the file to disk for an element of an 1D array +**Parameters:** +: `index`- array index +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### toFile + +```java +public void toFile(int[] index) + throws java.io.IOException +``` +writes the file to disk for an element of an array +**Parameters:** +: `index`- array index +**Throws:** +: `java.io.IOException`- thrown if the file can't be written. + +- #### toString + +```java +public java.lang.String toString(int index) +``` +converts an element of the 1D array to a string +**Overrides:** +: `toString`in class`PHXSimpleArray` +**Parameters:** +: `index`- array index +**Returns:** +: a String representation of the variable + +- #### toString + +```java +public java.lang.String toString(int[] index) +``` +converts an element of the array to a string +**Overrides:** +: `toString`in class`PHXSimpleArray` +**Parameters:** +: `index`- array index +**Returns:** +: a String representation of the variable + +- #### fromString + +```java +public void fromString(int index, + java.lang.String value) +``` +converts a String representation to the internal value + for an element of an 1D array +**Overrides:** +: `fromString`in class`PHXSimpleArray` +**Parameters:** +: `index`- array index +: `value`- the value to convert + +- #### fromString + +```java +public void fromString(int[] index, + java.lang.String value) +``` +converts a String representation to the internal value + for an element of an array +**Overrides:** +: `fromString`in class`PHXSimpleArray` +**Parameters:** +: `index`- array index +: `value`- the value to convert + +- #### getValue + +```java +public PHXRawFile getValue(int index) +``` +a utility function to return the internal PHXRawFile + that represents the array element for the 1D array. +**Overrides:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- array index +**Returns:** +: array element + +- #### getValue + +```java +public PHXRawFile getValue(int[] index) +``` +a utility function to return the internal PHXRawFile + that represents the array element for the array. +**Specified by:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- array index +**Returns:** +: array element + +- #### setValue + +```java +public void setValue(int index, + PHXRawFile val) +``` +a utility function to set the internal PHXRawFile + that represents the array element for the 1D array. +**Parameters:** +: `index`- array index +: `val`- array element to set + +- #### setValue + +```java +public void setValue(int[] index, + PHXRawFile val) +``` +a utility function to set the internal PHXRawFile + that represents the array element for the array. +**Parameters:** +: `index`- array index +: `val`- array element to set + +- #### setValue + +```java +public void setValue(int index, + java.lang.String val) + throws java.io.IOException +``` +a utility function to set the value of an array element for the 1D array. + This is a synomym of setContent(). +**Parameters:** +: `index`- array index +: `val`- value to set +**Throws:** +: `java.io.IOException` + +- #### setValue + +```java +public void setValue(int[] index, + java.lang.String val) + throws java.io.IOException +``` +a utility function to set the value of an array element for the 1D array. + This is a synomym of setContent(). +**Parameters:** +: `index`- array index +: `val`- value to set +**Throws:** +: `java.io.IOException` + +- #### dataTypeOK + +```java +protected boolean dataTypeOK(java.lang.Class c) +``` +Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified + class is acceptable as an array element component type. +**Specified by:** +: `dataTypeOK`in class`PHXSimpleArray` + +- #### elementFromString + +```java +protected java.lang.Object elementFromString(java.lang.String val) +``` +Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. This is only used when the element type does not + implement IPHXType or IPHXType2. For primitives, return + the wrapper objects. +**Specified by:** +: `elementFromString`in class`PHXSimpleArray` + +- #### _getMetaData + +```java +protected void _getMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. Override this in order to add + more custom meta data in sub-classes. Be sure to cal + super._getMetaData(PHXSimpleType), though! +**Overrides:** +: `_getMetaData`in class`PHXSimpleArray` + +- #### _setMetaData + +```java +protected void _setMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data + in this object. Override this to set additional + information in sub-classes. Be sure to call + super._setMetaData(PHXSimpleType) +**Overrides:** +: `_setMetaData`in class`PHXSimpleArray` + +- #### allocateElement + +```java +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Allocates a single element in a default state. + This overrides allocateElement to set the common metadata + for the newly created element +**Overrides:** +: `allocateElement`in class`PHXSimpleArray` +**Throws:** +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. + + Array comparison is handled as follows: + 1) Compare the number of dimensions between the two arrays + 2) Compare the length of dimensions between the two arrays + 3) Compare the values in each of the two arrays + Iff these three conditions are met, the two arrays are considered naturally equal. +**Overrides:** +: `equalsNatural`in class`PHXSimpleArray` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### setValue + +```java +public void setValue(int[] index, + PHXSimpleType val) +``` +Sets an element as an object of the appropriate PHXSimpleType + Must be overridden in subclasses +**Specified by:** +: `setValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- nD array index +: `val`- value to set + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXRawFileArray createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md new file mode 100644 index 0000000000..2e1aa6aa3a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md @@ -0,0 +1,197 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXRefArrayProperty +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXRefArrayProperty +- **All Implemented Interfaces:** +: [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html),[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) + +--- + +```java +public class PHXRefArrayProperty +extends java.lang.Object +implements IPHXRefPropInfo +``` +This is a class for holding properties of a reference + object +- **type**: String +- **enumValues**: String[] +- **description**: String +- **title**: String +- **input**: boolean +where type may be any of the following: +- "long" +- "double" +- "boolean" +- "string" +**Author:** +: Woyak- ========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `enumValuesFromString(java.lang.String enumValues)`sets the enum values from a comma-separated list of values | +| `java.lang.String` | `getDescription()`retrieves a description of the ref prop | +| `java.lang.String[]` | `getEnumValues()`lists enum values | +| `boolean` | `getInput()`retrieves an indicator of whether the ref prop is an input + or an output. | +| `java.lang.String` | `getName()`retrieves the name of the variable | +| `java.lang.String` | `getTitle()`retrieves a title of the ref prop. | +| `java.lang.String` | `getType()`retrieves the current type of the variable | +| `java.lang.String` | `getValues(int index)`gets the value at an index | +| `void` | `setDescription(java.lang.String value)`sets a description of the ref prop | +| `void` | `setEnumValues(java.lang.String[] enumValues)`sets the enum values | +| `void` | `setInput(boolean value)`sets an indicator for the ref prop | +| `void` | `setTitle(java.lang.String value)`sets a title of the ref prop | +| `void` | `setValues(int index, + java.lang.String v)`sets the value for the variable | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ METHOD DETAIL ========== +- ### Method Detail + +- #### getName + +```java +public java.lang.String getName() +``` +retrieves the name of the variable +**Specified by:** +: `getName`in interface`IPHXRefPropInfo` +**Returns:** +: the name of the variable + +- #### getDescription + +```java +public java.lang.String getDescription() +``` +retrieves a description of the ref prop +**Specified by:** +: `getDescription`in interface`IPHXDescription` +**Returns:** +: a description of the ref prop + +- #### setDescription + +```java +public void setDescription(java.lang.String value) +``` +sets a description of the ref prop +**Specified by:** +: `setDescription`in interface`IPHXDescription` +**Parameters:** +: `value`- a description of the ref prop + +- #### getTitle + +```java +public java.lang.String getTitle() +``` +retrieves a title of the ref prop. Used by ModelCenter when + displaying the variable in certain dialogs +**Specified by:** +: `getTitle`in interface`IPHXRefPropInfo` +**Returns:** +: a title for the ref prop + +- #### setTitle + +```java +public void setTitle(java.lang.String value) +``` +sets a title of the ref prop +**Specified by:** +: `setTitle`in interface`IPHXRefPropInfo` +**Parameters:** +: `value`- a title for the ref prop + +- #### getInput + +```java +public boolean getInput() +``` +retrieves an indicator of whether the ref prop is an input + or an output. If it's an output, the driver component + will calculate a value for it. +**Specified by:** +: `getInput`in interface`IPHXRefPropInfo` +**Returns:** +: an indicator if the ref prop is an input + +- #### setInput + +```java +public void setInput(boolean value) +``` +sets an indicator for the ref prop +**Specified by:** +: `setInput`in interface`IPHXRefPropInfo` +**Parameters:** +: `value`- an indicator for the ref prop + +- #### getValues + +```java +public java.lang.String getValues(int index) +``` +gets the value at an index +**Parameters:** +: `index`- the desired index + +- #### setValues + +```java +public void setValues(int index, + java.lang.String v) +``` +sets the value for the variable +**Parameters:** +: `v`- the value + +- #### getType + +```java +public java.lang.String getType() +``` +retrieves the current type of the variable +**Specified by:** +: `getType`in interface`IPHXRefPropInfo` +**Returns:** +: the value of the variable + +- #### getEnumValues + +```java +public java.lang.String[] getEnumValues() +``` +lists enum values +**Specified by:** +: `getEnumValues`in interface`IPHXRefPropInfo` +**Returns:** +: enum values + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String[] enumValues) +``` +sets the enum values +**Specified by:** +: `setEnumValues`in interface`IPHXRefPropInfo` +**Parameters:** +: `enumValues`- an array enum values + +- #### enumValuesFromString + +```java +public void enumValuesFromString(java.lang.String enumValues) +``` +sets the enum values from a comma-separated list of values +**Specified by:** +: `enumValuesFromString`in interface`IPHXRefPropInfo` +**Parameters:** +: `enumValues`- a comma-separated list of values +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md new file mode 100644 index 0000000000..0bd08be767 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md @@ -0,0 +1,219 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXRefProperty +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXRefProperty +- **All Implemented Interfaces:** +: [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html),[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) + +--- + +```java +public class PHXRefProperty +extends java.lang.Object +implements IPHXRefPropInfo +``` +This is a class for holding properties of a reference + object +- **type**: String +- **enumValues**: String[] +- **description**: String +- **title**: String +- **input**: boolean +where type may be any of the following: +- "long" +- "double" +- "boolean" +- "string" +**Author:** +: Woyak- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXRefProperty(java.lang.String name, + java.lang.String type)`constructor | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `void` | `enumValuesFromString(java.lang.String enumValues)`sets the enum values from a comma-separated list of values | +| `java.lang.String` | `getDescription()`retrieves a description of the ref prop | +| `java.lang.String[]` | `getEnumValues()`lists enum values | +| `boolean` | `getInput()`retrieves an indicator of whether the ref prop is an input + or an output. | +| `java.lang.String` | `getName()`retrieves the name of the variable | +| `java.lang.String` | `getTitle()`retrieves a title of the ref prop. | +| `java.lang.String` | `getType()`retrieves the current type of the variable | +| `java.lang.String` | `getValue()`retrieves the current value of the variable | +| `void` | `setDescription(java.lang.String value)`sets a description of the ref prop | +| `void` | `setEnumValues(java.lang.String[] enumValues)`sets the enum values | +| `void` | `setInput(boolean value)`sets an indicator for the ref prop | +| `void` | `setTitle(java.lang.String value)`sets a title of the ref prop | +| `void` | `setValue(java.lang.String v)`sets the value for the variable | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXRefProperty + +```java +public PHXRefProperty(java.lang.String name, + java.lang.String type) +``` +constructor +**Parameters:** +: `name`- the name of the property +: `type`- the type of the property +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getName + +```java +public java.lang.String getName() +``` +retrieves the name of the variable +**Specified by:** +: `getName`in interface`IPHXRefPropInfo` +**Returns:** +: the name of the variable + +- #### getDescription + +```java +public java.lang.String getDescription() +``` +retrieves a description of the ref prop +**Specified by:** +: `getDescription`in interface`IPHXDescription` +**Returns:** +: a description of the ref prop + +- #### setDescription + +```java +public void setDescription(java.lang.String value) +``` +sets a description of the ref prop +**Specified by:** +: `setDescription`in interface`IPHXDescription` +**Parameters:** +: `value`- a description of the ref prop + +- #### getTitle + +```java +public java.lang.String getTitle() +``` +retrieves a title of the ref prop. Used by ModelCenter when + displaying the variable in certain dialogs +**Specified by:** +: `getTitle`in interface`IPHXRefPropInfo` +**Returns:** +: a title for the ref prop + +- #### setTitle + +```java +public void setTitle(java.lang.String value) +``` +sets a title of the ref prop +**Specified by:** +: `setTitle`in interface`IPHXRefPropInfo` +**Parameters:** +: `value`- a title for the ref prop + +- #### getInput + +```java +public boolean getInput() +``` +retrieves an indicator of whether the ref prop is an input + or an output. If it's an output, the driver component + will calculate a value for it. +**Specified by:** +: `getInput`in interface`IPHXRefPropInfo` +**Returns:** +: an indicator if the ref prop is an input + +- #### setInput + +```java +public void setInput(boolean value) +``` +sets an indicator for the ref prop +**Specified by:** +: `setInput`in interface`IPHXRefPropInfo` +**Parameters:** +: `value`- an indicator for the ref prop + +- #### getValue + +```java +public java.lang.String getValue() + throws PHXTypeMismatchException +``` +retrieves the current value of the variable +**Returns:** +: the value of the variable +**Throws:** +: `PHXTypeMismatchException` + +- #### setValue + +```java +public void setValue(java.lang.String v) +``` +sets the value for the variable +**Parameters:** +: `v`- the value + +- #### getType + +```java +public java.lang.String getType() +``` +retrieves the current type of the variable +**Specified by:** +: `getType`in interface`IPHXRefPropInfo` +**Returns:** +: the value of the variable + +- #### getEnumValues + +```java +public java.lang.String[] getEnumValues() +``` +lists enum values +**Specified by:** +: `getEnumValues`in interface`IPHXRefPropInfo` +**Returns:** +: enum values + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String[] enumValues) +``` +sets the enum values +**Specified by:** +: `setEnumValues`in interface`IPHXRefPropInfo` +**Parameters:** +: `enumValues`- an array enum values + +- #### enumValuesFromString + +```java +public void enumValuesFromString(java.lang.String enumValues) +``` +sets the enum values from a comma-separated list of values +**Specified by:** +: `enumValuesFromString`in interface`IPHXRefPropInfo` +**Parameters:** +: `enumValues`- a comma-separated list of values +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md new file mode 100644 index 0000000000..23923e2af7 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md @@ -0,0 +1,321 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXReference +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXReference +- **All Implemented Interfaces:** +: [IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) + +--- + +```java +public class PHXReference +extends java.lang.Object +implements IPHXAlwaysWriteable, IPHXType2 +``` +The Phoenix type for references. This class matches up to + references in ModelCenter. Users may define their own + properties in addition to the value property. +- **value**: double +- **properties**: PHXRefProperty[] +- **reference**: String +**Author:** +: Woyak- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXReference()`constructor | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `PHXRefProperty` | `_getProperty(java.lang.String name)`retrieves a named property | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `IPHXRefPropInfo` | `createRefProp(java.lang.String name, + java.lang.String type)`adds a property to the variable | +| `void` | `fromString(java.lang.String s)`converts from a string | +| `void` | `fromString2(PHXStringBuffers)`converts from a PHXStringBuffer | +| `java.lang.String` | `getDescription()` | +| `PHXRefProperty[]` | `getProperties()`retrieves the properties of the variable | +| `java.lang.String` | `getReference()`retrieves the current reference string. | +| `boolean` | `getRefPropValueBoolean(java.lang.String name)` | +| `double` | `getRefPropValueDouble(java.lang.String name)`gets a value for a ref prop | +| `long` | `getRefPropValueLong(java.lang.String name)` | +| `java.lang.String` | `getRefPropValueString(java.lang.String name)` | +| `double` | `getValue()`retrieves the current value of the variable | +| `void` | `setDescription(java.lang.String desc)` | +| `void` | `setProperties(PHXRefProperty[] v)` | +| `void` | `setReference(java.lang.String ref)`sets the value for the reference string. | +| `void` | `setRefPropValue(java.lang.String name, + boolean value)` | +| `void` | `setRefPropValue(java.lang.String name, + double value)`sets a value for a ref prop | +| `void` | `setRefPropValue(java.lang.String name, + long value)` | +| `void` | `setRefPropValue(java.lang.String name, + java.lang.String value)` | +| `void` | `setValue(double v)`sets the value for the variable | +| `java.lang.String` | `toString()`converts to a string | +| `PHXStringBuffer` | `toString2()`converts to a PHXStringBuffer | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXReference + +```java +public PHXReference() +``` +constructor +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getValue + +```java +public double getValue() +``` +retrieves the current value of the variable +**Returns:** +: the value of the variable + +- #### setValue + +```java +public void setValue(double v) +``` +sets the value for the variable +**Parameters:** +: `v`- the value + +- #### getReference + +```java +public java.lang.String getReference() +``` +retrieves the current reference string. This is a client-supplied + value describing what the reference value points to. +**Returns:** +: the reference string + +- #### setReference + +```java +public void setReference(java.lang.String ref) +``` +sets the value for the reference string. This should only be + called by the client application, e.g. ModelCenter. +**Parameters:** +: `ref`- the reference string + +- #### getProperties + +```java +public PHXRefProperty[] getProperties() +``` +retrieves the properties of the variable +**Returns:** +: the properties of the variable + +- #### setProperties + +```java +public void setProperties(PHXRefProperty[] v) +``` + +- #### createRefProp + +```java +public IPHXRefPropInfo createRefProp(java.lang.String name, + java.lang.String type) +``` +adds a property to the variable +**Parameters:** +: `name`- the name of the property +: `type`- property type: "long", "double", "boolean", or "string" + +- #### getRefPropValueDouble + +```java +public double getRefPropValueDouble(java.lang.String name) + throws PHXTypeMismatchException +``` +gets a value for a ref prop +**Parameters:** +: `name`- the name of the property +**Returns:** +: the value of the property +**Throws:** +: `PHXTypeMismatchException` + +- #### getRefPropValueLong + +```java +public long getRefPropValueLong(java.lang.String name) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### getRefPropValueBoolean + +```java +public boolean getRefPropValueBoolean(java.lang.String name) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### getRefPropValueString + +```java +public java.lang.String getRefPropValueString(java.lang.String name) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + double value) + throws PHXTypeMismatchException +``` +sets a value for a ref prop +**Parameters:** +: `name`- the name of the property +: `value`- the value of the property +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + long value) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + boolean value) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + java.lang.String value) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### _getProperty + +```java +public PHXRefProperty _getProperty(java.lang.String name) +``` +retrieves a named property +**Parameters:** +: `name`- the name of the property +**Returns:** +: the property matching the specified name + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +converts to a PHXStringBuffer +**Specified by:** +: `toString2`in interface`IPHXType2` +**Returns:** +: a PHXStringBuffer + +- #### toString + +```java +public java.lang.String toString() +``` +converts to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a string + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer s) +``` +converts from a PHXStringBuffer +**Specified by:** +: `fromString2`in interface`IPHXType2` +**Parameters:** +: `s`- the PHXStringBuffer value + +- #### fromString + +```java +public void fromString(java.lang.String s) +``` +converts from a string +**Specified by:** +: `fromString`in interface`IPHXType` +**Parameters:** +: `s`- the string value + +- #### getDescription + +```java +public java.lang.String getDescription() +``` + +- #### setDescription + +```java +public void setDescription(java.lang.String desc) +``` + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Specified by:** +: `Accept`in interface`IPHXType2` +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md new file mode 100644 index 0000000000..853480cb51 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md @@ -0,0 +1,299 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXReferenceArray +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXReferenceArray +- **All Implemented Interfaces:** +: [IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html) + +--- + +```java +public class PHXReferenceArray +extends java.lang.Object +implements IPHXAlwaysWriteable +``` +The Phoenix type for references. This class matches up to + references in ModelCenter. Users may define their own + properties in addition to the value property. +- **value**: double[] +- **length**: int +- **autoGrow**: boolean +- **properties**: PHXRefArrayProperty[] +- **reference**: String[] +**Author:** +: Woyak- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXReferenceArray()`constructor | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `IPHXRefPropInfo` | `createRefProp(java.lang.String name, + java.lang.String type)`adds a ref prop to the variable. | +| `boolean` | `getAutoGrow()`retrieves the autoGrow value | +| `int` | `getLength()`retrieves the number of references in the array | +| `PHXRefArrayProperty[]` | `getProperties()`get-set function for AServer | +| `java.lang.String[]` | `getReference()`retrieves the current reference string. | +| `java.lang.String` | `getReference(int i)` | +| `boolean` | `getRefPropValueBoolean(java.lang.String name, + int index)` | +| `double` | `getRefPropValueDouble(java.lang.String name, + int index)`gets a value for a ref prop | +| `long` | `getRefPropValueLong(java.lang.String name, + int index)` | +| `java.lang.String` | `getRefPropValueString(java.lang.String name, + int index)` | +| `double[]` | `getValues()`retrieves the current value of the variable | +| `void` | `setAutoGrow(boolean flag)`sets the autoGrow value. | +| `void` | `setLength(int v)`sets the number of references | +| `void` | `setProperties(PHXRefArrayProperty[] p)` | +| `void` | `setReference(int i, + java.lang.String ref)` | +| `void` | `setReference(java.lang.String[] ref)`sets the value for the reference string. | +| `void` | `setRefPropValue(java.lang.String name, + int index, + boolean value)` | +| `void` | `setRefPropValue(java.lang.String name, + int index, + double value)`sets a value for a ref prop | +| `void` | `setRefPropValue(java.lang.String name, + int index, + long value)` | +| `void` | `setRefPropValue(java.lang.String name, + int index, + java.lang.String value)` | +| `void` | `setValues(double[] v)`sets the value for the variable | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXReferenceArray + +```java +public PHXReferenceArray() +``` +constructor +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getProperties + +```java +public PHXRefArrayProperty[] getProperties() +``` +get-set function for AServer + +- #### setProperties + +```java +public void setProperties(PHXRefArrayProperty[] p) +``` + +- #### getValues + +```java +public double[] getValues() +``` +retrieves the current value of the variable +**Returns:** +: the value of the variable + +- #### setValues + +```java +public void setValues(double[] v) +``` +sets the value for the variable +**Parameters:** +: `v`- the value + +- #### getReference + +```java +public java.lang.String[] getReference() +``` +retrieves the current reference string. This is a client-supplied + value describing what the reference value points to. +**Returns:** +: the reference string + +- #### getReference + +```java +public java.lang.String getReference(int i) +``` + +- #### setReference + +```java +public void setReference(java.lang.String[] ref) +``` +sets the value for the reference string. This should only be + called by the client application, e.g. ModelCenter. +**Parameters:** +: `ref`- the reference string + +- #### setReference + +```java +public void setReference(int i, + java.lang.String ref) +``` + +- #### getLength + +```java +public int getLength() +``` +retrieves the number of references in the array +**Returns:** +: the number of references + +- #### setLength + +```java +public void setLength(int v) +``` +sets the number of references +**Parameters:** +: `v`- the number of references + +- #### getAutoGrow + +```java +public boolean getAutoGrow() +``` +retrieves the autoGrow value +**Returns:** +: true or false + +- #### setAutoGrow + +```java +public void setAutoGrow(boolean flag) +``` +sets the autoGrow value. If true, the client application + is allowed to resize the array as needed. +**Parameters:** +: `flag`- true or false + +- #### createRefProp + +```java +public IPHXRefPropInfo createRefProp(java.lang.String name, + java.lang.String type) +``` +adds a ref prop to the variable. +**Parameters:** +: `name`- the name of the property +: `type`- property type: "long", "double", "boolean", or "string" + +- #### getRefPropValueDouble + +```java +public double getRefPropValueDouble(java.lang.String name, + int index) + throws PHXTypeMismatchException +``` +gets a value for a ref prop +**Parameters:** +: `name`- the name of the property +: `index`- the array element +**Returns:** +: the value of the property +**Throws:** +: `PHXTypeMismatchException` + +- #### getRefPropValueLong + +```java +public long getRefPropValueLong(java.lang.String name, + int index) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### getRefPropValueBoolean + +```java +public boolean getRefPropValueBoolean(java.lang.String name, + int index) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### getRefPropValueString + +```java +public java.lang.String getRefPropValueString(java.lang.String name, + int index) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + int index, + double value) + throws PHXTypeMismatchException +``` +sets a value for a ref prop +**Parameters:** +: `name`- the name of the property +: `index`- the array element +: `value`- the value of the property +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + int index, + long value) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + int index, + boolean value) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` + +- #### setRefPropValue + +```java +public void setRefPropValue(java.lang.String name, + int index, + java.lang.String value) + throws PHXTypeMismatchException +``` + +**Throws:** +: `PHXTypeMismatchException` +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md new file mode 100644 index 0000000000..bc1e4421f9 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md @@ -0,0 +1,1106 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXScriptObject +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXScriptObject +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- + +```java +public class PHXScriptObject +extends PHXSimpleType +``` +The PHX type for object variables. + This class holds an instance of PHXObjectHost that wraps around + a Java or Python object, and uses introspection to get and set + values of the internal object.- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXScriptObject()`Creates a new instance of PHXScriptObject | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `java.lang.Object` | `callMethod(java.lang.String method)`call a method | +| `PHXSimpleType` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `void` | `deleteAllMembers()`delete all members for non-strict type object. | +| `void` | `deleteMember(java.lang.String mIndex)`delete a member for non-strict type object. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromFile(java.lang.String mIndex)`load a file into a file member. | +| `void` | `fromFile(java.lang.String mIndex, + java.lang.String fileName)`load a file into a file member | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`update object using the XML value | +| `void` | `fromString2(PHXStringBuffervalue)`update object using the XML value | +| `void` | `fromXML(java.lang.String xmlStr)`update the object from an XML string | +| `boolean` | `getBooleanArrayMemberValue(java.lang.String mIndex, + int index)`get the value of an 1D boolean array element | +| `boolean` | `getBooleanArrayMemberValue(java.lang.String mIndex, + int[] index)`get the value of a boolean array element | +| `boolean` | `getBooleanMemberValue(java.lang.String mIndex)`gets the value of boolean member | +| `java.lang.String` | `getClassURL()`get the class type. | +| `double` | `getDoubleArrayMemberValue(java.lang.String mIndex, + int index)`get the value of an 1D double array element | +| `double` | `getDoubleArrayMemberValue(java.lang.String mIndex, + int[] index)`get the value of a double array element | +| `double` | `getDoubleMemberValue(java.lang.String mIndex)`gets the value of a double member | +| `java.lang.String` | `getFileName(java.lang.String mIndex)`return name of the data source file | +| `int` | `getIntArrayMemberValue(java.lang.String mIndex, + int index)`get the value of an 1D integer array element | +| `int` | `getIntArrayMemberValue(java.lang.String mIndex, + int[] index)`get the value of an integer array element | +| `java.lang.Object` | `getInternalObject()`get internal Java object that represent the data | +| `int` | `getIntMemberValue(java.lang.String mIndex)`gets the value of an integer member | +| `boolean` | `getIsBinary(java.lang.String mIndex)`return true if the file member contains a binary file | +| `java.lang.String` | `getMemberDescription(java.lang.String mIndex)`get description of the member | +| `int[]` | `getMemberDimensions(java.lang.String mIndex)`get dimensions and size of an array member | +| `java.lang.String` | `getMemberEnumAliases(java.lang.String mIndex)`get enum aliases of the member | +| `java.lang.String` | `getMemberEnumValues(java.lang.String mIndex)`return enum values of the member | +| `int` | `getMemberLength(java.lang.String mIndex)`get length of an 1D array member | +| `int` | `getMemberLength(java.lang.String mIndex, + int dimension)`get length of an array member | +| `java.lang.String[]` | `getMemberList(java.lang.String mIndex)`get a list of child members. | +| `java.lang.String` | `getMemberLowerBound(java.lang.String mIndex)`get lowerBound of a member | +| `int` | `getMemberNumDimensions(java.lang.String mIndex)`get number of dimensions of an array member | +| `java.lang.String` | `getMemberProperty(java.lang.String mIndex, + java.lang.String propertyName)`get value of a property of the member | +| `java.lang.String` | `getMemberType(java.lang.String mIndex)`return type of the member | +| `java.lang.String` | `getMemberUnits(java.lang.String mIndex)`get units of the member | +| `java.lang.String` | `getMemberUpperBound(java.lang.String mIndex)`return upperBound of the member | +| `java.lang.String` | `getMemberValueAsString(java.lang.String mIndex)`gets the value of a member as a string | +| `java.lang.String[]` | `getMethodList()`get a list of methods | +| `java.lang.String` | `getStringArrayMemberValue(java.lang.String mIndex, + int index)`get the value of an 1D String array element | +| `java.lang.String` | `getStringArrayMemberValue(java.lang.String mIndex, + int[] index)`get the value of a string array element | +| `java.lang.String` | `getStringMemberValue(java.lang.String mIndex)`gets the value of string member | +| `boolean` | `hasMember(java.lang.String mIndex)`check if a member exists | +| `boolean` | `hasMemberLowerBound(java.lang.String mIndex)`check if a member has lower bound defined | +| `boolean` | `hasMemberUpperBound(java.lang.String mIndex)`check if a member has lower bound defined | +| `void` | `initialize(com.phoenix_int.object.PHXDataObjectClass pClass)`initialize object variable with the specified class | +| `boolean` | `isNonStrictType()`check whether a class is a non-strict type | +| `void` | `setBaseName(java.lang.String mIndex, + java.lang.String baseName)`set base name for the data source file | +| `void` | `setBooleanArrayMemberValue(java.lang.String mIndex, + int[] index, + boolean value)`sets the value of a boolean array member | +| `void` | `setBooleanArrayMemberValue(java.lang.String mIndex, + int index, + boolean value)`sets the value of an 1D boolean array member | +| `void` | `setBooleanMemberValue(java.lang.String mIndex, + boolean value)`sets the value of a boolean member | +| `void` | `setDoubleArrayMemberValue(java.lang.String mIndex, + int[] index, + double value)`sets the value of a double array member | +| `void` | `setDoubleArrayMemberValue(java.lang.String mIndex, + int index, + double value)`sets the value of a 1D double array member | +| `void` | `setDoubleMemberValue(java.lang.String mIndex, + double value)`sets the value of a double member | +| `void` | `setFileExtension(java.lang.String mIndex, + java.lang.String fileExtension)`set file extesion of the data source file | +| `void` | `setFileName(java.lang.String mIndex, + java.lang.String fileName)`set name of the data source file | +| `void` | `setIntArrayMemberValue(java.lang.String mIndex, + int[] index, + int value)`sets the value of an integer array member | +| `void` | `setIntArrayMemberValue(java.lang.String mIndex, + int index, + int value)`sets the value of an 1D integer array member | +| `void` | `setIntMemberValue(java.lang.String mIndex, + int value)`sets the value of an integer member | +| `void` | `setIsBinary(java.lang.String mIndex, + boolean isBinary)`set binary flag for a file member | +| `void` | `setMember(java.lang.String mIndex, + java.lang.String value, + java.lang.String type)`sets the value of a member. | +| `void` | `setMemberDescription(java.lang.String mIndex, + java.lang.String description)`set description of the member | +| `void` | `setMemberDimensions(java.lang.String mIndex, + int[] dims)`set dimensions of an array member | +| `void` | `setMemberEnumAliases(java.lang.String mIndex, + java.lang.String enumAliases)`set enum aliases of the member | +| `void` | `setMemberEnumValues(java.lang.String mIndex, + java.lang.String enumValues)`set enum values of the member | +| `void` | `setMemberLength(java.lang.String mIndex, + int length)`set length of an 1D array member | +| `void` | `setMemberLength(java.lang.String mIndex, + int length, + int dimension)`set length of an array member | +| `void` | `setMemberLowerBound(java.lang.String mIndex, + java.lang.String lowerBound)`set lowerBound of the member | +| `void` | `setMemberProperty(java.lang.String mIndex, + java.lang.String propertyName, + java.lang.String propertyValue)`set value of a property of the member | +| `void` | `setMemberUnits(java.lang.String mIndex, + java.lang.String units)`set units of the member | +| `void` | `setMemberUpperBound(java.lang.String mIndex, + java.lang.String upperBound)`set upperBound of the member | +| `void` | `setMemberValueFromString(java.lang.String mIndex, + java.lang.String value)`sets the value of a member from string | +| `void` | `setStringArrayMemberValue(java.lang.String mIndex, + int[] index, + java.lang.String value)`sets the value of a string array member | +| `void` | `setStringArrayMemberValue(java.lang.String mIndex, + int index, + java.lang.String value)`sets the value of a 1D string array member | +| `void` | `setStringMemberValue(java.lang.String mIndex, + java.lang.String value)`sets the value of a string member | +| `void` | `toFile(java.lang.String mIndex)`write a file member to a file + file name must have been specified | +| `void` | `toFile(java.lang.String mIndex, + java.lang.String fileName)`write a file member to a file | +| `java.lang.String` | `toString()`get XML representation of the object variable | +| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | +| `java.lang.String` | `toXML()`get XML representation of the object | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXScriptObject + +```java +public PHXScriptObject() +``` +Creates a new instance of PHXScriptObject +============ METHOD DETAIL ========== +- ### Method Detail + +- #### initialize + +```java +public void initialize(com.phoenix_int.object.PHXDataObjectClass pClass) + throws java.io.IOException +``` +initialize object variable with the specified class +**Parameters:** +: `pClass`- class information +**Throws:** +: `java.io.IOException` + +- #### toString + +```java +public java.lang.String toString() +``` +get XML representation of the object variable +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: XML string + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +update object using the XML value +**Parameters:** +: `value`- XML string for the object + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +converts the variable to a PHXStringBuffer +**Returns:** +: the PHXStringBuffer representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +update object using the XML value +**Parameters:** +: `value`- the value to convert + +- #### getClassURL + +```java +public java.lang.String getClassURL() +``` +get the class type. The class type is defined in a URL format +**Returns:** +: class type + +- #### getMemberValueAsString + +```java +public java.lang.String getMemberValueAsString(java.lang.String mIndex) +``` +gets the value of a member as a string +**Parameters:** +: `mIndex`- member index (e.g., member1, grp1.member1, member1[1], member1[1,2]) +**Returns:** +: the value of the variable + +- #### getDoubleMemberValue + +```java +public double getDoubleMemberValue(java.lang.String mIndex) +``` +gets the value of a double member +**Parameters:** +: `mIndex`- member index +**Returns:** +: the value of the variable + +- #### getIntMemberValue + +```java +public int getIntMemberValue(java.lang.String mIndex) +``` +gets the value of an integer member +**Parameters:** +: `mIndex`- member index +**Returns:** +: the value of the variable + +- #### getBooleanMemberValue + +```java +public boolean getBooleanMemberValue(java.lang.String mIndex) +``` +gets the value of boolean member +**Parameters:** +: `mIndex`- member index +**Returns:** +: the value of the variable + +- #### getStringMemberValue + +```java +public java.lang.String getStringMemberValue(java.lang.String mIndex) +``` +gets the value of string member +**Parameters:** +: `mIndex`- member index +**Returns:** +: the value of the variable + +- #### getDoubleArrayMemberValue + +```java +public double getDoubleArrayMemberValue(java.lang.String mIndex, + int index) +``` +get the value of an 1D double array element +**Parameters:** +: `mIndex`- member index +**Returns:** +: the value of the variable + +- #### getDoubleArrayMemberValue + +```java +public double getDoubleArrayMemberValue(java.lang.String mIndex, + int[] index) +``` +get the value of a double array element +**Parameters:** +: `mIndex`- member index +: `index`- array index +**Returns:** +: the value of the variable + +- #### getIntArrayMemberValue + +```java +public int getIntArrayMemberValue(java.lang.String mIndex, + int index) +``` +get the value of an 1D integer array element +**Parameters:** +: `mIndex`- member index +: `index`- array index +**Returns:** +: the value of the variable + +- #### getIntArrayMemberValue + +```java +public int getIntArrayMemberValue(java.lang.String mIndex, + int[] index) +``` +get the value of an integer array element +**Parameters:** +: `mIndex`- member index +: `index`- array index +**Returns:** +: the value of the variable + +- #### getBooleanArrayMemberValue + +```java +public boolean getBooleanArrayMemberValue(java.lang.String mIndex, + int index) +``` +get the value of an 1D boolean array element +**Parameters:** +: `mIndex`- member index +: `index`- array index +**Returns:** +: the value of the variable + +- #### getBooleanArrayMemberValue + +```java +public boolean getBooleanArrayMemberValue(java.lang.String mIndex, + int[] index) +``` +get the value of a boolean array element +**Parameters:** +: `mIndex`- member index +: `index`- array index +**Returns:** +: the value of the variable + +- #### getStringArrayMemberValue + +```java +public java.lang.String getStringArrayMemberValue(java.lang.String mIndex, + int index) +``` +get the value of an 1D String array element +**Parameters:** +: `mIndex`- member index +: `index`- array index +**Returns:** +: the value of the variable + +- #### getStringArrayMemberValue + +```java +public java.lang.String getStringArrayMemberValue(java.lang.String mIndex, + int[] index) +``` +get the value of a string array element +**Parameters:** +: `mIndex`- member index +: `index`- array index +**Returns:** +: the value of the variable + +- #### setMemberValueFromString + +```java +public void setMemberValueFromString(java.lang.String mIndex, + java.lang.String value) +``` +sets the value of a member from string +**Parameters:** +: `mIndex`- member index +: `value`- the value of the member + +- #### setDoubleMemberValue + +```java +public void setDoubleMemberValue(java.lang.String mIndex, + double value) +``` +sets the value of a double member +**Parameters:** +: `mIndex`- member index +: `value`- value of the member + +- #### setIntMemberValue + +```java +public void setIntMemberValue(java.lang.String mIndex, + int value) +``` +sets the value of an integer member +**Parameters:** +: `mIndex`- member index +: `value`- value of the member + +- #### setBooleanMemberValue + +```java +public void setBooleanMemberValue(java.lang.String mIndex, + boolean value) +``` +sets the value of a boolean member +**Parameters:** +: `mIndex`- member index +: `value`- value of the member + +- #### setStringMemberValue + +```java +public void setStringMemberValue(java.lang.String mIndex, + java.lang.String value) +``` +sets the value of a string member +**Parameters:** +: `mIndex`- member index +: `value`- value of the member + +- #### setDoubleArrayMemberValue + +```java +public void setDoubleArrayMemberValue(java.lang.String mIndex, + int index, + double value) +``` +sets the value of a 1D double array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setDoubleArrayMemberValue + +```java +public void setDoubleArrayMemberValue(java.lang.String mIndex, + int[] index, + double value) +``` +sets the value of a double array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setIntArrayMemberValue + +```java +public void setIntArrayMemberValue(java.lang.String mIndex, + int index, + int value) +``` +sets the value of an 1D integer array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setIntArrayMemberValue + +```java +public void setIntArrayMemberValue(java.lang.String mIndex, + int[] index, + int value) +``` +sets the value of an integer array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setBooleanArrayMemberValue + +```java +public void setBooleanArrayMemberValue(java.lang.String mIndex, + int index, + boolean value) +``` +sets the value of an 1D boolean array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setBooleanArrayMemberValue + +```java +public void setBooleanArrayMemberValue(java.lang.String mIndex, + int[] index, + boolean value) +``` +sets the value of a boolean array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setStringArrayMemberValue + +```java +public void setStringArrayMemberValue(java.lang.String mIndex, + int index, + java.lang.String value) +``` +sets the value of a 1D string array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setStringArrayMemberValue + +```java +public void setStringArrayMemberValue(java.lang.String mIndex, + int[] index, + java.lang.String value) +``` +sets the value of a string array member +**Parameters:** +: `mIndex`- member index +: `index`- array index +: `value`- value of the member + +- #### setMember + +```java +public void setMember(java.lang.String mIndex, + java.lang.String value, + java.lang.String type) +``` +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 + +- #### deleteMember + +```java +public void deleteMember(java.lang.String mIndex) +``` +delete a member for non-strict type object. An exception will + be thrown for strict types +**Parameters:** +: `mIndex`- member index + +- #### deleteAllMembers + +```java +public void deleteAllMembers() +``` +delete all members for non-strict type object. An exception will + be thrown for strict types + +- #### callMethod + +```java +public java.lang.Object callMethod(java.lang.String method) +``` +call a method +**Parameters:** +: `method`- name of the method +**Returns:** +: primitives object (e.g., java.lang.Double) or + array of primitives (e.g., double[]) + +- #### isNonStrictType + +```java +public boolean isNonStrictType() +``` +check whether a class is a non-strict type +**Returns:** +: true if the class is a non-strict type + +- #### toXML + +```java +public java.lang.String toXML() +``` +get XML representation of the object +**Returns:** +: XML representation of the object + +- #### fromXML + +```java +public void fromXML(java.lang.String xmlStr) +``` +update the object from an XML string +**Parameters:** +: `xmlStr`- content of an object in XML format + +- #### hasMember + +```java +public boolean hasMember(java.lang.String mIndex) +``` +check if a member exists +**Parameters:** +: `mIndex`- member name +**Returns:** +: true if the member exists + +- #### getMemberLength + +```java +public int getMemberLength(java.lang.String mIndex, + int dimension) +``` +get length of an array member +**Parameters:** +: `mIndex`- name of the member +: `dimension`- dimension id of the array member +**Returns:** +: length of the array member + +- #### getMemberLength + +```java +public int getMemberLength(java.lang.String mIndex) +``` +get length of an 1D array member +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: length of the array member + +- #### setMemberLength + +```java +public void setMemberLength(java.lang.String mIndex, + int length, + int dimension) +``` +set length of an array member +**Parameters:** +: `mIndex`- name of the member +: `length`- of the array +: `dimension`- dimension id of the array member + +- #### setMemberLength + +```java +public void setMemberLength(java.lang.String mIndex, + int length) +``` +set length of an 1D array member +**Parameters:** +: `mIndex`- name of the member +: `length`- of the array + +- #### setMemberDimensions + +```java +public void setMemberDimensions(java.lang.String mIndex, + int[] dims) +``` +set dimensions of an array member +**Parameters:** +: `mIndex`- name of the member +: `dims`- length of the array + +- #### getMemberNumDimensions + +```java +public int getMemberNumDimensions(java.lang.String mIndex) +``` +get number of dimensions of an array member +**Parameters:** +: `mIndex`- name of the member + +- #### getMemberDimensions + +```java +public int[] getMemberDimensions(java.lang.String mIndex) +``` +get dimensions and size of an array member +**Parameters:** +: `mIndex`- name of the member + +- #### getMemberList + +```java +public java.lang.String[] getMemberList(java.lang.String mIndex) +``` +get a list of child members. +**Parameters:** +: `mIndex`- name of the parent member +**Returns:** +: String array of child names + +- #### getMemberType + +```java +public java.lang.String getMemberType(java.lang.String mIndex) +``` +return type of the member +**Parameters:** +: `mIndex`- name of the member + +- #### getMethodList + +```java +public java.lang.String[] getMethodList() +``` +get a list of methods +**Returns:** +: String array of methods + +- #### hasMemberLowerBound + +```java +public boolean hasMemberLowerBound(java.lang.String mIndex) +``` +check if a member has lower bound defined +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: true if the member has lower bound defined + +- #### hasMemberUpperBound + +```java +public boolean hasMemberUpperBound(java.lang.String mIndex) +``` +check if a member has lower bound defined +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: true if the member has upper bound defined + +- #### getMemberLowerBound + +```java +public java.lang.String getMemberLowerBound(java.lang.String mIndex) +``` +get lowerBound of a member +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: lowerBound of the member + +- #### setMemberLowerBound + +```java +public void setMemberLowerBound(java.lang.String mIndex, + java.lang.String lowerBound) +``` +set lowerBound of the member +**Parameters:** +: `mIndex`- name of the member +: `lowerBound`- lower bound + +- #### getMemberUpperBound + +```java +public java.lang.String getMemberUpperBound(java.lang.String mIndex) +``` +return upperBound of the member +**Parameters:** +: `mIndex`- name of the member + +- #### setMemberUpperBound + +```java +public void setMemberUpperBound(java.lang.String mIndex, + java.lang.String upperBound) +``` +set upperBound of the member +**Parameters:** +: `mIndex`- name of the member +: `upperBound`- upper bound + +- #### getMemberEnumValues + +```java +public java.lang.String getMemberEnumValues(java.lang.String mIndex) +``` +return enum values of the member +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: enum values of the member as a comma separated string + +- #### setMemberEnumValues + +```java +public void setMemberEnumValues(java.lang.String mIndex, + java.lang.String enumValues) +``` +set enum values of the member +**Parameters:** +: `mIndex`- name of the member +: `enumValues`- enumerated values as a comma separated string + +- #### getMemberEnumAliases + +```java +public java.lang.String getMemberEnumAliases(java.lang.String mIndex) +``` +get enum aliases of the member +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: enum aliases of the member as a comma separated string + +- #### setMemberEnumAliases + +```java +public void setMemberEnumAliases(java.lang.String mIndex, + java.lang.String enumAliases) +``` +set enum aliases of the member +**Parameters:** +: `mIndex`- name of the member +: `enumAliases`- enumerated aliases as a comma separated string + +- #### getMemberDescription + +```java +public java.lang.String getMemberDescription(java.lang.String mIndex) +``` +get description of the member +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: description of the member + +- #### setMemberDescription + +```java +public void setMemberDescription(java.lang.String mIndex, + java.lang.String description) +``` +set description of the member +**Parameters:** +: `mIndex`- name of the member +: `description`- + +- #### getMemberUnits + +```java +public java.lang.String getMemberUnits(java.lang.String mIndex) +``` +get units of the member +**Parameters:** +: `mIndex`- name of the member +**Returns:** +: units of the member + +- #### setMemberUnits + +```java +public void setMemberUnits(java.lang.String mIndex, + java.lang.String units) +``` +set units of the member +**Parameters:** +: `mIndex`- name of the member +: `units`- + +- #### getMemberProperty + +```java +public java.lang.String getMemberProperty(java.lang.String mIndex, + java.lang.String propertyName) +``` +get value of a property of the member +**Parameters:** +: `mIndex`- name of the member +: `propertyName`- name of the property +**Returns:** +: value of a property of the member + +- #### setMemberProperty + +```java +public void setMemberProperty(java.lang.String mIndex, + java.lang.String propertyName, + java.lang.String propertyValue) +``` +set value of a property of the member +**Parameters:** +: `mIndex`- name of the member +: `propertyName`- name of the property +: `propertyValue`- value of the property + +- #### fromFile + +```java +public void fromFile(java.lang.String mIndex, + java.lang.String fileName) +``` +load a file into a file member +**Parameters:** +: `mIndex`- name of the member +: `fileName`- source file name + +- #### fromFile + +```java +public void fromFile(java.lang.String mIndex) +``` +load a file into a file member. + The file name must have been specified by setFileName. +**Parameters:** +: `mIndex`- name of the member + +- #### toFile + +```java +public void toFile(java.lang.String mIndex, + java.lang.String fileName) +``` +write a file member to a file +**Parameters:** +: `mIndex`- name of the member +: `fileName`- destination file name + +- #### toFile + +```java +public void toFile(java.lang.String mIndex) +``` +write a file member to a file + file name must have been specified +**Parameters:** +: `mIndex`- name of the member + +- #### getIsBinary + +```java +public boolean getIsBinary(java.lang.String mIndex) +``` +return true if the file member contains a binary file +**Parameters:** +: `mIndex`- name of the member + +- #### setIsBinary + +```java +public void setIsBinary(java.lang.String mIndex, + boolean isBinary) +``` +set binary flag for a file member +**Parameters:** +: `mIndex`- name of the member +: `isBinary`- binary flag + +- #### getFileName + +```java +public java.lang.String getFileName(java.lang.String mIndex) +``` +return name of the data source file +**Parameters:** +: `mIndex`- name of the member + +- #### setFileName + +```java +public void setFileName(java.lang.String mIndex, + java.lang.String fileName) +``` +set name of the data source file +**Parameters:** +: `mIndex`- name of the member +: `fileName`- file name + +- #### setFileExtension + +```java +public void setFileExtension(java.lang.String mIndex, + java.lang.String fileExtension) +``` +set file extesion of the data source file +**Parameters:** +: `mIndex`- name of the member +: `fileExtension`- file extension + +- #### setBaseName + +```java +public void setBaseName(java.lang.String mIndex, + java.lang.String baseName) +``` +set base name for the data source file +**Parameters:** +: `mIndex`- name of the member +: `baseName`- the new base name + +- #### getInternalObject + +```java +public java.lang.Object getInternalObject() +``` +get internal Java object that represent the data +**Returns:** +: internal Java object that represent the actual data + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXSimpleType createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md new file mode 100644 index 0000000000..4063e6beae --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md @@ -0,0 +1,861 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXSimpleArray +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXSimpleArray +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable + +**Direct Known Subclasses:** +: [PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) + +--- + +```java +public abstract class PHXSimpleArray +extends PHXSimpleType +implements IPHXType2, java.lang.Iterable +``` +This class enables components to create resizeable + arrays where the number of dimensions is variable + as well as the size of each dimension. +Typically you don't use this class directly but + one of its sub-classes that are created and passed + to you automatically. +**Version:** +: Oct 2002 +**Author:** +: Nathan P Sharp- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +=========== FIELD SUMMARY =========== +- ### Field Summary + +| Modifier and Type | Field and Description | +| --- | --- | +| Modifier and Type | Field and Description | +| `protected java.lang.Object` | `_data` | +| `protected boolean` | `_lockDims` | +| `protected boolean` | `_lockResize` | +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Modifier | Constructor and Description | +| --- | --- | +| Modifier | Constructor and Description | +| `protected` | `PHXSimpleArray()`Default Constructor | +| `protected` | `PHXSimpleArray(java.lang.Object data)`Constructs a PHXSimpleArray that wraps a particular ModelCenter Remote Execution style variable. | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_getMetaData()`Gets the meta data off of the first element of the array + and sets it into our meta data info. | +| `protected void` | `_getMetaData(PHXSimpleTypev)`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. | +| `protected void` | `_setMetaData()`Call this function to set the meta data from this object into + every element of the array. | +| `protected void` | `_setMetaData(PHXSimpleTypev)`Sets a simple type's meta data based on the meta data + in this object. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | +| `static boolean` | `checkRectangular(java.lang.Object obj)`Check if the array is rectangular | +| `protected void` | `copy(PHXSimpleArrayother)`Clone another PHXSimpleArray's value and metadata. | +| `protected abstract boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified + class is acceptable as an array element component type. | +| `protected abstract java.lang.Object` | `elementFromString(java.lang.String value)`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromString(int[] index,PHXStringBuffervalue)`Sets the value of a single element based on string + input. | +| `void` | `fromString(int[] index, + java.lang.String value)`Sets the value of a single element based on string + input. | +| `void` | `fromString(int index, + java.lang.String value)`Sets the value of a single element based on string + input for 1-d arrays. | +| `void` | `fromString(java.lang.String in)`reads in the entire array in string form. | +| `void` | `fromString2(PHXStringBufferin)`reads in the entire array in string form. | +| `staticPHXSimpleArray` | `generateFor(java.lang.Object o)`Static method to generate a new instance of + one of the sub-classes of PHXSimpleArray as appropriate + for the type of variable passed in. | +| `staticPHXSimpleArray` | `generateFor(java.lang.Object o, + java.lang.Class c)`Static method to generate a new instance of + one of the sub-classes of PHXSimpleArray as appropriate + for the type of variable passed in. | +| `java.lang.Object` | `getArray()`Gets the entire contents of the array | +| `java.lang.Object` | `getArrayElement(int index)`Gets a particular element from a 1-d array | +| `java.lang.Object` | `getArrayElement(int[] index)`Gets a particular element from the array | +| `java.lang.Class` | `getComponentType()`Returns the component type of the array wrapped + with this class | +| `static java.lang.Class` | `getComponentType(java.lang.Object v)`Gets the component type of an array, even for + n-d arrays. | +| `int[]` | `getDimensions()` | +| `static int[]` | `getDimensions(java.lang.Object array)`Gets the array of dimensions of the array | +| `java.lang.Object` | `getFirst()`Returns the first element of the array, or throws ArrayIndexOutOfBounds + if there are no elements. | +| `int` | `getLength()`Gets the length of the first dimension of the array | +| `int` | `getLength(int dim)`Gets the length of a dimension of the array | +| `boolean` | `getLockResize()` | +| `protected int[]` | `getnDIndex(long oneDIndex, + int[] actualSize)` | +| `int` | `getNumDimensions()`Gets the number of dimensions of the array | +| `static int` | `getNumDimensions(java.lang.Object o)` | +| `PHXSimpleArray` | `getSelf()` | +| `T` | `getValue(int index)`Gets an element as PHXSimpleType object of the appropriate subtype | +| `abstractT` | `getValue(int[] index)`Gets the value of an element as an object of the appropriate subtype + Must be overridden in subclasses | +| `static boolean` | `incrementIndex(int[] index, + int[] size)`Utility function for incrementing an nD index on the array | +| `java.util.Iterator` | `iterator()`Returns an iterator that loops over the array in the standard PHX order, rightmost + index varies fastest. | +| `void` | `lockDimensions()`Tells this array that the number of dimensions cannot be changed + from what they are right now. | +| `int[]` | `newIndex()`Produces a new index based zeroed out, but with the proper dimensions | +| `static int[]` | `parseIndex(java.lang.String index)`Takes a string of the form "anything[n, n2, n3]" + or "n, n2, n3" + and returns an int[] of the index values. | +| `void` | `resize(int[] newSize)`Resize the nD array to the new size specified. | +| `void` | `setArray(java.lang.Object v)`Sets the entire array. | +| `void` | `setArrayElement(int[] index, + java.lang.Object v)`Sets a particular element of the array | +| `void` | `setArrayElement(int index, + java.lang.Object v)`Sets a particular element of a 1-d array | +| `void` | `setDimensions(int[] dim)`Sets the dimensions of the array. | +| `void` | `setFirst(java.lang.Object val)`Sets the first element of the array, or throws ArrayIndexOutOfBounds + if there are no elements. | +| `void` | `setLength(int len)`Sets the length of the first dimension of the array. | +| `void` | `setLength(int len, + int dim)`Sets the length of a dimensions of the array. | +| `void` | `setLockResize(boolean lockResize)`Tells this array that it cannot be resized. | +| `abstract void` | `setValue(int[] index,Tval)`Sets an element as an object of the appropriate PHXSimpleType + Must be overridden in subclasses | +| `void` | `setValue(int index,Tval)`Sets an element as an object of the appropriate PHXSimpleType | +| `java.lang.String` | `toString()`Returns the string form of this array. | +| `java.lang.String` | `toString(int index)`Converts a single element of a 1-d array to a string | +| `java.lang.String` | `toString(int[] index)`Converts a single element to a string | +| `java.lang.String` | `toString(java.lang.String index)`Converts a single element to a string | +| `PHXStringBuffer` | `toString2()`Returns the string form of this array. | +| `PHXStringBuffer` | `toString2(int[] index)`Converts a single element to a string | +| `PHXStringBuffer` | `toString2(java.lang.String index)`Converts a single element to a string | +| `boolean` | `validElement(int[] index, + int[] size)`Is the given index valid? | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,createCopy,fromObject,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`Accept` + +- ### Methods inherited from interface java.lang.Iterable +`forEach, spliterator`- ============ FIELD DETAIL =========== +- ### Field Detail + +- #### _data + +```java +protected java.lang.Object _data +``` + +- #### _lockDims + +```java +protected boolean _lockDims +``` + +- #### _lockResize + +```java +protected boolean _lockResize +``` +========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXSimpleArray + +```java +protected PHXSimpleArray(java.lang.Object data) +``` +Constructs a PHXSimpleArray that wraps a particular ModelCenter Remote Execution style variable. +**Parameters:** +: `data`- The ModelCenter Remote Execution variable to wrap, which must + be an array. + +- #### PHXSimpleArray + +```java +protected PHXSimpleArray() +``` +Default Constructor +============ METHOD DETAIL ========== +- ### Method Detail + +- #### copy + +```java +protected void copy(PHXSimpleArray other) +``` +Clone another PHXSimpleArray's value and metadata. +**Parameters:** +: `other`- the other PHXSimpleArray to clone. + +- #### lockDimensions + +```java +public void lockDimensions() +``` +Tells this array that the number of dimensions cannot be changed + from what they are right now. + +- #### setLockResize + +```java +public void setLockResize(boolean lockResize) +``` +Tells this array that it cannot be resized. Implies lockDimensions. + +- #### getLockResize + +```java +public boolean getLockResize() +``` + +- #### _getMetaData + +```java +protected void _getMetaData() +``` +Gets the meta data off of the first element of the array + and sets it into our meta data info. Call this from + base classes in the constructor and after anything that + might change the meta information on the first array element. + +- #### _getMetaData + +```java +protected void _getMetaData(PHXSimpleType v) +``` +Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. Override this in order to add + more custom meta data in sub-classes. Be sure to cal + super._getMetaData(PHXSimpleType), though! + +- #### dataTypeOK + +```java +protected abstract boolean dataTypeOK(java.lang.Class c) +``` +Must override this function and return true if the specified + class is acceptable as an array element component type. + +- #### resize + +```java +public void resize(int[] newSize) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Resize the nD array to the new size specified. Preserve elements if the # of dimensions stays the same, else + initialize the array with default values. +**Parameters:** +: `newSize`- new dimensions for the array +**Throws:** +: `java.lang.IllegalAccessException`- if an error occurs allocating new array size +: `java.lang.InstantiationException`- if an error occurs allocating new array size + +- #### getFirst + +```java +public java.lang.Object getFirst() +``` +Returns the first element of the array, or throws ArrayIndexOutOfBounds + if there are no elements. + +- #### setFirst + +```java +public void setFirst(java.lang.Object val) +``` +Sets the first element of the array, or throws ArrayIndexOutOfBounds + if there are no elements. + +- #### getLength + +```java +public int getLength() +``` +Gets the length of the first dimension of the array + +- #### getLength + +```java +public int getLength(int dim) +``` +Gets the length of a dimension of the array +**Parameters:** +: `dim`- the dimension of interest +**Returns:** +: the size of the dimension + +- #### setLength + +```java +public void setLength(int len) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Sets the length of the first dimension of the array. + Will preserve as many element values as possible. +**Parameters:** +: `len`- the new length of the 1D array +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if arguments are incorrect or don't + jive with the current array +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### setLength + +```java +public void setLength(int len, + int dim) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Sets the length of a dimensions of the array. + You may grow the array by 1 dimension if 'dim' is + the next dim that needs defining. You may shorten + the array by passing in 'len' < 0 and 'dim' as the + first dimension after the valid dimensions. +**Parameters:** +: `len`- the new length of the dimension. +: `dim`- the dimension to change +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if arguments are incorrect or don't + jive with the current array +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### getDimensions + +```java +public static int[] getDimensions(java.lang.Object array) +``` +Gets the array of dimensions of the array +**Returns:** +: the array with the dimensions + +- #### getDimensions + +```java +public int[] getDimensions() +``` + +- #### setDimensions + +```java +public void setDimensions(int[] dim) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Sets the dimensions of the array. Will preserve as many element + values as possible. +**Parameters:** +: `dim`- the new dimensions for the array +**Throws:** +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### getNumDimensions + +```java +public static int getNumDimensions(java.lang.Object o) +``` + +- #### getNumDimensions + +```java +public int getNumDimensions() +``` +Gets the number of dimensions of the array + +- #### fromString + +```java +public void fromString(int index, + java.lang.String value) +``` +Sets the value of a single element based on string + input for 1-d arrays. Data is converted as appropriate. +**Parameters:** +: `index`- Which element to set. +: `value`- The new value. + +- #### fromString + +```java +public void fromString(int[] index, + PHXStringBuffer value) +``` +Sets the value of a single element based on string + input. Data is converted as appropriate. +**Parameters:** +: `index`- Which element to set. +: `value`- The new value. + +- #### fromString + +```java +public void fromString(int[] index, + java.lang.String value) +``` +Sets the value of a single element based on string + input. Data is converted as appropriate. +**Parameters:** +: `index`- Which element to set. +: `value`- The new value. + +- #### elementFromString + +```java +protected abstract java.lang.Object elementFromString(java.lang.String value) +``` +Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. This is only used when the element type does not + implement IPHXType or IPHXType2. For primitives, return + the wrapper objects. + +- #### toString + +```java +public java.lang.String toString(int index) +``` +Converts a single element of a 1-d array to a string +**Parameters:** +: `index`- the index of the desired element +**Returns:** +: the desired element, in string form + +- #### parseIndex + +```java +public static int[] parseIndex(java.lang.String index) +``` +Takes a string of the form "anything[n, n2, n3]" + or "n, n2, n3" + and returns an int[] of the index values. + +- #### toString + +```java +public java.lang.String toString(java.lang.String index) +``` +Converts a single element to a string +**Parameters:** +: `index`- the index of the desired element +**Returns:** +: the desired element, in string form + +- #### toString2 + +```java +public PHXStringBuffer toString2(java.lang.String index) + throws java.io.IOException +``` +Converts a single element to a string +**Parameters:** +: `index`- the index of the desired element +**Returns:** +: the desired element, in string form +**Throws:** +: `java.io.IOException` + +- #### toString + +```java +public java.lang.String toString(int[] index) +``` +Converts a single element to a string +**Parameters:** +: `index`- the index of the desired element +**Returns:** +: the desired element, in string form + +- #### toString2 + +```java +public PHXStringBuffer toString2(int[] index) + throws java.io.IOException +``` +Converts a single element to a string +**Parameters:** +: `index`- the index of the desired element +**Returns:** +: the desired element, in string form +**Throws:** +: `java.io.IOException` + +- #### getArrayElement + +```java +public java.lang.Object getArrayElement(int index) +``` +Gets a particular element from a 1-d array +**Parameters:** +: `index`- the 1D array index into the 1D array +**Returns:** +: the specified element +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if 1D reference is given to a >1D array + +- #### getArrayElement + +```java +public java.lang.Object getArrayElement(int[] index) +``` +Gets a particular element from the array +**Parameters:** +: `index`- the 1D array index into the 1D array +**Returns:** +: the specified element +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if 1D reference is given to a >1D array + +- #### setArrayElement + +```java +public void setArrayElement(int index, + java.lang.Object v) +``` +Sets a particular element of a 1-d array +**Parameters:** +: `index`- Which index to set +: `v`- The new value. Note that this takes + an instance of a PHXType. + +- #### setArrayElement + +```java +public void setArrayElement(int[] index, + java.lang.Object v) +``` +Sets a particular element of the array +**Parameters:** +: `index`- Which index to set +: `v`- The new value. Note that this takes + an instance of a PHXType. + +- #### getArray + +```java +public java.lang.Object getArray() +``` +Gets the entire contents of the array +**Returns:** +: the base array object + +- #### setArray + +```java +public void setArray(java.lang.Object v) +``` +Sets the entire array. Array is checked for validity + and rectangularity. _getMetaData() is called. +**Parameters:** +: `v`- the new array (nD) +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if array passed in is not rectangular + +- #### getSelf + +```java +public PHXSimpleArray getSelf() +``` + +- #### checkRectangular + +```java +public static boolean checkRectangular(java.lang.Object obj) +``` +Check if the array is rectangular +**Parameters:** +: `obj`- the array to check +**Returns:** +: is the array rectangular? +**Throws:** +: `java.lang.NullPointerException`- thrown if one of the values in the array is null + +- #### getComponentType + +```java +public static java.lang.Class getComponentType(java.lang.Object v) +``` +Gets the component type of an array, even for + n-d arrays. +**Parameters:** +: `v`- The array to get the component type for + +- #### getComponentType + +```java +public java.lang.Class getComponentType() +``` +Returns the component type of the array wrapped + with this class + +- #### generateFor + +```java +public static PHXSimpleArray generateFor(java.lang.Object o) + throws java.lang.IllegalArgumentException +``` +Static method to generate a new instance of + one of the sub-classes of PHXSimpleArray as appropriate + for the type of variable passed in. +**Throws:** +: `java.lang.IllegalArgumentException` + +- #### generateFor + +```java +public static PHXSimpleArray generateFor(java.lang.Object o, + java.lang.Class c) + throws java.lang.IllegalArgumentException +``` +Static method to generate a new instance of + one of the sub-classes of PHXSimpleArray as appropriate + for the type of variable passed in. If 'o' is null, a + new 0 length array will be generated based on 'c' as + the component type. +**Throws:** +: `java.lang.IllegalArgumentException` + +- #### fromString + +```java +public void fromString(java.lang.String in) +``` +reads in the entire array in string form. +bounds[3,2] { 1,2,3,4,5,6 } +**Specified by:** +: `fromString`in interface`IPHXType` +**Parameters:** +: `in`- the value of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer in) +``` +reads in the entire array in string form. +bounds[3,2] { 1,2,3,4,5,6 } +**Specified by:** +: `fromString2`in interface`IPHXType2` +**Parameters:** +: `in`- representation of the type to use + +- #### toString + +```java +public java.lang.String toString() +``` +Returns the string form of this array. + Puts each element in quotes, even if it is a number and backslashes + any quote or backslash characters (" and \). +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: the value as a String + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +Returns the string form of this array. + Puts each element in quotes, even if it is a number and backslashes + any quote or backslash characters (" and \). +**Specified by:** +: `toString2`in interface`IPHXType2` +**Returns:** +: PHXStringBuffer representation of the type + +- #### incrementIndex + +```java +public static boolean incrementIndex(int[] index, + int[] size) +``` +Utility function for incrementing an nD index on the array +**Parameters:** +: `index`- the index to increment +: `size`- the maximum size of the array +**Returns:** +: did the incrment work? +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if index lengths don't match + +- #### newIndex + +```java +public int[] newIndex() +``` +Produces a new index based zeroed out, but with the proper dimensions +**Returns:** +: the new index + +- #### validElement + +```java +public boolean validElement(int[] index, + int[] size) +``` +Is the given index valid? +**Parameters:** +: `index`- the index to check +: `size`- the maximum size +**Returns:** +: is the given index valid? + +- #### allocateElement + +```java +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, + java.lang.InstantiationException +``` +Allocates a single element in a default state. + If the class type in question has a default constructor, + there is no need to override this. +**Throws:** +: `java.lang.IllegalAccessException` +: `java.lang.InstantiationException` + +- #### _setMetaData + +```java +protected void _setMetaData(PHXSimpleType v) +``` +Sets a simple type's meta data based on the meta data + in this object. Override this to set additional + information in sub-classes. Be sure to call + super._setMetaData(PHXSimpleType) + +- #### _setMetaData + +```java +protected void _setMetaData() +``` +Call this function to set the meta data from this object into + every element of the array. + +- #### getnDIndex + +```java +protected int[] getnDIndex(long oneDIndex, + int[] actualSize) + throws java.lang.IllegalArgumentException +``` + +**Throws:** +: `java.lang.IllegalArgumentException` + +- #### getValue + +```java +public T getValue(int index) +``` +Gets an element as PHXSimpleType object of the appropriate subtype +**Parameters:** +: `index`- 1D array index +**Returns:** +: referenced array value +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### setValue + +```java +public void setValue(int index, + T val) +``` +Sets an element as an object of the appropriate PHXSimpleType +**Parameters:** +: `index`- 1D array index +: `val`- value to set + +- #### getValue + +```java +public abstract T getValue(int[] index) +``` +Gets the value of an element as an object of the appropriate subtype + Must be overridden in subclasses +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### iterator + +```java +public java.util.Iterator iterator() +``` +Returns an iterator that loops over the array in the standard PHX order, rightmost + index varies fastest. Note that the iterator returned is not thread safe. It also has + undefined behavior if the array is modified while iterating over the array. It does not + support Iterator.remove(). Lastly, + the iterator returned may throw exceptions other than NoSuchElementException, such as + IndexOutOfBoundsException. +**Specified by:** +: `iterator`in interface`java.lang.Iterable` +**See Also:** +: `Iterable` + +- #### setValue + +```java +public abstract void setValue(int[] index, + T val) +``` +Sets an element as an object of the appropriate PHXSimpleType + Must be overridden in subclasses +**Parameters:** +: `index`- nD array index +: `val`- value to set + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. + + Array comparison is handled as follows: + 1) Compare the number of dimensions between the two arrays + 2) Compare the length of dimensions between the two arrays + 3) Compare the values in each of the two arrays + Iff these three conditions are met, the two arrays are considered naturally equal. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md new file mode 100644 index 0000000000..856b729c0d --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md @@ -0,0 +1,202 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXSimpleType +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXSimpleType +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +**Direct Known Subclasses:** +: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html) + +--- + +```java +public abstract class PHXSimpleType +extends java.lang.Object +implements IPHXType2, IPHXUnits +``` +A base class for most Phoenix data types. The class defines + the following properties: +- description: String +- units: String +- hasChanged: boolean +This class will fire a property change event when hasChanged(true) is + called. The property event will always have the property name be "value" + and the old and new values of null. Use toString or getValue functions + to get the actual new value from the variable. +**Author:** +: Woyak- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXSimpleType()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_copyMetadataFromOther(PHXSimpleTypeother)`Copy common metadata on PHXSimpleType from another object to this one. | +| `void` | `addPropertyChangeListener(java.beans.PropertyChangeListener l)` | +| `abstractPHXSimpleType` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `abstract boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `abstract void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `java.lang.String` | `getDescription()` | +| `static java.lang.String[]` | `getEnumTokens(java.lang.String enums)` | +| `boolean` | `getHasChanged()`retrieves the hasChanged flag | +| `java.lang.String` | `getUnits()`Get the units string for the variable | +| `void` | `removePropertyChangeListener(java.beans.PropertyChangeListener l)` | +| `void` | `setDescription(java.lang.String d)` | +| `void` | `setHasChanged(boolean v)`sets the hasChanged flag | +| `void` | `setUnits(java.lang.String u)`Set the units string for the variable | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` + +- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`Accept,fromString2,toString2` + +- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType +`fromString,toString`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXSimpleType + +```java +public PHXSimpleType() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### setUnits + +```java +public void setUnits(java.lang.String u) +``` +Set the units string for the variable +**Specified by:** +: `setUnits`in interface`IPHXUnits` +**Parameters:** +: `u`- units for the variable + +- #### getUnits + +```java +public java.lang.String getUnits() +``` +Get the units string for the variable +**Specified by:** +: `getUnits`in interface`IPHXUnits` +**Returns:** +: units string + +- #### setDescription + +```java +public void setDescription(java.lang.String d) +``` + +- #### getDescription + +```java +public java.lang.String getDescription() +``` + +- #### setHasChanged + +```java +public void setHasChanged(boolean v) +``` +sets the hasChanged flag +**Parameters:** +: `v`- the new value for the flag + +- #### getHasChanged + +```java +public boolean getHasChanged() +``` +retrieves the hasChanged flag +**Returns:** +: true if the variable has changed since the last + time the hasChanged flag was set to false + +- #### addPropertyChangeListener + +```java +public void addPropertyChangeListener(java.beans.PropertyChangeListener l) +``` + +- #### removePropertyChangeListener + +```java +public void removePropertyChangeListener(java.beans.PropertyChangeListener l) +``` + +- #### getEnumTokens + +```java +public static java.lang.String[] getEnumTokens(java.lang.String enums) +``` + +- #### equalsNatural + +```java +public abstract boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public abstract void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### _copyMetadataFromOther + +```java +protected final void _copyMetadataFromOther(PHXSimpleType other) +``` +Copy common metadata on PHXSimpleType from another object to this one. + Designed to assist in implementing[createCopy()](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html#createCopy--). +**Parameters:** +: `other`- the other object from which metadata will be copied + +- #### createCopy + +```java +public abstract PHXSimpleType createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md new file mode 100644 index 0000000000..e9672fa4d5 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md @@ -0,0 +1,355 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXString +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXString +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + +--- + +```java +public class PHXString +extends PHXSimpleType +``` +The Phoenix type for Strings. This class adds the following + features to the PHXSimpleType: +- **value**: String +- **enumValues**: String[] +- **enumAliases**: String[] +**Author:** +: Woyak +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXString()` | +| `PHXString(PHXStringother)`Clone another PHXString's value and metadata. | +| `PHXString(java.lang.String value)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_copyMetadataFromOther(PHXStringother)`Clone another PHXString's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `static java.lang.String` | `arrayToString(java.lang.String[] sa)`Deprecated. | +| `static java.lang.String` | `arrayToStringEscaped(java.lang.String[] sa)`Quotes each element of the array using c-style escape sequences, then + builds a comma separated list of the elements with quotes around each element. | +| `PHXString` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | +| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | +| `java.lang.String[]` | `getEnumValues()`lists enum values | +| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a + comma separated string | +| `java.lang.String` | `getValue()`retrieves the current value of the variable | +| `static void` | `main(java.lang.String[] args)` | +| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`Takes an array of values and fills the enumeration aliases list with values. | +| `void` | `setEnumValues(java.lang.String input)`sets enum values | +| `void` | `setEnumValues(java.lang.String[] values)`sets enum values | +| `void` | `setValue(PHXStringBufferv)`sets the value for the variable | +| `void` | `setValue(java.lang.String v)`sets the value for the variable | +| `static java.lang.String[]` | `stringToArray(java.lang.String s)` | +| `java.lang.String` | `toString()`converts the variable to a string | +| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXString + +```java +public PHXString() +``` + +- #### PHXString + +```java +public PHXString(java.lang.String value) +``` + +- #### PHXString + +```java +public PHXString(PHXString other) +``` +Clone another PHXString's value and metadata. +**Parameters:** +: `other`- the other PHXString to clone. +============ METHOD DETAIL ========== +- ### Method Detail + +- #### getValue + +```java +public java.lang.String getValue() +``` +retrieves the current value of the variable +**Returns:** +: the value of the variable + +- #### setValue + +```java +public void setValue(java.lang.String v) + throws java.lang.IllegalArgumentException +``` +sets the value for the variable +**Parameters:** +: `v`- the value +**Throws:** +: `java.lang.IllegalArgumentException` + +- #### setValue + +```java +public void setValue(PHXStringBuffer v) + throws java.lang.IllegalArgumentException +``` +sets the value for the variable +**Parameters:** +: `v`- the value +**Throws:** +: `java.lang.IllegalArgumentException` + +- #### toString2 + +```java +public PHXStringBuffer toString2() +``` +converts the variable to a PHXStringBuffer +**Returns:** +: a PHXStringBuffer representation of the variable + +- #### toString + +```java +public java.lang.String toString() +``` +converts the variable to a string +**Specified by:** +: `toString`in interface`IPHXType` +**Overrides:** +: `toString`in class`java.lang.Object` +**Returns:** +: a String representation of the variable + +- #### fromString2 + +```java +public void fromString2(PHXStringBuffer value) +``` +converts a PHXStringBuffer representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### fromString + +```java +public void fromString(java.lang.String value) +``` +converts a String representation to the internal value +**Parameters:** +: `value`- the value to convert + +- #### getEnumValues + +```java +public java.lang.String[] getEnumValues() +``` +lists enum values +**Returns:** +: enum values + +- #### getEnumValuesStr + +```java +public java.lang.String getEnumValuesStr() +``` +Interface function to pass out the enumeration array as a + comma separated string +**Returns:** +: comma separated string of the possible values of the list + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String input) +``` +sets enum values +**Parameters:** +: `input:`- list of enum values + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String[] values) +``` +sets enum values +**Parameters:** +: `values:`- list of enum values + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration aliases list with values. +**Parameters:** +: `values`- A comma seperated string of enumeration aliases + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String[] values) +``` +Takes an array of values and fills the enumeration aliases list with values. If null, aliases will be set to + an empty list. +**Parameters:** +: `values`- string array of enumeration aliases + +- #### getEnumAliases + +```java +public java.lang.String[] getEnumAliases() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumAliasesStr + +```java +public java.lang.String getEnumAliasesStr() +``` +An interface function for the enumeration array +**Returns:** +: an comma separated string of the possible values of the list + +- #### _copyMetadataFromOther + +```java +protected final void _copyMetadataFromOther(PHXString other) +``` +Clone another PHXString's metadata. +**Parameters:** +: `other`- the other PHXString + +- #### arrayToString + +```java +@Deprecated +public static java.lang.String arrayToString(java.lang.String[] sa) +``` +Deprecated.Do not use, does not generate correct strings. +**Parameters:** +: `sa`- +**Returns:** + +- #### stringToArray + +```java +public static java.lang.String[] stringToArray(java.lang.String s) +``` + +- #### arrayToStringEscaped + +```java +public static java.lang.String arrayToStringEscaped(java.lang.String[] sa) +``` +Quotes each element of the array using c-style escape sequences, then + builds a comma separated list of the elements with quotes around each element. +**Parameters:** +: `sa`- The array to read +**Returns:** +: The generated string. + +- #### main + +```java +public static void main(java.lang.String[] args) +``` + +- #### equalsNatural + +```java +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException +``` +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, + and may behave oddly if put in those circumstances. +**Specified by:** +: `equalsNatural`in class`PHXSimpleType` +**Parameters:** +: `toCompare`- +**Returns:** +: a negative number if this object is less than toCompare, a positive number if this object is greater than + to compare, and zero if these two objects are equal. +**Throws:** +: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXString createCopy() +``` +Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md new file mode 100644 index 0000000000..ef74453fcc --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md @@ -0,0 +1,353 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXStringArray +- java.lang.Object +- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html)> +- - com.phoenix_int.aserver.types.PHXStringArray +- **All Implemented Interfaces:** +: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html)> + +--- + +```java +public class PHXStringArray +extends PHXSimpleArray +``` +Class wraps an array of PHXString variables + for the ScriptWrapper utility. +**Version:** +: May 2002 +**Author:** +: Nathan P Sharp +**See Also:** +: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== +- ### Nested Class Summary + +- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` +=========== FIELD SUMMARY =========== +- ### Field Summary + +- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data,_lockDims,_lockResize` +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXStringArray()` | +| `PHXStringArray(java.lang.Object data)` | +| `PHXStringArray(PHXStringArrayother)` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. | +| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data + in this object. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +| `PHXStringArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified + class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. | +| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | +| `java.lang.String[]` | `getEnumValues()`An interface function for the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a + comma separated string | +| `java.lang.String` | `getStringValue(int index)`Gets a particular element as a String | +| `java.lang.String` | `getStringValue(int[] index)`Gets a particular element as a String | +| `PHXString` | `getValue(int[] index)`Gets a particular element as a PHXString | +| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | +| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the + enumeration List with values. | +| `void` | `setEnumValues(java.lang.String[] values)`sets enum values | +| `void` | `setValue(int[] index,PHXStringval)`Sets a particular element as a PHXString | +| `void` | `setValue(int[] index, + java.lang.String val)`Sets a particular element as a String | +| `void` | `setValue(int index, + java.lang.String val)`Sets a particular element as a String | + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData,_setMetaData,allocateElement,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` + +- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +- ### Methods inherited from interface java.lang.Iterable +`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXStringArray + +```java +public PHXStringArray() +``` + +- #### PHXStringArray + +```java +public PHXStringArray(java.lang.Object data) +``` + +- #### PHXStringArray + +```java +public PHXStringArray(PHXStringArray other) +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### dataTypeOK + +```java +protected boolean dataTypeOK(java.lang.Class c) +``` +Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified + class is acceptable as an array element component type. +**Specified by:** +: `dataTypeOK`in class`PHXSimpleArray` + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration List with values. +**Parameters:** +: `values`- A comma seperrated string of enumeration values + +- #### setEnumValues + +```java +public void setEnumValues(java.lang.String[] values) +``` +sets enum values +**Parameters:** +: `values:`- list of enum values + +- #### getEnumValues + +```java +public java.lang.String[] getEnumValues() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumValuesStr + +```java +public java.lang.String getEnumValuesStr() +``` +Interface function to pass out the enumeration array as a + comma separated string +**Returns:** +: comma separated string of the possible values of the list + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String values) +``` +takes a comma seperated string of values and fills the + enumeration aliases list with values. +**Parameters:** +: `values`- A comma seperated string of enumeration aliases + +- #### setEnumAliases + +```java +public void setEnumAliases(java.lang.String[] values) +``` +Sets the enumeration aliases list +**Parameters:** +: `values`- An array of strings + +- #### getEnumAliases + +```java +public java.lang.String[] getEnumAliases() +``` +An interface function for the enumeration array +**Returns:** +: an array of the possible values of the list + +- #### getEnumAliasesStr + +```java +public java.lang.String getEnumAliasesStr() +``` +An interface function for the enumeration array +**Returns:** +: an comma separated string of the possible values of the list + +- #### _setMetaData + +```java +protected void _setMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data + in this object. Override this to set additional + information in sub-classes. Be sure to call + super._setMetaData(PHXSimpleType) +**Overrides:** +: `_setMetaData`in class`PHXSimpleArray` + +- #### _getMetaData + +```java +protected void _getMetaData(PHXSimpleType v2) +``` +Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType + and sets it into our meta data. Override this in order to add + more custom meta data in sub-classes. Be sure to cal + super._getMetaData(PHXSimpleType), though! +**Overrides:** +: `_getMetaData`in class`PHXSimpleArray` + +- #### getValue + +```java +public PHXString getValue(int[] index) +``` +Gets a particular element as a PHXString +**Specified by:** +: `getValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- 1D array index +**Returns:** +: referenced array value + +- #### getStringValue + +```java +public java.lang.String getStringValue(int index) +``` +Gets a particular element as a String +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### getStringValue + +```java +public java.lang.String getStringValue(int[] index) +``` +Gets a particular element as a String +**Parameters:** +: `index`- nD array index +**Returns:** +: referenced array value + +- #### setValue + +```java +public void setValue(int[] index, + PHXString val) +``` +Sets a particular element as a PHXString +**Specified by:** +: `setValue`in class`PHXSimpleArray` +**Parameters:** +: `index`- 1D array index +: `val`- value to set + +- #### setValue + +```java +public void setValue(int index, + java.lang.String val) +``` +Sets a particular element as a String +**Parameters:** +: `index`- 1D array index +: `val`- value to set +**Throws:** +: `java.lang.IllegalArgumentException`- thrown if called on non-1D array + +- #### setValue + +```java +public void setValue(int[] index, + java.lang.String val) +``` +Sets a particular element as a String +**Parameters:** +: `index`- 1D array index +: `val`- value to set + +- #### elementFromString + +```java +protected java.lang.Object elementFromString(java.lang.String val) +``` +Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function + which converts a string form of a single element to Object + form. This is only used when the element type does not + implement IPHXType or IPHXType2. For primitives, return + the wrapper objects. +**Specified by:** +: `elementFromString`in class`PHXSimpleArray` + +- #### fromObject + +```java +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException +``` +Load the value of this object from the specified object. This will read the object and attempt to convert it if it + is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in + conversion, it will also throw a PHXInvalidTypeException + + NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an + array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + array formatting style. +**Specified by:** +: `fromObject`in class`PHXSimpleType` +**Parameters:** +: `toRead`- to object from which to load this objects value. +**Throws:** +: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. + +- #### Accept + +```java +public  T Accept(IPHXType2.IVisitor visitor) +``` +Accept a Visitor. +**Type Parameters:** +: `T`- Type of the result of the visit. +**Parameters:** +: `visitor`- The visitor to accept. +**Returns:** +: The results of the visit. + +- #### createCopy + +```java +public PHXStringArray createCopy() +``` +Description copied from class:`PHXSimpleType`Create a copy of this instance, including the value and metadata. +**Specified by:** +: `createCopy`in class`PHXSimpleType` +**Returns:** +: a newly constructed copy of this instance. +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md new file mode 100644 index 0000000000..121d60d49d --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md @@ -0,0 +1,343 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXTypeFactory +- java.lang.Object +- - com.phoenix_int.aserver.types.PHXTypeFactory +- --- + +```java +public class PHXTypeFactory +extends java.lang.Object +``` +A class for creating variables +**Author:** +: Woyak, 6/00 +**See Also:** +: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- =========== FIELD SUMMARY =========== +- ### Field Summary + +| Modifier and Type | Field and Description | +| --- | --- | +| Modifier and Type | Field and Description | +| `static java.lang.String` | `BOOLEAN`Type identifier for a boolean type | +| `static java.lang.String` | `BOOLEAN_ARRAY`Type identifier for a boolean array type | +| `static java.lang.String` | `DOUBLE`Type identifier for a double type | +| `static java.lang.String` | `DOUBLE_ARRAY`Type identifier for a double array type | +| `static java.lang.String` | `FILE`Type identifier for a file type | +| `static java.lang.String` | `FILE_ARRAY`Type identifier for a file array type | +| `static java.lang.String` | `GEOMETRY`Type identifier for a geometry type | +| `static java.lang.String` | `LONG`Type identifier for a long type | +| `static java.lang.String` | `LONG_ARRAY`Type identifier for a long array type | +| `static java.lang.String` | `OBJECT`Type identifier for an object type | +| `static java.lang.String` | `REFERENCE`Type identifier for a reference type | +| `static java.lang.String` | `REFERENCE_ARRAY`Type identifier for a reference array type | +| `static java.lang.String` | `STRING`Type identifier for a string type | +| `static java.lang.String` | `STRING_ARRAY`Type identifier for a string array type | +| `static java.lang.String` | `UNKNOWN`Type identifier for an unknown type | +| `static java.lang.String` | `UNKNOWN_ARRAY`Type identifier for an unknown array type | +======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXTypeFactory()` | +========== METHOD SUMMARY =========== +- ### Method Summary + +| Modifier and Type | Method and Description | +| --- | --- | +| Modifier and Type | Method and Description | +| `static void` | `_verifyIsArrayType(java.lang.String type)`utility function for verifying that a type string is an + array type - it is in the form "XXXX[#]" | +| `staticPHXSimpleArray` | `allocateArray(java.lang.String arrayType)`Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays + and non-array types. | +| `staticIPHXType2` | `allocateVariable(java.lang.String type)`Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays + and non-array types. | +| `staticIPHXType2` | `allocateVariable2(java.lang.String type)`Allocate a given variable for the given type string | +| `static java.lang.Class` | `getClass(java.lang.String type)`returns the class for the specified type. | +| `static java.lang.Class` | `getVariableClass(java.lang.String type)`Returns the class associated with the type string. | +| `static java.lang.String` | `getVarType(java.lang.String className)`Given the class name, determine the corresponding type. | +| `staticPHXSimpleType` | `toPHXSimpleType(java.lang.Object input, + java.lang.Class simpleTypeClass)`Converts the given type to the associated PHXSimpleType. | + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ FIELD DETAIL =========== +- ### Field Detail + +- #### UNKNOWN + +```java +public static final java.lang.String UNKNOWN +``` +Type identifier for an unknown type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.UNKNOWN) + +- #### UNKNOWN_ARRAY + +```java +public static final java.lang.String UNKNOWN_ARRAY +``` +Type identifier for an unknown array type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.UNKNOWN_ARRAY) + +- #### BOOLEAN + +```java +public static final java.lang.String BOOLEAN +``` +Type identifier for a boolean type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.BOOLEAN) + +- #### BOOLEAN_ARRAY + +```java +public static final java.lang.String BOOLEAN_ARRAY +``` +Type identifier for a boolean array type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.BOOLEAN_ARRAY) + +- #### DOUBLE + +```java +public static final java.lang.String DOUBLE +``` +Type identifier for a double type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.DOUBLE) + +- #### DOUBLE_ARRAY + +```java +public static final java.lang.String DOUBLE_ARRAY +``` +Type identifier for a double array type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.DOUBLE_ARRAY) + +- #### LONG + +```java +public static final java.lang.String LONG +``` +Type identifier for a long type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.LONG) + +- #### LONG_ARRAY + +```java +public static final java.lang.String LONG_ARRAY +``` +Type identifier for a long array type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.LONG_ARRAY) + +- #### FILE + +```java +public static final java.lang.String FILE +``` +Type identifier for a file type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.FILE) + +- #### FILE_ARRAY + +```java +public static final java.lang.String FILE_ARRAY +``` +Type identifier for a file array type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.FILE_ARRAY) + +- #### STRING + +```java +public static final java.lang.String STRING +``` +Type identifier for a string type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.STRING) + +- #### STRING_ARRAY + +```java +public static final java.lang.String STRING_ARRAY +``` +Type identifier for a string array type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.STRING_ARRAY) + +- #### GEOMETRY + +```java +public static final java.lang.String GEOMETRY +``` +Type identifier for a geometry type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.GEOMETRY) + +- #### OBJECT + +```java +public static final java.lang.String OBJECT +``` +Type identifier for an object type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.OBJECT) + +- #### REFERENCE + +```java +public static final java.lang.String REFERENCE +``` +Type identifier for a reference type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.REFERENCE) + +- #### REFERENCE_ARRAY + +```java +public static final java.lang.String REFERENCE_ARRAY +``` +Type identifier for a reference array type +**See Also:** +: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.REFERENCE_ARRAY) +========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXTypeFactory + +```java +public PHXTypeFactory() +``` +============ METHOD DETAIL ========== +- ### Method Detail + +- #### allocateVariable2 + +```java +public static IPHXType2 allocateVariable2(java.lang.String type) + throws PHXInvalidTypeException +``` +Allocate a given variable for the given type string +**Parameters:** +: `type`- the type of the variable to instantiate +**Returns:** +: the instantiated variable +**Throws:** +: `PHXInvalidTypeException` + +- #### allocateVariable + +```java +@Deprecated +public static IPHXType2 allocateVariable(java.lang.String type) + throws PHXInvalidTypeException +``` +Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays + and non-array types.creates a variable from a type string +**Parameters:** +: `type`- the type string, e.g. "double" +**Returns:** +: the allocated variable +**Throws:** +: `PHXInvalidTypeException` + +- #### allocateArray + +```java +@Deprecated +public static PHXSimpleArray allocateArray(java.lang.String arrayType) + throws PHXInvalidTypeException +``` +Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays + and non-array types.creates an array from a type string. + Creates the PHXSimpleArray type, although it overrides the default + behaviour of having he PHXSimpleArray store primitives internally + in favor of having it store the PHX type. +**Parameters:** +: `arrayType`- the type string, e.g. "double[5]", "string[3][3]", etc. +**Returns:** +: the allocated variable +**Throws:** +: `PHXInvalidTypeException` + +- #### _verifyIsArrayType + +```java +public static void _verifyIsArrayType(java.lang.String type) + throws PHXInvalidTypeException +``` +utility function for verifying that a type string is an + array type - it is in the form "XXXX[#]" +**Parameters:** +: `type`- the type string +**Throws:** +: `PHXInvalidTypeException` + +- #### getClass + +```java +public static java.lang.Class getClass(java.lang.String type) + throws PHXInvalidTypeException +``` +returns the class for the specified type. If the specified type is an + array, the class of one of it's members is returned +**Parameters:** +: `type`- the type string in format "double" or "double[5]" +**Returns:** +: the class of the specified type +**Throws:** +: `PHXInvalidTypeException` + +- #### getVariableClass + +```java +public static java.lang.Class getVariableClass(java.lang.String type) + throws PHXInvalidTypeException +``` +Returns the class associated with the type string. This includes array classes if the type ends with "[]" or "Array" +**Parameters:** +: `type`- the string representing the type, such as "string", "double[]", or "IntegerArray" +**Returns:** +: the class of the variable type +**Throws:** +: `PHXInvalidTypeException`- if the type string does not match a known type + +- #### getVarType + +```java +public static java.lang.String getVarType(java.lang.String className) +``` +Given the class name, determine the corresponding type. +**Parameters:** +: `className`- class name of the variable, i.e. "PHXDouble", "PHXDoubleArray", etc. +**Returns:** +: variable name type, i.e. "double", "double[]", etc. + +- #### toPHXSimpleType + +```java +public static PHXSimpleType toPHXSimpleType(java.lang.Object input, + java.lang.Class simpleTypeClass) + throws PHXTypeMismatchException +``` +Converts the given type to the associated PHXSimpleType. This will always create a new object, regardless of + whether or not the given type is a PHXSimpleType. If there is an error converting, or the class does not have an + associated PHXSimpleType, this will throw a PHXInvalidTypeException +**Parameters:** +: `input`- the object to convert to a PHXSimpleType +: `simpleTypeClass`- the class of PHXSimpleType to convert to +**Returns:** +: a new object containing the value of the input; in the case of PHXRawFile and PHXRawFileArray, only a new + instance is returned, the value is not copied +**Throws:** +: `PHXTypeMismatchException`- if there is an error creating the PHXSimpleType object, or if the given type + cannot be converted to a PHXSimpleType +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md new file mode 100644 index 0000000000..dc5a8d8c46 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md @@ -0,0 +1,80 @@ +======== START OF CLASS DATA ======== +com.phoenix_int.aserver.types +## Class PHXTypeMismatchException +- java.lang.Object +- - java.lang.Throwable +- - java.lang.Exception +- - com.phoenix_int.aserver.types.PHXTypeMismatchException +- **All Implemented Interfaces:** +: java.io.Serializable + +--- + +```java +public class PHXTypeMismatchException +extends java.lang.Exception +``` +An exception thrown when trying to set a value using an incompatible type, or when trying to + compare two values of incompatible types +**See Also:** +: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.types.PHXTypeMismatchException)- ======== CONSTRUCTOR SUMMARY ======== +- ### Constructor Summary + +| Constructor and Description | +| --- | +| Constructor and Description | +| `PHXTypeMismatchException(java.lang.String givenType, + java.lang.String expectedType)`Create an exception for attempting to compare two values of incompatible types | +| `PHXTypeMismatchException(java.lang.String name, + java.lang.String type, + java.lang.String expectedType)`Create an exception for attempting to set a value using an incompatible type | +| `PHXTypeMismatchException(java.lang.String givenType, + java.lang.String expectedType, + java.lang.Throwable cause)`Create an exception for attempting to compare two values of incompatible types | +========== METHOD SUMMARY =========== +- ### Method Summary + +- ### Methods inherited from class java.lang.Throwable +`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` + +- ### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== +- ### Constructor Detail + +- #### PHXTypeMismatchException + +```java +public PHXTypeMismatchException(java.lang.String name, + java.lang.String type, + java.lang.String expectedType) +``` +Create an exception for attempting to set a value using an incompatible type +**Parameters:** +: `name`- the name of the variable where the error occurred +: `type`- the bad type +: `expectedType`- the type that should have been used + +- #### PHXTypeMismatchException + +```java +public PHXTypeMismatchException(java.lang.String givenType, + java.lang.String expectedType) +``` +Create an exception for attempting to compare two values of incompatible types +**Parameters:** +: `givenType`- the bad type that was passed to the comparator +: `expectedType`- the type expected by the comparator + +- #### PHXTypeMismatchException + +```java +public PHXTypeMismatchException(java.lang.String givenType, + java.lang.String expectedType, + java.lang.Throwable cause) +``` +Create an exception for attempting to compare two values of incompatible types +**Parameters:** +: `givenType`- the bad type that was passed to the comparator +: `expectedType`- the type expected by the comparator +: `cause`- exception which caused this exception to be thrown +========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-frame.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-frame.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md new file mode 100644 index 0000000000..9cbcdd821b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md @@ -0,0 +1,90 @@ +# Package com.phoenix_int.aserver.types +Provides a collection of basic data types that contain meta-information +like description and units. +See:Description +- | Interface | Description | +| --- | --- | +| [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html) | Interface for types with descriptions | +| [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html) | Interface for variables that support formats | +| [IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) | This interface provides information about a reference property:**name**: String**type**: String**enumValues**: String[]**description**: String**title**: String**input**: boolean + + + where type may be any of the following: + + + "long" + "double" + "boolean" + "string" | +| [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html) | The interface for all Phoenix types. | +| [IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) | The interface for Phoenix types which use PHXStringBuffer instead of String for performance. | +| [IPHXType2.IVisitor](../../../../com/phoenix_int/aserver/types/IPHXType2.IVisitor.html) | The interface of a visitor into an IPHXType2. | +| [IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) | Interface for PHX variables that support units | +- | Class | Description | +| --- | --- | +| [PHXAppearance](../../../../com/phoenix_int/aserver/types/PHXAppearance.html) | This is a utility class for holding appearance properties. | +| [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html) | The Phoenix type for booleans. | +| [PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html) | Class wraps an array of PHXBoolean variables + for the ScriptWrapper utility. | +| [PHXDataCollector](../../../../com/phoenix_int/aserver/types/PHXDataCollector.html) | A class for Driver Components to tell ModelCenter what to do with the + DataCollector while the component is running. | +| [PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html) | The Phoenix type for doubles. | +| [PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html) | Class wraps an array of PHXDouble variables + for the ScriptWrapper utility. | +| [PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html) | Deprecated | +| [PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html) | The Phoenix type for geometry. | +| [PHXGeomInfo](../../../../com/phoenix_int/aserver/types/PHXGeomInfo.html) | this is a utility class that mirrors the structures in ModelCenter. | +| [PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html) | Deprecated | +| [PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html) | The Phoenix type for longs. | +| [PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html) | Class wraps an array of PHXLong variables + for the ScriptWrapper utility. | +| [PHXMassProperties](../../../../com/phoenix_int/aserver/types/PHXMassProperties.html) | This is a utility class for holding mass property information. | +| [PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html) | Placeholder for an array of any random Java Object. | +| [PHXOrientation](../../../../com/phoenix_int/aserver/types/PHXOrientation.html) | This is a utility class for holding orientation information. | +| [PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html) | The Phoenix type for Files. | +| [PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html) | Wraps an array of PHXRawFile variables + for the ScriptWrapper utility. | +| [PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html) | This is a class for holding properties of a reference + object**type**: String**enumValues**: String[]**description**: String**title**: String**input**: boolean + + + where type may be any of the following: + + + "long" + "double" + "boolean" + "string" | +| [PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html) | The Phoenix type for references. | +| [PHXReferenceArray](../../../../com/phoenix_int/aserver/types/PHXReferenceArray.html) | The Phoenix type for references. | +| [PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html) | This is a class for holding properties of a reference + object**type**: String**enumValues**: String[]**description**: String**title**: String**input**: boolean + + + where type may be any of the following: + + + "long" + "double" + "boolean" + "string" | +| [PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html) | The PHX type for object variables. | +| [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) | This class enables components to create resizeable + arrays where the number of dimensions is variable + as well as the size of each dimension. | +| [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) | A base class for most Phoenix data types. | +| [PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html) | The Phoenix type for Strings. | +| [PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) | Class wraps an array of PHXString variables + for the ScriptWrapper utility. | +| [PHXTypeFactory](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html) | A class for creating variables | +- | Exception | Description | +| --- | --- | +| [PHXInvalidTypeException](../../../../com/phoenix_int/aserver/types/PHXInvalidTypeException.html) | An exception that is thrown when trying to use a bad type | +| [PHXNumberFormatException](../../../../com/phoenix_int/aserver/types/PHXNumberFormatException.html) | Like a NumberFormatException except that it isn't a runtime exception + and must be caught | +| [PHXTypeMismatchException](../../../../com/phoenix_int/aserver/types/PHXTypeMismatchException.html) | An exception thrown when trying to set a value using an incompatible type, or when trying to + compare two values of incompatible types | + +## Package com.phoenix_int.aserver.types Description +Provides a collection of basic data types that contain meta-information +like description and units.Put @see and @since tags down here. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md new file mode 100644 index 0000000000..3cecc8b029 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md @@ -0,0 +1,48 @@ +# Hierarchy For Package com.phoenix_int.aserver.types +Package Hierarchies: +- [All Packages](../../../../overview-tree.html) +## Class Hierarchy + +- java.lang.Object +- com.phoenix_int.aserver.types.[PHXAppearance](../../../../com/phoenix_int/aserver/types/PHXAppearance.html) +- com.phoenix_int.aserver.types.[PHXDataCollector](../../../../com/phoenix_int/aserver/types/PHXDataCollector.html) +- com.phoenix_int.aserver.types.[PHXGeomInfo](../../../../com/phoenix_int/aserver/types/PHXGeomInfo.html) +- com.phoenix_int.aserver.types.[PHXMassProperties](../../../../com/phoenix_int/aserver/types/PHXMassProperties.html) +- com.phoenix_int.aserver.types.[PHXOrientation](../../../../com/phoenix_int/aserver/types/PHXOrientation.html) +- com.phoenix_int.aserver.types.[PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html)(implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html)) +- com.phoenix_int.aserver.types.[PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html)(implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html), com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html)) +- com.phoenix_int.aserver.types.[PHXReferenceArray](../../../../com/phoenix_int/aserver/types/PHXReferenceArray.html)(implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html)) +- com.phoenix_int.aserver.types.[PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html)(implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html)) +- com.phoenix_int.aserver.types.[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)(implements com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.aserver.types.[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html)) +- com.phoenix_int.aserver.types.[PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html) +- com.phoenix_int.aserver.types.[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html) +- com.phoenix_int.aserver.types.[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html) +- com.phoenix_int.aserver.types.[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html)(implements java.lang.AutoCloseable, com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html)) +- com.phoenix_int.aserver.types.[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html) +- com.phoenix_int.aserver.types.[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) (implements com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html), java.lang.Iterable) +- com.phoenix_int.aserver.types.[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html) +- com.phoenix_int.aserver.types.[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html) +- com.phoenix_int.aserver.types.[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html) +- com.phoenix_int.aserver.types.[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) +- com.phoenix_int.aserver.types.[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html) +- com.phoenix_int.aserver.types.[PHXTypeFactory](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html) +- java.lang.Throwable (implements java.io.Serializable) +- java.lang.Exception +- com.phoenix_int.aserver.types.[PHXInvalidTypeException](../../../../com/phoenix_int/aserver/types/PHXInvalidTypeException.html) +- com.phoenix_int.aserver.types.[PHXNumberFormatException](../../../../com/phoenix_int/aserver/types/PHXNumberFormatException.html) +- com.phoenix_int.aserver.types.[PHXTypeMismatchException](../../../../com/phoenix_int/aserver/types/PHXTypeMismatchException.html) + +## Interface Hierarchy + +- com.phoenix_int.aserver.types.[IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html) +- com.phoenix_int.aserver.types.[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) +- com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html) +- com.phoenix_int.aserver.types.[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html) +- com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) +- com.phoenix_int.aserver.types.[IPHXType2.IVisitor](../../../../com/phoenix_int/aserver/types/IPHXType2.IVisitor.html) +- com.phoenix_int.aserver.types.[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md new file mode 100644 index 0000000000..9e92143d2f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md @@ -0,0 +1,49 @@ +# Interface: IPHXLineStore + +**Package:** `com.phoenix_int.aserver.util` + +**Declaration** + +```java +public interface IPHXLineStore +``` + +This is the interface for holding a set of lines. It is used by the `PHXFileParser` class. Concrete classes include `PHXFileLineStore` and `PHXRandomAccessFileLineStore`. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `close()`
Closes any resources associated with this line store | +| `java.lang.String` | `getLine(int index)`
Retrieves the specified line | +| `int` | `getNumLines()`
Gets the total number of lines | + +## Method Detail + +### getNumLines + +```java +int getNumLines() +``` +Gets the total number of lines + +### getLine + +```java +java.lang.String getLine(int index) + throws java.io.IOException +``` +Retrieves the specified line + +**Parameters:** +- `index` - the index of the line to retrieve + +**Throws:** +- `java.io.IOException` + +### close + +```java +void close() +``` +Closes any resources associated with this line store \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md new file mode 100644 index 0000000000..e42622403a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md @@ -0,0 +1,38 @@ +## Interface: IPHXStringReplacer + +**Package:** `com.phoenix_int.aserver.util` + +--- + +**Declaration** + +```java +public interface IPHXStringReplacer +``` + +This is the interface for replacing strings, used by the PHXStringReplacer class. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getReplacement(java.lang.String s)`
replaces the specified string with some other value. | + +## Method Detail + +### getReplacement + +```java +java.lang.String getReplacement(java.lang.String s) + throws PHXNoSuchReplacementException +``` +replaces the specified string with some other value. If the string does not match a known entity, just return it. + +**Parameters:** +- `s` - the String to replace + +**Returns:** +- the replacement + +**Throws:** +- `PHXNoSuchReplacementException` - thrown if no replacement exists \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXClassNotFoundException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXClassNotFoundException.md new file mode 100644 index 0000000000..e7373f53fd --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXClassNotFoundException.md @@ -0,0 +1,81 @@ +# Class: PHXClassNotFoundException + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ java.lang.ReflectiveOperationException + ↳ java.lang.ClassNotFoundException + ↳ com.phoenix_int.aserver.util.PHXClassNotFoundException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** + +```java +public class PHXClassNotFoundException +extends java.lang.ClassNotFoundException +``` + +Simple wrapper for ClassNotFoundException which can contain additional logging info. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXClassNotFoundException()`
Creates a new instance of PHXClassNotFoundException | +| `PHXClassNotFoundException(java.lang.String message)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addException(java.lang.Exception e)` | +| `java.util.Iterator` | `getExceptions()` | + +### Methods inherited from class java.lang.ClassNotFoundException +`getCause`, `getException` + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXClassNotFoundException + +```java +public PHXClassNotFoundException() +``` +Creates a new instance of PHXClassNotFoundException + +### PHXClassNotFoundException + +```java +public PHXClassNotFoundException(java.lang.String message) +``` + +## Method Detail + +### addException + +```java +public void addException(java.lang.Exception e) +``` + +### getExceptions + +```java +public java.util.Iterator getExceptions() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileLoader.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileLoader.md new file mode 100644 index 0000000000..e62e3b1aeb --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileLoader.md @@ -0,0 +1,175 @@ +# Class: PHXFileLoader + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXFileLoader +``` +--- +**Declaration** + +```java +public class PHXFileLoader +extends java.lang.Object +``` + +This is a utility class for loading data files. The class makes it easy to load files, line by line while ignoring comments (lines that begin with #). + +Sample Usage: + +```java +PHXFileLoader fl; + +try { + fl = new PHXFileLoader( "myfile.dat" ); +} catch ( IOException e ) { + System.out.println( e ); +} + +String line = fl.nextLine(); + +while ( line != null ) { + // process line + ... + line = fl.nextLine(); +} + +fl.close(); +``` + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXFileLoader(java.lang.String fileName)` | +| `PHXFileLoader(java.io.File file)` | +| `PHXFileLoader(java.io.StringReader inStream)` | +| `PHXFileLoader(java.io.InputStream inStream)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `close()`
closes the file | +| `void` | `finalize()` | +| `java.lang.String` | `getFileName()`
retrieves the file name | +| `int` | `getLineNumber()`
returns the line number of the last line read. | +| `java.lang.String` | `getRemainder()`
returns the rest of the file as a string | +| `java.lang.String` | `nextLine()`
extracts the next non-comment line from the data file | +| `java.lang.String` | `readNextLine()`
extracts the next line from the data file | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXFileLoader + +```java +public PHXFileLoader(java.lang.String fileName) + throws java.io.IOException +``` +**Parameters:** +- `fileName` - the file to load +**Throws:** +- `java.io.IOException` - if there is a problem opening the file + +### PHXFileLoader + +```java +public PHXFileLoader(java.io.File file) + throws java.io.IOException +``` +**Parameters:** +- `file` - the file to load +**Throws:** +- `java.io.IOException` - if there is a problem opening the file + +### PHXFileLoader + +```java +public PHXFileLoader(java.io.StringReader inStream) + throws java.io.IOException +``` +**Throws:** +- `java.io.IOException` + +### PHXFileLoader + +```java +public PHXFileLoader(java.io.InputStream inStream) + throws java.io.IOException +``` +**Throws:** +- `java.io.IOException` + +## Method Detail + +### finalize + +```java +public void finalize() +``` + +**Overrides:** +- `finalize` in class `java.lang.Object` + +### close + +```java +public void close() +``` +closes the file + +### getFileName + +```java +public java.lang.String getFileName() +``` +retrieves the file name + +**Returns:** +- the name of the file + +### getLineNumber + +```java +public int getLineNumber() +``` +returns the line number of the last line read. Indexing starts at 1 + +**Returns:** +- the last line number + +### nextLine + +```java +public java.lang.String nextLine() +``` +extracts the next non-comment line from the data file + +**Returns:** +- a non-comment line + +### readNextLine + +```java +public java.lang.String readNextLine() +``` +extracts the next line from the data file + +**Returns:** +- a line + +### getRemainder + +```java +public java.lang.String getRemainder() +``` +returns the rest of the file as a string + +**Returns:** +- the remaining contents of the file \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileName.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileName.md new file mode 100644 index 0000000000..317ca74ed7 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileName.md @@ -0,0 +1,122 @@ +# Class: PHXFileName + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXFileName +``` + +--- + +**Declaration** + +```java +public class PHXFileName +extends java.lang.Object +``` + +This is a utility class for easily managing file names. The class lets you specify a name, and optionally a base name. If the name fully specifies the file, then the base name is ignored. If not, then the base name may be modified to find the file in different locations. + +e.g.: + +```java + name set base name to resulting fullName + ----------- ------------------ -------------------- + /usr/bin /users/woyak /usr/bin + c:/usr/bin d:/users/woyak c:/usr/bin + usr/bin /home/woyak /home/woyak/usr/bin +``` + +A `PHXStringReplacer` may be specified for use in forming the fullName. If a replacer is specified, both the name and base name will be passed through it before trying to form the fullName. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXFileName()` | +| `PHXFileName(java.lang.String baseName, java.lang.String name)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getBaseName()` | +| `java.lang.String` | `getFullName()`
returns the full file name. | +| `java.lang.String` | `getFullNameCoded()`
returns the full file name in coded form, i.e. | +| `java.lang.String` | `getName()` | +| `void` | `setBaseName(java.lang.String baseName)`
sets the base name for the file. | +| `void` | `setName(java.lang.String name)`
sets the name for the file | +| `void` | `setStringReplacer(PHXStringReplacer r)`
sets the string replacer for the forming the real file name | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXFileName + +```java +public PHXFileName() +``` + +### PHXFileName + +```java +public PHXFileName(java.lang.String baseName, + java.lang.String name) +``` + +## Method Detail + +### setStringReplacer + +```java +public void setStringReplacer(PHXStringReplacer r) +``` +sets the string replacer for the forming the real file name + +### setName + +```java +public void setName(java.lang.String name) +``` +sets the name for the file + +### getName + +```java +public java.lang.String getName() +``` + +### setBaseName + +```java +public void setBaseName(java.lang.String baseName) +``` +sets the base name for the file. If the file was fully specified, then this function does nothing + +**Parameters:** +- `baseName` - the new baseName + +### getBaseName + +```java +public java.lang.String getBaseName() +``` + +### getFullName + +```java +public java.lang.String getFullName() +``` +returns the full file name. This is the combination of the base name and name parts, unless the name part is fully specified. In that case it is just the name part. + +### getFullNameCoded + +```java +public java.lang.String getFullNameCoded() +``` +returns the full file name in coded form, i.e. variables have not been substituted into it. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md new file mode 100644 index 0000000000..c0f4a90312 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md @@ -0,0 +1,1130 @@ +# Class: PHXFileParser + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXFileParser +``` + +**Implemented Interfaces** + +- `Parser` + +--- + +**Declaration** + +```java +public class PHXFileParser +extends java.lang.Object +implements Parser +``` + +This is a utility class for loading data files and extracting data. + +Sample Usage: + +```java +PHXFileParser fp; + +try { + fp = new PHXFileParser( "myfile.dat" ); +} catch ( IOException e ) { + System.out.println( e ); +} + +try { + int row = 20; + int field = 2; + String token = fp.getToken( row, field ); +} catch ( PHXNoSuchTokenException e ) { + System.out.println( "Error: token not found" ); +} +``` + +NOTES: +- This class works by remembering what things have changed, but not actually performing the changes until the file is written out. This prevents changes to one place in the file from messing up something elsewhere. +- Note however that there is a requirement that no changes overlap or are repeated. For example, you may not set the value of one token twice (the results of which are undefined). Neither may you change a token, then change the delimiters and change another token that includes part of the first. The same holds true for adding and removing lines. You may not add or remove lines to sections of the file previously altered. + +## Nested Class Summary + +| Modifier and Type | Class and Description | +|------------------|----------------------| +| `Parser.Mode` | `Parser.Mode`
Parser modes for file parsing. | + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static int` | `AUTOMATIC`
Deprecated. in favor of `Parser.Mode.AUTOMATIC` | +| `static int` | `BUFFERED`
Deprecated. in favor of `Parser.Mode.BUFFERED` | +| `static long` | `FILE_SIZE_LIMIT`
Deprecated. in favor of `Parser.Mode.FILE_SIZE_LIMIT` | +| `static int` | `FIRST` | +| `static int` | `LAST` | +| `static int` | `RANDOM_ACCESS`
Deprecated. in favor of `Parser.Mode.RANDOM` | +| `static int` | `RESIZE_DISALLOW`
Don't allow the length of an array to change | +| `static int` | `RESIZE_ROWS`
Allow a square matrix to change sizes by adding or deleting rows. | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXFileParser(java.io.File file, Parser.Mode mode)` | +| `PHXFileParser(java.io.File file, Parser.Mode mode, com.phoenix_int.util.PHXFileUtils.Encoding encoding)` | +| `PHXFileParser(IPHXLineStore store, java.lang.String fileName)` | +| `PHXFileParser(java.lang.String fileName)` | +| `PHXFileParser(java.lang.String fileName, int method)`
Deprecated. in favor of `PHXFileParser(String, Parser.Mode)` | +| `PHXFileParser(java.lang.String fileName, Parser.Mode mode)` | +| `PHXFileParser(java.lang.String fileName, Parser.Mode mode, com.phoenix_int.util.PHXFileUtils.Encoding encoding)` | +| `PHXFileParser(java.lang.String fileName, com.phoenix_int.util.PHXFileUtils.Encoding encoding)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addLines(int actualIndex, int count, java.lang.String line)` | +| `void` | `addLines(int actualIndex, java.lang.String[] lines)` | +| `void` | `clearMarks()`resets the file to it's whole size by removing the starting and ending marks if they existed | +| `void` | `close()`Close the parser | +| `void` | `closeFile()`close the PHXRandomAccessFileLineStore | +| `int` | `countTokens(int row)`counts the number of tokens on a specified row | +| `java.lang.String[]` | `getColumnArray(int startRow, int endRow, int field)`gets an array of tokens for the specified range. | +| `char` | `getDecimalSeparator()`gets decimal separator character for floating point literals | +| `java.lang.String` | `getDelimiters()` | +| `java.lang.String` | `getFileName()`retrieves the name of the file that is being parsed | +| `IPHXLineStore` | `getLineStore()`Gets the underlying line store object for this parser | +| `java.lang.String[]` | `getMatrixArray(int startRow, int startField, int endRow, int endField)`gets an array of tokens for the specified range. | +| `java.lang.String[]` | `getMatrixArray(int startRow, int startCol, int endRow, int endCol, int fieldWidth)`gets an array of tokens for the specified range. | +| `java.lang.String[][]` | `getMatrixArray2d(int startRow, int startField, int endRow, int endField)`gets an array of tokens for the specified range. | +| `java.lang.String[]` | `getRowArray(int startCol, int endCol, int row)`gets an array of tokens for the specified range. | +| `java.lang.String` | `getToken(int row, int field)`gets the token at the specified row and field. | +| `java.lang.String` | `getToken(int row, int startCol, int endCol)`gets the token at the specified row and column. | +| `java.util.Vector` | `getToken(int row, int startField, int endField, java.lang.String delimiter)`gets an array of tokens at the specified row and between start and end fields (all inclusive) + Indexing starts at 1. | +| `java.lang.String` | `getToken(java.lang.String string, int rowOffset, int field)`gets the token relative to a search string. | +| `java.lang.String` | `getToken(java.lang.String string, int occurrence, int rowOffset, int field)`gets the token relative to a search string. | +| `static void` | `main(java.lang.String[] args)` | +| `void` | `markBeginning(int row)`marks the starting point from which to start counting rows + and fields. | +| `void` | `markBeginning(java.lang.String string)`same as markBeginning where the pattern is a regex and + ocurence value is 1 | +| `void` | `markBeginning(java.lang.String string, boolean isRegex)`same as markBeginning with an occurrence value of 1 | +| `void` | `markBeginning(java.lang.String string, boolean isRegex, int occurrence)`marks the starting point from which to start counting rows + and fields. | +| `void` | `markBeginning(java.lang.String string, int occurrence)`marks the starting point from which to start counting rows + and fields. | +| `void` | `markBeginningFromEnd(java.lang.String string, boolean isRegex)`marks the starting point from which to start counting rows. | +| `void` | `markBeginningOffset(int offset)`marks the starting point from which to start counting rows + and fields. | +| `void` | `markEnd(int row)`marks the ending point of the file. | +| `void` | `markEnd(java.lang.String string, boolean isRegex)`same as markEnd with an occurrence value of 1 | +| `void` | `markEnd(java.lang.String string, boolean isRegex, int occurrence)`marks the ending point from which to start counting rows + and fields. | +| `void` | `markEnd(java.lang.String string, int occurrence)`marks the ending point from which to start counting rows + and fields. | +| `void` | `markEndFromEnd(java.lang.String string, boolean isRegex)`marks the starting point from which to start counting rows + and fields. | +| `void` | `markEndOffset(int offset)`marks the ending point from which to start counting rows + and fields. | +| `void` | `removeLines(int actualIndex, int count)` | +| `void` | `resetDelimiters()`resets the delimiters to whitespace | +| `void` | `setDecimalSeparator(char separator)`sets decimal separator character for floating point literals | +| `void` | `setDelimiters(java.lang.String delimiters)`sets the current delimiter set | +| `void` | `setMatrixArray(int startRow, int startCol, int endRow, int endCol, int fieldWidth, java.lang.String[] array)`sets an array of tokens for the specified range. | +| `void` | `setMatrixArray(int startRow, int startCol, int endRow, int endCol, int fieldWidth, java.lang.String[] array, int resizeStyle)`sets an array of tokens for the specified range. | +| `void` | `setMatrixArray(int startRow, int startCol, int endRow, int endCol, java.lang.String[] array)`sets an array of tokens for the specified range. | +| `void` | `setMatrixArray(int startRow, int startCol, int endRow, int endCol, java.lang.String[] array, int resizeStyle)`sets an array of tokens for the specified range. | +| `void` | `setMatrixArray2d(int startRow, int startCol, int endRow, int endCol, java.lang.String[][] array, int resizeStyle)`sets an array of tokens for the specified range. | +| `void` | `setToken(int row, int startCol, int endCol, java.lang.String replacement)`replaces the token at the specified row and column. | +| `void` | `setToken(int row, int field, java.lang.String replacement)`replaces the token at the specified row and field. | +| `void` | `setToken(java.lang.String string, int occurrence, int rowOffset, int field, java.lang.String replacement)`gets the token relative to a search string. | +| `void` | `setToken(java.lang.String string, int rowOffset, int field, java.lang.String replacement)`gets the token relative to a search string. | +| `void` | `writeTo(java.io.OutputStream os)` | +| `void` | `writeTo(java.io.OutputStreamWriter fw)`writes out the data to a file | +| `void` | `writeTo(java.lang.String fileName)` | +| `void` | `writeTo(java.lang.String fileName, com.phoenix_int.util.PHXFileUtils.Encoding encoding)` | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### RESIZE_DISALLOW + +```java +public static final int RESIZE_DISALLOW +``` +Don't allow the length of an array to change + +**See Also:** +- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.RESIZE_DISALLOW) + +### RESIZE_ROWS + +```java +public static final int RESIZE_ROWS +``` +Allow a square matrix to change sizes by adding or deleting rows. + +**See Also:** +- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.RESIZE_ROWS) + +### FIRST + +```java +public static final int FIRST +``` + +**See Also:** +- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.FIRST) + +### LAST + +```java +public static final int LAST +``` + +**See Also:** +- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.LAST) + +### RANDOM_ACCESS + +```java +@Deprecated +public static final int RANDOM_ACCESS +``` +Deprecated. in favor of `Parser.Mode.RANDOM` + +### BUFFERED + +```java +@Deprecated +public static final int BUFFERED +``` +Deprecated. in favor of `Parser.Mode.BUFFERED` + +### AUTOMATIC + +```java +@Deprecated +public static final int AUTOMATIC +``` +Deprecated. in favor of `Parser.Mode.AUTOMATIC` + +### FILE_SIZE_LIMIT + +```java +@Deprecated +public static final long FILE_SIZE_LIMIT +``` +Deprecated. in favor of `Parser.Mode.FILE_SIZE_LIMIT` cut-off limit of file size to use buffers for row files + +**See Also:** +- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.FILE_SIZE_LIMIT) + +## Constructor Detail + +### PHXFileParser + +```java +public PHXFileParser(java.lang.String fileName) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### PHXFileParser + +```java +public PHXFileParser(java.lang.String fileName, + com.phoenix_int.util.PHXFileUtils.Encoding encoding) + throws java.io.IOException +``` + +**Parameters:** +- `fileName` - the file to load + +**Throws:** +- `java.io.IOException` - if there is a problem opening the file + +### PHXFileParser + +```java +public PHXFileParser(java.io.File file, + Parser.Mode mode) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### PHXFileParser + +```java +public PHXFileParser(java.io.File file, + Parser.Mode mode, + com.phoenix_int.util.PHXFileUtils.Encoding encoding) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### PHXFileParser + +```java +public PHXFileParser(java.lang.String fileName, + Parser.Mode mode) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### PHXFileParser + +```java +public PHXFileParser(java.lang.String fileName, + Parser.Mode mode, + com.phoenix_int.util.PHXFileUtils.Encoding encoding) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### PHXFileParser + +```java +@Deprecated +public PHXFileParser(java.lang.String fileName, + int method) + throws java.io.IOException +``` +Deprecated. in favor of `PHXFileParser(String, Parser.Mode)` + +**Parameters:** +- `fileName` - the file to load +- `method` - the method used to parse the file. `RANDOM_ACCESS` will scan the data file as needed. `BUFFERED` will read the file into a buffer prior to parsing. `RANDOM_ACCESS` is better for large files, but will be slower for small (<50k) files. `BUFFERED` is also preferable for parsing many variables from a file or for performing large numbers of searches. + +**Throws:** +- `java.io.IOException` - if there is a problem opening the file + +### PHXFileParser + +```java +public PHXFileParser(IPHXLineStore store, + java.lang.String fileName) +``` + +**Parameters:** +- `store` - The source of lines for the file parser. +- `fileName` - The name of the file for errors and advisories. This parameter is not used for any actual processing + +## Method Detail + +### getLineStore + +```java +public IPHXLineStore getLineStore() +``` +Gets the underlying line store object for this parser + +**Returns:** +- the line store used by the parser + +### getFileName + +```java +public java.lang.String getFileName() +``` +retrieves the name of the file that is being parsed + +**Returns:** +- the name of the file + +### writeTo + +```java +public void writeTo(java.lang.String fileName) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### writeTo + +```java +public void writeTo(java.lang.String fileName, + com.phoenix_int.util.PHXFileUtils.Encoding encoding) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### writeTo + +```java +public void writeTo(java.io.OutputStream os) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### writeTo + +```java +public void writeTo(java.io.OutputStreamWriter fw) + throws java.io.IOException +``` +writes out the data to a file + +**Specified by:** +- `writeTo` in interface `Parser` + +**Parameters:** +- `fw` - the stream to save to + +**Throws:** +- `java.io.IOException` - thrown if the file cannot be written to + +### close + +```java +public void close() +``` +Description copied from interface: `Parser` + +Close the parser + +**Specified by:** +- `close` in interface `Parser` + +### closeFile + +```java +public void closeFile() +``` +close the `PHXRandomAccessFileLineStore` + +### resetDelimiters + +```java +public void resetDelimiters() +``` +resets the delimiters to whitespace + +### getDelimiters + +```java +public java.lang.String getDelimiters() +``` + +### setDelimiters + +```java +public void setDelimiters(java.lang.String delimiters) +``` +sets the current delimiter set + +**Parameters:** +- `delimiters` - the delimiters to use for parsing + +### getDecimalSeparator + +```java +public char getDecimalSeparator() +``` +gets decimal separator character for floating point literals + +**Returns:** +- decimal separator character + +### setDecimalSeparator + +```java +public void setDecimalSeparator(char separator) +``` +sets decimal separator character for floating point literals + +**Parameters:** +- `separator` - decimal separator to use when parsing floating point literals + +### markBeginning + +```java +public void markBeginning(int row) + throws PHXNoSuchTokenException +``` +marks the starting point from which to start counting rows and fields. Position is marked relative to the last marked position. + +**Parameters:** +- `row` - the row where the new beginning will occur. This row becomes row 1. + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markEnd + +```java +public void markEnd(int row) + throws PHXNoSuchTokenException +``` +marks the ending point of the file. Position is marked relative to the last marked position. + +**Parameters:** +- `row` - the row where the new ending will occur. This row becomes the last row. + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markBeginningOffset + +```java +public void markBeginningOffset(int offset) +``` +marks the starting point from which to start counting rows and fields. Position is marked relative to the last marked position. + +**Parameters:** +- `offset` - the offset from the current starting line + +**Throws:** +- `java.lang.IllegalArgumentException` - thrown if the specified offset moves past the end or beginning of the file + +### markBeginning + +```java +public void markBeginning(java.lang.String string, + boolean isRegex) + throws PHXNoSuchTokenException +``` +same as markBeginning with an occurrence value of 1 + +**Parameters:** +- `string` - the pattern that marks the new first line +- `isRegex` - if true, the pattern is a regular expression + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markBeginning + +```java +public void markBeginning(java.lang.String string) + throws PHXNoSuchTokenException +``` +same as markBeginning where the pattern is a regex and occurrence value is 1 + +**Parameters:** +- `string` - the pattern that marks the new first line + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markBeginning + +```java +public void markBeginning(java.lang.String string, + boolean isRegex, + int occurrence) + throws PHXNoSuchTokenException +``` +marks the starting point from which to start counting rows and fields. Position is marked relative to the last marked position. + +**Parameters:** +- `string` - the search pattern +- `occurrence` - the number of times to search for the pattern. may be negative to search from end +- `isRegex` - if true, the string is a regular expression. + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markBeginning + +```java +public void markBeginning(java.lang.String string, + int occurrence) + throws PHXNoSuchTokenException +``` +marks the starting point from which to start counting rows and fields. Position is marked relative to the last marked position. + +**Parameters:** +- `string` - the search pattern +- `occurrence` - the number of times to search for the pattern. may be negative to search from end + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markEndOffset + +```java +public void markEndOffset(int offset) +``` +marks the ending point from which to start counting rows and fields. Position is marked relative to the previously marked position. + +**Parameters:** +- `offset` - the offset from the current starting line + +**Throws:** +- `java.lang.IllegalArgumentException` - thrown if the specified offset moves past the end or beginning of the file + +### markEnd + +```java +public void markEnd(java.lang.String string, + boolean isRegex) + throws PHXNoSuchTokenException +``` +same as `markEnd` with an occurrence value of 1 + +**Parameters:** +- `string` - the pattern that marks the new first line +- `isRegex` - if true, the pattern is a regular expression + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markEnd + +```java +public void markEnd(java.lang.String string, + boolean isRegex, + int occurrence) + throws PHXNoSuchTokenException +``` +marks the ending point from which to start counting rows and fields. Position is marked relative to the last marked position. + +**Parameters:** +- `string` - the pattern that marks the new last line +- `isRegex` - if true, the pattern is a regular expression +- `occurrence` - the number of times to search for regex value may be negative to search from beginning + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markEnd + +```java +public void markEnd(java.lang.String string, + int occurrence) + throws PHXNoSuchTokenException +``` +marks the ending point from which to start counting rows and fields. Position is marked relative to the last marked position. Search string is a regex. + +**Parameters:** +- `string` - the pattern that marks the new last line +- `occurrence` - the number of times to search for regex value may be negative to search from end + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markBeginningFromEnd + +```java +public void markBeginningFromEnd(java.lang.String string, + boolean isRegex) + throws PHXNoSuchTokenException +``` +marks the starting point from which to start counting rows. Position is marked relative to the previously marked position. + +**Parameters:** +- `string` - the pattern that marks the new first line +- `isRegex` - if true, the pattern is a regular expression + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### markEndFromEnd + +```java +public void markEndFromEnd(java.lang.String string, + boolean isRegex) + throws PHXNoSuchTokenException +``` +marks the starting point from which to start counting rows and fields. Position is marked relative to the previously marked position. + +**Parameters:** +- `string` - the pattern that marks the new first line +- `isRegex` - if true, the pattern is a regular expression + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### clearMarks + +```java +public void clearMarks() +``` +resets the file to its whole size by removing the starting and ending marks if they existed + +### getToken + +```java +public java.lang.String getToken(java.lang.String string, + int occurrence, + int rowOffset, + int field) + throws PHXNoSuchTokenException +``` +gets the token relative to a search string. Indexing starts at 1. + +**Parameters:** +- `string` - the value to search for +- `occurrence` - the number of times to match the search +- `rowOffset` - row relative to the search results where the token is found +- `field` - the field in the specified row for the token + +**Returns:** +- the token found + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### getToken + +```java +public java.lang.String getToken(java.lang.String string, + int rowOffset, + int field) + throws PHXNoSuchTokenException +``` +gets the token relative to a search string. Indexing starts at 1. + +**Parameters:** +- `string` - the value to search for +- `rowOffset` - row relative to the search results where the token is found +- `field` - the field in the specified row for the token + +**Returns:** +- the token found + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### getToken + +```java +public java.lang.String getToken(int row, + int field) + throws PHXNoSuchTokenException +``` +gets the token at the specified row and field. Indexing starts at 1. + +**Parameters:** +- `row` - the row that the token is on +- `field` - the field in the specified row for the token + +**Returns:** +- the token found at row, field + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### getToken + +```java +public java.lang.String getToken(int row, + int startCol, + int endCol) + throws PHXNoSuchTokenException +``` +gets the token at the specified row and column. Indexing starts at 1. + +**Parameters:** +- `row` - the row that the token is on +- `startCol` - the start column +- `endCol` - the end column + +**Returns:** +- the token between startCol and endCol on row row + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### getToken + +```java +public java.util.Vector getToken(int row, + int startField, + int endField, + java.lang.String delimiter) + throws PHXNoSuchTokenException +``` +gets an array of tokens at the specified row and between start and end fields (all inclusive). Indexing starts at 1. Eg: if line = "IP = 1.5, 2.5, 3.5, 4.5", then `getToken(row, 2, 4, " \t,=")` would return `[1.5,2.5,3.5]`. + +**Parameters:** +- `row` - the row that the tokens are on +- `startField` - the start field (inclusive) +- `endField` - the end field (inclusive) +- `delimiter` - the delimiters + +**Returns:** +- the token between startField and endField (all inclusive) on row row + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### setToken + +```java +public void setToken(java.lang.String string, + int occurrence, + int rowOffset, + int field, + java.lang.String replacement) + throws PHXNoSuchTokenException +``` +gets the token relative to a search string. Indexing starts at 1. + +**Parameters:** +- `string` - the value to search for +- `occurrence` - the number of times to match the search +- `rowOffset` - row relative to the search results where the token is found +- `field` - the field in the specified row for the token +- `replacement` - the string to substitute into the field + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### setToken + +```java +public void setToken(java.lang.String string, + int rowOffset, + int field, + java.lang.String replacement) + throws PHXNoSuchTokenException +``` +gets the token relative to a search string. Indexing starts at 1. + +**Parameters:** +- `string` - the value to search for +- `rowOffset` - row relative to the search results where the token is found +- `field` - the field in the specified row for the token +- `replacement` - the string to substitute into the field + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### setToken + +```java +public void setToken(int row, + int field, + java.lang.String replacement) + throws PHXNoSuchTokenException +``` +replaces the token at the specified row and field. Indexing starts at 1. + +**Parameters:** +- `row` - the row that the token is on +- `field` - the field in the specified row for the token +- `replacement` - the string to substitute into the field + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### setToken + +```java +public void setToken(int row, + int startCol, + int endCol, + java.lang.String replacement) + throws PHXNoSuchTokenException +``` +replaces the token at the specified row and column. Indexing starts at 1. + +**Parameters:** +- `row` - the row that the token is on +- `startCol` - the start column +- `endCol` - the end column +- `replacement` - the string to substitute into the field + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the token is not found + +### addLines + +```java +public void addLines(int actualIndex, + int count, + java.lang.String line) +``` + +### addLines + +```java +public void addLines(int actualIndex, + java.lang.String[] lines) +``` + +### removeLines + +```java +public void removeLines(int actualIndex, + int count) +``` + +### countTokens + +```java +public int countTokens(int row) + throws PHXNoSuchTokenException +``` +counts the number of tokens on a specified row + +**Parameters:** +- `row` - the row to count tokens + +**Returns:** +- the number of tokens on the specified row + +**Throws:** +- `PHXNoSuchTokenException` - thrown if the row specified is invalid + +### getColumnArray + +```java +public java.lang.String[] getColumnArray(int startRow, + int endRow, + int field) + throws PHXNoSuchTokenException +``` +gets an array of tokens for the specified range. Indexing starts at 1. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `endRow` - the row for the last element in the array +- `field` - the field in the specified row for the token + +**Returns:** +- an array of String tokens + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### getRowArray + +```java +public java.lang.String[] getRowArray(int startCol, + int endCol, + int row) + throws PHXNoSuchTokenException +``` +gets an array of tokens for the specified range. Indexing starts at 1. + +**Parameters:** +- `startCol` - the field for the first element in the array +- `endCol` - the field for the last element in the array +- `row` - the row to extract tokens from + +**Returns:** +- an array of String tokens + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### getMatrixArray + +```java +public java.lang.String[] getMatrixArray(int startRow, + int startField, + int endRow, + int endField) + throws PHXNoSuchTokenException +``` +gets an array of tokens for the specified range. Indexing starts at 1. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startField` - the field for the first element in the array +- `endRow` - the row for the last element in the array +- `endField` - the field for the last element in the array + +**Returns:** +- an array of String tokens + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### getMatrixArray2d + +```java +public java.lang.String[][] getMatrixArray2d(int startRow, + int startField, + int endRow, + int endField) + throws PHXNoSuchTokenException +``` +gets an array of tokens for the specified range. Indexing starts at 1. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startField` - the field for the first element in the array +- `endRow` - the row for the last element in the array +- `endField` - the field for the last element in the array + +**Returns:** +- an array of String tokens + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### getMatrixArray + +```java +public java.lang.String[] getMatrixArray(int startRow, + int startCol, + int endRow, + int endCol, + int fieldWidth) + throws PHXNoSuchTokenException +``` +gets an array of tokens for the specified range. Indexing starts at 1. Columns are actual columns and not field indexes. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startCol` - the column for the first element in the array +- `endRow` - the row for the last element in the array +- `endCol` - the column for the last element in the array +- `fieldWidth` - UNUSED. How wide one field is. + +**Returns:** +- an array of String tokens + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### setMatrixArray + +```java +public void setMatrixArray(int startRow, + int startCol, + int endRow, + int endCol, + java.lang.String[] array) + throws PHXNoSuchTokenException +``` +sets an array of tokens for the specified range. Indexing starts at 1. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startCol` - the field for the first element in the array +- `endRow` - the row for the last element in the array +- `endCol` - the field for the last element in the array +- `array` - the values + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### setMatrixArray + +```java +public void setMatrixArray(int startRow, + int startCol, + int endRow, + int endCol, + java.lang.String[] array, + int resizeStyle) + throws PHXNoSuchTokenException +``` +sets an array of tokens for the specified range. Indexing starts at 1. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startCol` - the field for the first element in the array +- `endRow` - the row for the last element in the array +- `endCol` - the field for the last element in the array +- `array` - the values +- `resizeStyle` - How to resize (RESIZE_DISALLOW, RESIZE_ROWS) + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### setMatrixArray2d + +```java +public void setMatrixArray2d(int startRow, + int startCol, + int endRow, + int endCol, + java.lang.String[][] array, + int resizeStyle) + throws PHXNoSuchTokenException +``` +sets an array of tokens for the specified range. Indexing starts at 1. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startCol` - the field for the first element in the array +- `endRow` - the row for the last element in the array +- `endCol` - the field for the last element in the array +- `array` - the values +- `resizeStyle` - How to resize (RESIZE_DISALLOW, RESIZE_ROWS) + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### setMatrixArray + +```java +public void setMatrixArray(int startRow, + int startCol, + int endRow, + int endCol, + int fieldWidth, + java.lang.String[] array) + throws PHXNoSuchTokenException +``` +sets an array of tokens for the specified range. Indexing starts at 1. Columns are specified instead of fields. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startCol` - the field for the first element in the array +- `endRow` - the row for the last element in the array +- `endCol` - the field for the last element in the array +- `fieldWidth` - UNUSED. How wide one field is. +- `array` - the values + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### setMatrixArray + +```java +public void setMatrixArray(int startRow, + int startCol, + int endRow, + int endCol, + int fieldWidth, + java.lang.String[] array, + int resizeStyle) + throws PHXNoSuchTokenException +``` +sets an array of tokens for the specified range. Indexing starts at 1. Columns are specified instead of fields. + +**Parameters:** +- `startRow` - the row for the first element in the array +- `startCol` - the field for the first element in the array +- `endRow` - the row for the last element in the array +- `endCol` - the field for the last element in the array +- `fieldWidth` - UNUSED. How wide one field is. +- `array` - the values +- `resizeStyle` - How to resize (RESIZE_DISALLOW, RESIZE_ROWS) + +**Throws:** +- `PHXNoSuchTokenException` - thrown if a token is not found + +### main + +```java +public static void main(java.lang.String[] args) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXGetByUrlException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXGetByUrlException.md new file mode 100644 index 0000000000..acc9b9cb78 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXGetByUrlException.md @@ -0,0 +1,66 @@ +# Class: PHXGetByUrlException + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.util.PHXGetByUrlException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** + +```java +public class PHXGetByUrlException +extends java.lang.Exception +``` + +An exception that is thrown when encountering an error getting a file's contents via url + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXGetByUrlException(java.lang.String reason)`
Constructor. | +| `PHXGetByUrlException(java.lang.String reason, java.lang.Throwable inner)`
Constructor. | + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXGetByUrlException + +```java +public PHXGetByUrlException(java.lang.String reason) +``` +Constructor. Builds a combined string for the message about get by url failing with an inner reason. + +**Parameters:** +- `reason` - The reason get by url failed + +### PHXGetByUrlException + +```java +public PHXGetByUrlException(java.lang.String reason, + java.lang.Throwable inner) +``` +Constructor. Builds a combined string for the message about get by url failing with an inner reason. + +**Parameters:** +- `reason` - The reason get by url failed +- `inner` - Any inner exceptions \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXIcon.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXIcon.md new file mode 100644 index 0000000000..e2ed259ae3 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXIcon.md @@ -0,0 +1,126 @@ +# Class: PHXIcon + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXIcon +``` +--- +**Declaration** + +```java +public class PHXIcon +extends java.lang.Object +``` + +This class provides utility functions for loading and creating an icon file. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXIcon()`
Creates an icon with values set to "unknown" | +| `PHXIcon(byte[] iconData, java.lang.String iconType)` | +| `PHXIcon(java.lang.String iconFileName)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `byte[]` | `getData()`
Retrieves the data for the image | +| `java.lang.String` | `getIconFileName()`
Gets the file name of the icon. | +| `java.net.URI` | `getIconURI()`
Gets the URI of the icon. | +| `java.lang.String` | `getType()`
Retrieves the type for the image | +| `java.awt.Image` | `toImage()`
Converts the icon to an Image | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXIcon + +```java +public PHXIcon() +``` +Creates an icon with values set to "unknown". + +### PHXIcon + +```java +public PHXIcon(java.lang.String iconFileName) + throws java.io.IOException +``` + +**Parameters:** +- `iconFileName` - the file containing the icon + +**Throws:** +- `java.io.IOException` - thrown if there is a problem opening or reading the icon file + +### PHXIcon + +```java +public PHXIcon(byte[] iconData, + java.lang.String iconType) +``` + +**Parameters:** +- `iconData` - the data making up the file +- `iconType` - the data type (gif, jpg, etc) + +## Method Detail + +### getData + +```java +public byte[] getData() +``` +Retrieves the data for the image. + +**Returns:** +- the data for the image + +### getType + +```java +public java.lang.String getType() +``` +Retrieves the type for the image. + +**Returns:** +- the type for the image + +### toImage + +```java +public java.awt.Image toImage() +``` +Converts the icon to an Image. + +**Returns:** +- an image based solely on the data. + +### getIconFileName + +```java +public java.lang.String getIconFileName() +``` +Gets the file name of the icon. This will return an empty String if the file name is not available. + +**Returns:** +- the file name of the icon, or null if not specified + +### getIconURI + +```java +public java.net.URI getIconURI() +``` +Gets the URI of the icon. If the URI is not available, this will return null. + +**Returns:** +- the URI of the icon, or null if not available \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNameDivider.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNameDivider.md new file mode 100644 index 0000000000..36e20d0b1b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNameDivider.md @@ -0,0 +1,88 @@ +# Class: PHXNameDivider + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXNameDivider +``` + +--- + +**Declaration** + +```java +public class PHXNameDivider +extends java.lang.Object +``` + +This is a utility class for breaking down names into smaller parts. + +Usage: +```java +String fullName = "phoenix/NAVY/IBHVG2"; +String category = PHXNameDivider.getPathPart(fullName); +String name = PHXNameDivider.getNamePart(fullName); +``` + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXNameDivider()` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `static java.lang.String` | `getNamePart(java.lang.String fullName)`
Retrieves the name part from a full name | +| `static java.lang.String` | `getPathPart(java.lang.String fullName)`
Retrieves the path part from a full name | +| `static void` | `main(java.lang.String[] args)` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXNameDivider + +```java +public PHXNameDivider() +``` + +## Method Detail + +### getPathPart + +```java +public static java.lang.String getPathPart(java.lang.String fullName) +``` +Retrieves the path part from a full name. + +**Parameters:** +- `fullName` - the full name + +**Returns:** +- only the path part of the full name, separator not included + +### getNamePart + +```java +public static java.lang.String getNamePart(java.lang.String fullName) +``` +Retrieves the name part from a full name. + +**Parameters:** +- `fullName` - the full name + +**Returns:** +- only the name part of the full name + +### main + +```java +public static void main(java.lang.String[] args) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md new file mode 100644 index 0000000000..63eac443d4 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md @@ -0,0 +1,54 @@ +# Class: PHXNoSuchReplacementException + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.util.PHXNoSuchReplacementException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** + +```java +public class PHXNoSuchReplacementException +extends java.lang.Exception +``` + +An exception that is thrown when a replacement string cannot be found. + +**See Also:** +- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.util.PHXNoSuchReplacementException) + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXNoSuchReplacementException()` | + +## Method Summary + +### Methods inherited from class java.lang.Throwable + +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXNoSuchReplacementException + +```java +public PHXNoSuchReplacementException() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md new file mode 100644 index 0000000000..099b593850 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md @@ -0,0 +1,87 @@ +# Class: PHXNoSuchTokenException + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.util.PHXNoSuchTokenException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** + +```java +public class PHXNoSuchTokenException +extends java.lang.Exception +``` + +An exception that is thrown when an object cannot be found. + +**See Also:** +- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.util.PHXNoSuchTokenException) + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXNoSuchTokenException()` | +| `PHXNoSuchTokenException(java.lang.String msg)` | +| `PHXNoSuchTokenException(java.lang.String msg, java.lang.Throwable cause)` | +| `PHXNoSuchTokenException(java.lang.Throwable cause)` | + + +## Method Summary + +### Methods inherited from class java.lang.Throwable + +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXNoSuchTokenException + +```java +public PHXNoSuchTokenException() +``` + +### PHXNoSuchTokenException + +```java +public PHXNoSuchTokenException(java.lang.String msg) +``` + +**Parameters:** +- `msg` - the reason for the exception. + +### PHXNoSuchTokenException + +```java +public PHXNoSuchTokenException(java.lang.String msg, + java.lang.Throwable cause) +``` + +**Parameters:** +- `msg` - the reason for the exception. +- `cause` - an inner exception representing the reason for throwing this one. + +### PHXNoSuchTokenException + +```java +public PHXNoSuchTokenException(java.lang.Throwable cause) +``` + +**Parameters:** +- `cause` - an inner exception representing the reason for throwing this one. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcess.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcess.md new file mode 100644 index 0000000000..572fd9de36 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcess.md @@ -0,0 +1,235 @@ +# Class: PHXProcess + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Process + ↳ com.phoenix_int.aserver.util.PHXProcess +``` + +**Implemented Interfaces** + +- `com.phoenix_int.aserver.util.IPHXStreamRegExListener` + +--- + +**Declaration** + +```java +public class PHXProcess +extends java.lang.Process +implements com.phoenix_int.aserver.util.IPHXStreamRegExListener +``` + +This is a utility class that extends `java.lang.Process` with a system dependent process ID. This is combined with the phxspawn and phxps utilities to provide information on sub-processes in a semi-platform independent way. + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXProcess(java.lang.Process p)`
Constructs a PHXProcess out of a regular process but does not provide extended functionality because the process ID will not be known. | +| `PHXProcess(java.lang.Process p, boolean readPID, java.lang.String jobIdRegex, java.lang.String jobNodeRegex, com.phoenix_int.aserver.util.IPHXProcessJobInfoListener listener)` | +| `PHXProcess(java.lang.Process p, boolean readPID, java.lang.String jobIdRegex, java.lang.String jobNodeRegex, com.phoenix_int.aserver.util.IPHXProcessJobInfoListener listener, java.lang.String fname)`
Constructs a PHXProcess out of a process and optionally reads the PID of the sub-process. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `destroy()` | +| `int` | `exitValue()` | +| `java.io.InputStream` | `getErrorStream()` | +| `java.io.InputStream` | `getInputStream()` | +| `java.lang.String` | `getJobID()` | +| `java.lang.String` | `getJobNode()` | +| `java.io.OutputStream` | `getOutputStream()` | +| `java.lang.Process` | `getProcess()`
Returns the java Process instance for this PHXProcess | +| `int` | `getProcessID()`
Returns the platform dependent process ID associated with this process. | +| `java.lang.String` | `getTempScriptFileName()` | +| `PHXProcessInfo[]` | `listProcesses()`
This function lists all the processes and sub-processes of this PHXProcess. | +| `boolean` | `matchFound(int patNum, Pattern pat, java.lang.String line, MatchResult match)`
Signals that a match was found. | +| `int` | `waitFor()` | +| `com.phoenix_int.aserver.util.PHXStreamRegExMonitor` | `wrapErrorStream(com.phoenix_int.aserver.util.IPHXStreamRegExListener l)` | +| `com.phoenix_int.aserver.util.PHXStreamRegExMonitor` | `wrapInputStream(com.phoenix_int.aserver.util.IPHXStreamRegExListener l)` | + +### Methods inherited from class java.lang.Process +`destroyForcibly`, `isAlive`, `waitFor` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, toString, wait, `wait`, `wait` + +## Constructor Detail + +### PHXProcess + +```java +public PHXProcess(java.lang.Process p, + boolean readPID, + java.lang.String jobIdRegex, + java.lang.String jobNodeRegex, + com.phoenix_int.aserver.util.IPHXProcessJobInfoListener listener, + java.lang.String fname) +``` +Constructs a `PHXProcess` out of a process and optionally reads the PID of the sub-process. Typically you do not create instances of this class yourself, but use `PHXRuntime.exec2()` to generate instances. + +**Parameters:** +- `readPID` - If true, the PID of this process will be read off of the process's standard output. The pid should be a number and should be on the very first line of output all by itself. + +### PHXProcess + +```java +public PHXProcess(java.lang.Process p, + boolean readPID, + java.lang.String jobIdRegex, + java.lang.String jobNodeRegex, + com.phoenix_int.aserver.util.IPHXProcessJobInfoListener listener) +``` + +### PHXProcess + +```java +public PHXProcess(java.lang.Process p) +``` +Constructs a PHXProcess out of a regular process but does not provide extended functionality because the process ID will not be known. Use PHXRuntime to execute processes and automatically generate correct `PHXProcess` instances. + +## Method Detail + +### matchFound + +```java +public boolean matchFound(int patNum, + Pattern pat, + java.lang.String line, + MatchResult match) +``` +Description copied from interface: `com.phoenix_int.aserver.util.IPHXStreamRegExListener`. + + Signals that a match was found. + +**Specified by:** +- `matchFound` in interface `com.phoenix_int.aserver.util.IPHXStreamRegExListener` + +**Parameters:** +- `patNum` - The index of the pattern that matched +- `pat` - The matching pattern +- `line` - The matching line +- `match` - The MatchResult object which describes the match + +**Returns:** +- `true` to continue searching for this pattern, `false` to remove the pattern from the pattern list. + +### getJobID + +```java +public java.lang.String getJobID() +``` + +### getJobNode + +```java +public java.lang.String getJobNode() +``` + +### getProcess + +```java +public java.lang.Process getProcess() +``` +Returns the java Process instance for this PHXProcess + +### getProcessID + +```java +public int getProcessID() throws java.io.IOException +``` +Returns the platform dependent process ID associated with this process. If there was any error reading the process ID, or there is no process ID, an exception explaining the problem will be thrown (every time you call this function). + +**Throws:** +- `java.io.IOException` + +### listProcesses + +```java +public PHXProcessInfo[] listProcesses() throws java.io.IOException +``` +This function lists all the processes and sub-processes of this PHXProcess. This is a suitable list to return from `IPHXMonitorable.listProcesses()`. + +**Throws:** +- `java.io.IOException` + +### destroy + +```java +public void destroy() +``` + +**Specified by:** +- `destroy` in class `java.lang.Process` + +### exitValue + +```java +public int exitValue() +``` + +**Specified by:** +- `exitValue` in class `java.lang.Process` + +### waitFor + +```java +public int waitFor() throws java.lang.InterruptedException +``` + +**Specified by:** +- `waitFor` in class `java.lang.Process` + +**Throws:** +- `java.lang.InterruptedException` + +### wrapInputStream + +```java +public com.phoenix_int.aserver.util.PHXStreamRegExMonitor wrapInputStream(com.phoenix_int.aserver.util.IPHXStreamRegExListener l) +``` + +### wrapErrorStream + +```java +public com.phoenix_int.aserver.util.PHXStreamRegExMonitor wrapErrorStream(com.phoenix_int.aserver.util.IPHXStreamRegExListener l) +``` + +### getInputStream + +```java +public java.io.InputStream getInputStream() +``` + +**Specified by:** +- `getInputStream` in class `java.lang.Process` + +### getErrorStream + +```java +public java.io.InputStream getErrorStream() +``` + +**Specified by:** +- `getErrorStream` in class `java.lang.Process` + +### getOutputStream + +```java +public java.io.OutputStream getOutputStream() +``` + +**Specified by:** +- `getOutputStream` in class `java.lang.Process` + +### getTempScriptFileName + +```java +public java.lang.String getTempScriptFileName() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md new file mode 100644 index 0000000000..8bc3e39d98 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md @@ -0,0 +1,154 @@ +# Class: PHXProcessInfo + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXProcessInfo +``` +--- +**Declaration** + +```java +public class PHXProcessInfo +extends java.lang.Object +``` + +This class represents information about a running process on the system. It includes static members for listing all processes. This is done in a semi-platform independent way by using an external program which is platform dependent (although fairly consistent on UNIX systems, ps). See `PHXRuntime` and `PHXProcess` for other convenient ways to use this information. Note that not all platforms will have all information available. + +## Constructor Summary + +| Modifier | Constructor and Description | +|-------------|----------------------------| +| `protected` | `PHXProcessInfo()`
Constructs an empty process | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getCommand()`
Returns the command name of this process | +| `long` | `getElapsedTime()`
Returns the wall clock time for this process, if available | +| `long` | `getMemUsage()`
Gets the memory usage of this process, if available | +| `int` | `getParentProcessID()`
Gets the parent process ID of this process | +| `float` | `getPercentCPU()`
Gets the percentage of the CPU usage, if available | +| `static PHXProcessInfo[]` | `getProcesses()`
Lists all processes on the system | +| `static PHXProcessInfo[]` | `getProcesses(int parent)`
Lists the specified process' children. | +| `int` | `getProcessID()`
Gets the platform dependent process ID number | +| `long` | `getTime()`
Returns the amount of CPU time this process has used, if available. | +| `static void` | `main(java.lang.String[] args)` | +| `java.lang.String` | `toString()`
Converts this process info into a one-line readable string | +| `java.lang.String` | `toXML()`
Converts this process information into a usable XML description | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXProcessInfo + +```java +protected PHXProcessInfo() +``` +Constructs an empty process + +## Method Detail + +### getProcesses + +```java +public static PHXProcessInfo[] getProcesses(int parent) + throws java.io.IOException +``` +Lists the specified process' children. + +**Throws:** +- `java.io.IOException` + +### getProcesses + +```java +public static PHXProcessInfo[] getProcesses() + throws java.io.IOException +``` +Lists all processes on the system + +**Throws:** +- `java.io.IOException` + +### getCommand + +```java +public java.lang.String getCommand() +``` +Returns the command name of this process + +### getProcessID + +```java +public int getProcessID() +``` +Gets the platform dependent process ID number + +### getParentProcessID + +```java +public int getParentProcessID() +``` +Gets the parent process ID of this process + +### getPercentCPU + +```java +public float getPercentCPU() +``` +Gets the percentage of the CPU usage, if available + +### getMemUsage + +```java +public long getMemUsage() +``` +Gets the memory usage of this process, if available + +### getTime + +```java +public long getTime() +``` +Returns the amount of CPU time this process has used, if available. + +### getElapsedTime + +```java +public long getElapsedTime() +``` +Returns the wall clock time for this process, if available + +### toXML + +```java +public java.lang.String toXML() +``` +Converts this process information into a usable XML description + +### toString + +```java +public java.lang.String toString() +``` +Converts this process info into a one-line readable string + +**Overrides:** +- `toString` in class `java.lang.Object` + +### main + +```java +public static void main(java.lang.String[] args) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md new file mode 100644 index 0000000000..d6a18f7cee --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md @@ -0,0 +1,143 @@ +# Class: PHXRuntime + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXRuntime +``` +--- +**Declaration** + +```java +public class PHXRuntime +extends java.lang.Object +``` + +This is a utility class for running processes. The class wraps the user's desired process in a script that first switches to the desired directory. + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| static java.lang.String | DEFAULT_SHELL | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| PHXRuntime() | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.Process` | `exec(java.lang.String cmd, java.lang.String baseDir)`
runs the specified command. | +| `PHXProcess` | `exec2(java.lang.String cmd, java.lang.String baseDir, boolean addErrorChecks)`
runs the specified command. | +| `com.phoenix_int.aserver.util.IPHXProcessJobInfoListener` | `getJobListener()` | +| `java.lang.String` | `getShell()`
returns the shell used to run programs | +| `static void` | main(java.lang.String[] args) | +| `PHXRuntime` | `setJobListener(com.phoenix_int.aserver.util.IPHXProcessJobInfoListener jobListener)` | +| `void` | `setShell(java.lang.String shell)`
sets the shell to use when running commands (applies to UNIX only) | + +## Field Detail + +### DEFAULT_SHELL + +```java +public static final java.lang.String DEFAULT_SHELL +``` + +**See Also:** + +[Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXRuntime.DEFAULT_SHELL) + +## Constructor Detail + +### PHXRuntime + +```java +public PHXRuntime() +``` + +## Method Detail + +### setShell + +```java +public void setShell(java.lang.String shell) +``` + +Sets the shell to use when running commands (applies to UNIX only) + +**Parameters:** + +- `shell` - the shell to use. E.g. "csh". If null is specified, then the command is issued directly without a shell + +### getShell + +```java +public java.lang.String getShell() +``` + +Returns the shell used to run programs + +### setJobListener + +```java +public PHXRuntime setJobListener(com.phoenix_int.aserver.util.IPHXProcessJobInfoListener jobListener) +``` + +### getJobListener + +```java +public com.phoenix_int.aserver.util.IPHXProcessJobInfoListener getJobListener() +``` + +### exec + +```java +public java.lang.Process exec(java.lang.String cmd, + java.lang.String baseDir) + throws java.io.IOException +``` + +Runs the specified command. The function first switches to the proper directory. + +**Parameters:** + +- `cmd` - the command to run +- `baseDir` - the directory to run it in. + +**Throws:** + +- `java.io.IOException` - thrown if the command cannot be executed + +### exec2 + +```java +public PHXProcess exec2(java.lang.String cmd, + java.lang.String baseDir, + boolean addErrorChecks) + throws java.io.IOException +``` + +Runs the specified command. The function first switches to the proper directory. The PHXProcess which is returned has the ability to track the process and sub-processes in a somewhat platform independent way. + +**Parameters:** + +- `cmd` - the command to run +- `baseDir` - the directory to run it in. +- `addErrorChecks` - Whether to insert error checks after each command in multi-line commands. + +**Throws:** + +- `java.io.IOException` - thrown if the command cannot be executed + +### main + +```java +public static void main(java.lang.String[] args) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md new file mode 100644 index 0000000000..42d5798479 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md @@ -0,0 +1,419 @@ +# Class: PHXStringBuffer + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXStringBuffer +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +**Declaration** + +```java +public class PHXStringBuffer +extends java.lang.Object +implements java.io.Serializable +``` + +Class that behaves like a `java.lang.StringBuffer` but has logic for caching out to disk if the size grows over a limit (currently 512K). Has additional functionality to make it perform better for large files and includes `getReader()` and `getInputStream()` to read the string linearly. + +**See Also:** + +[Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.util.PHXStringBuffer) + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static long` | `SIZECUTOFF` | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXStringBuffer()`
Creates a new, empty string buffer | +| `PHXStringBuffer(long initialSize)`
Creates a new, empty string buffer which has an internal buffer of the size specified. | +| `PHXStringBuffer(java.lang.String initial)`
Creates a new string buffer which contains the specified string. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `PHXStringBuffer` | `addEscapes()` | +| `static java.lang.String` | `addEscapes(java.lang.String input)`
`Convenience static for adding escapes to plain strings` | +| `static java.lang.String` | `addEscapes(java.lang.String input, java.lang.String additionalEscapeChars)` | +| `PHXStringBuffer` | `addEscapesExtra(java.lang.String additionalEscapeChars)` | +| `PHXStringBuffer` | `append(byte[] buf)`
Appends a byte array using the default encoding | +| `PHXStringBuffer` | `append(byte[] buf, int offset, int len)`
Appends a byte array using the default encoding | +| `PHXStringBuffer` | `append(char ch)`
Appends a single char to this buffer | +| `PHXStringBuffer` | `append(char[] buf)`
Appends a char array to this buffer | +| `PHXStringBuffer` | `append(char[] buf, int offset, int len)`
Appends a char array to this buffer | +| `PHXStringBuffer` | `append(float num)`
Appends a float to this buffer | +| `PHXStringBuffer` | `append(java.io.InputStream in)`
Fully reads the contents of InputStream into this buffer using UTF-8 encoding. | +| `PHXStringBuffer` | `append(int num)`
Appends an integer to this buffer | +| `PHXStringBuffer` | `append(long num)`
Appends a long to this buffer | +| `PHXStringBuffer` | `append(PHXStringBuffer app)`
Appends a PHXStringBuffer to this buffer. | +| `PHXStringBuffer` | `append(java.io.Reader in)` | +| `PHXStringBuffer` | `append(java.lang.String app)`
Appends a string to this buffer | +| `char` | `charAt(long index)`
Get the character at the specified index | +| `void` | `clear()`
This is for performance only, it allows large temp files and memory to be freed. | +| `boolean` | `equals(java.lang.Object test)`
Compares this to another String or PHXStringBuffer. | +| `boolean` | `equalsIgnoreCase(java.lang.Object test)`
Compares this to another String or PHXStringBuffer. | +| `java.lang.String` | `firstWord()`
Returns the first word of this string, whitespace delimited. | +| `java.io.InputStream` | `getInputStream()`
Returns an InputStream which can be read sequentially and contains the contents of the string. | +| `java.io.Reader` | `getReader()`
Returns a Reader which can be read sequentially and contains the contents of the string. | +| `long` | `indexOf(char ch)`
Searches for a given character and returns the index to that character, or -1 if not found | +| `long` | `indexOf(char ch, int startAt)` | +| `long` | `indexOf(char ch, long startAt)`
Searches for a given character and returns the index to that character, or -1 if not found | +| `long` | `indexOf(java.lang.String str, int startAt)` | +| `long` | `indexOf(java.lang.String str, long startAt)` | +| `long` | `length()`
Returns the actual length of the string held by this buffer object. | +| `PHXStringBuffer` | `removeEscapes()` | +| `static java.lang.String` | `removeEscapes(java.lang.String input)` | +| `boolean` | `startsWith(java.lang.String test)`
Returns true if this string starts with the specified string | +| `PHXStringBuffer` | `substring(long start)`
Creates a PHXStringBuffer with the contents of this string starting at a specified point and going to the end of the string. | +| `PHXStringBuffer` | `substring(long start, long end)`
Creates a PHXStringBuffer with the contents of this string starting at a specified point and including up to the character before the specified end point. | +| `java.lang.String` | `toString()`
Returns a string representation of this object. | +| `void` | `writeTo(java.io.OutputStream os)`
Writes this string buffer out to an output stream efficiently does utf-8 conversion before writing | + +### Methods inherited from class java.lang.Object + +`clone`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Field Detail + +### SIZECUTOFF + +```java +public static final long SIZECUTOFF +``` + +**See Also:** + +[Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXStringBuffer.SIZECUTOFF) + +## Constructor Detail + +### PHXStringBuffer + +```java +public PHXStringBuffer() +``` +Creates a new, empty string buffer + +### PHXStringBuffer + +```java +public PHXStringBuffer(long initialSize) +``` +Creates a new, empty string buffer which has an internal buffer of the size specified. This is more efficient if you know the approximate size that the string will eventually be as it doesn't have to guess small and grow. In particular, if the size is over the cutoff limit, it immediately caches to disk. + +### PHXStringBuffer + +```java +public PHXStringBuffer(java.lang.String initial) +``` +Creates a new string buffer which contains the specified string. Will cache to disk immediately if the length of the string is over the cutoff. + +## Method Detail + +### clear + +```java +public void clear() +``` +This is for performance only, it allows large temp files and memory to be freed. This will happen when the garbage collector runs, but sometimes this is not good enough when you are dealing with large files. + +### append + +```java +public PHXStringBuffer append(java.lang.String app) +``` +Appends a string to this buffer + +### append + +```java +public PHXStringBuffer append(char[] buf) +``` +Appends a char array to this buffer + +### append + +```java +public PHXStringBuffer append(char[] buf, + int offset, + int len) +``` +Appends a char array to this buffer + +**Parameters:** + +- `offset` - The offset to start copying at +- `len` - The number of chars to copy + +### append + +```java +public PHXStringBuffer append(byte[] buf) +``` +Appends a byte array using the default encoding + +### append + +```java +public PHXStringBuffer append(byte[] buf, + int offset, + int len) +``` +Appends a byte array using the default encoding + +### append + +```java +public PHXStringBuffer append(PHXStringBuffer app) +``` +Appends a `PHXStringBuffer` to this buffer. In particular this is more efficient than using `append(String)` when one or both of the buffers are currently cached out to disk. + +### append + +```java +public PHXStringBuffer append(java.io.InputStream in) + throws java.io.IOException +``` +Fully reads the contents of `InputStream` into this buffer using UTF-8 encoding. Will not close the `InputStream` when done. + +**Parameters:** + +- `in` - The `InputStream` to read, should be in UTF-8 encoding. + +**Returns:** + +- this + +**Throws:** + +- `java.io.IOException` + +### append + +```java +public PHXStringBuffer append(java.io.Reader in) + throws java.io.IOException +``` + +**Throws:** + +- `java.io.IOException` + +### append + +```java +public PHXStringBuffer append(int num) +``` +Appends an integer to this buffer + +### append + +```java +public PHXStringBuffer append(long num) +``` +Appends a long to this buffer + +### append + +```java +public PHXStringBuffer append(float num) +``` +Appends a float to this buffer + +### append + +```java +public PHXStringBuffer append(char ch) +``` +Appends a single char to this buffer + +### addEscapes + +```java +public static java.lang.String addEscapes(java.lang.String input) +``` +Convenience static for adding escapes to plain strings + +### addEscapes + +```java +public static java.lang.String addEscapes(java.lang.String input, + java.lang.String additionalEscapeChars) +``` + +### addEscapes + +```java +public PHXStringBuffer addEscapes() +``` + +### addEscapesExtra + +```java +public PHXStringBuffer addEscapesExtra(java.lang.String additionalEscapeChars) +``` + +### removeEscapes + +```java +public static java.lang.String removeEscapes(java.lang.String input) +``` + +### removeEscapes + +```java +public PHXStringBuffer removeEscapes() +``` + +### length + +```java +public long length() +``` +Returns the actual length of the string held by this buffer object. + +### toString + +```java +public java.lang.String toString() +``` +Returns a string representation of this object. + +NOTE: This is very bad performance for large files. Avoid this if possible if you know you will be handling large strings. + +**Overrides:** + +- `toString` in class `java.lang.Object` + +**See Also:** + +[getReader()](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html#getReader--), [getInputStream()](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html#getInputStream--) + +### getReader + +```java +public java.io.Reader getReader() +``` +Returns a `Reader` which can be read sequentially and contains the contents of the string. This is an efficient way to read the whole string. + +### getInputStream + +```java +public java.io.InputStream getInputStream() +``` +Returns an `InputStream` which can be read sequentially and contains the contents of the string. This is an efficient way to read the whole string. The stream will be UTF-8 encoded. + +### charAt + +```java +public char charAt(long index) +``` +Get the character at the specified index + +### indexOf + +```java +public long indexOf(char ch) +``` +Searches for a given character and returns the index to that character, or -1 if not found + +### indexOf + +```java +public long indexOf(char ch, + int startAt) +``` + +### indexOf + +```java +public long indexOf(char ch, + long startAt) +``` +Searches for a given character and returns the index to that character, or -1 if not found + +### indexOf + +```java +public long indexOf(java.lang.String str, + int startAt) +``` + +### indexOf + +```java +public long indexOf(java.lang.String str, + long startAt) +``` + +### startsWith + +```java +public boolean startsWith(java.lang.String test) +``` +Returns true if this string starts with the specified string + +### equals + +```java +public boolean equals(java.lang.Object test) +``` +Compares this to another `String` or `PHXStringBuffer`. Returns `false` if you pass in null. + +**Overrides:** + +- `equals` in class `java.lang.Object` + +### equalsIgnoreCase + +```java +public boolean equalsIgnoreCase(java.lang.Object test) +``` +Compares this to another `String` or `PHXStringBuffer`. Returns `false` if you pass in null. Is insensitive to case. + +### firstWord + +```java +public java.lang.String firstWord() +``` +Returns the first word of this string, whitespace delimited. + +### substring + +```java +public PHXStringBuffer substring(long start) +``` +Creates a `PHXStringBuffer` with the contents of this string starting at a specified point and going to the end of the string. + +### substring + +```java +public PHXStringBuffer substring(long start, + long end) +``` +Creates a `PHXStringBuffer` with the contents of this string starting at a specified point and including up to the character before the specified end point. + +### writeTo + +```java +public void writeTo(java.io.OutputStream os) + throws java.io.IOException +``` +Writes this string buffer out to an output stream efficiently does utf-8 conversion before writing + +**Throws:** + +- `java.io.IOException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringReplacer.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringReplacer.md new file mode 100644 index 0000000000..b3b74dfb30 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringReplacer.md @@ -0,0 +1,78 @@ +# Class: PHXStringReplacer + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXStringReplacer +``` +--- + +**Declaration** + +```java +public class PHXStringReplacer +extends java.lang.Object +``` + +This is a utility class for replacing fields within a string. + +Sample Usage: + +```java + PHXVariableReplacer vr = new PHXVariableReplacer( _wrapper ); + PHXStringReplacer r = new PHXStringReplacer( vr ); + + String s = "user/woyak/$file"; + String n = r.replace( s ); +``` + +## Constructor Summary + +| `Constructor and Description` | +|-----------------------------| +| `PHXStringReplacer(IPHXStringReplacer r)` | + +## Method Summary + +| `Modifier and Type` | Method and Description | +|---------------------|----------------------| +| `static void` | `main(java.lang.String[] args)` | +| `java.lang.String` | `replace(java.lang.String s)`
replaces all names starting with "$" with values looked up from the replacer object. | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXStringReplacer + +```java +public PHXStringReplacer(IPHXStringReplacer r) +``` + +## Method Detail + +### replace + +```java +public java.lang.String replace(java.lang.String s) +``` +Replaces all names starting with "$" with values looked up from the replacer object. If no match is found, the original value is retained. + +**Parameters:** + +- `s` - the String to replace tokens in + +**Returns:** + +- the modified string + +### main + +```java +public static void main(java.lang.String[] args) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringTokenizer.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringTokenizer.md new file mode 100644 index 0000000000..d37189b2e1 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringTokenizer.md @@ -0,0 +1,379 @@ +# Class: PHXStringTokenizer + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.PHXStringTokenizer +``` + +**Implemented Interfaces** + +- `java.util.Enumeration` + +**Declaration** + +```java +public class PHXStringTokenizer +extends java.lang.Object +implements java.util.Enumeration +``` + +This is a more sophisticated version of the Java `StringTokenizer`. Using the `StringTokenizer` source as a starting point, the source code was modified to recognize quoted strings as separate tokens. + +The following is one example of the use of the tokenizer. The code: + +```java +PHXStringTokenizer st = new PHXStringTokenizer( "this \"is a\" test" ); +while ( st.hasMoreTokens() ) +{ + System.out.println( st.nextToken() ); +} +``` + +prints the following output: + +```java +this +is a +test +``` + +The "doUnslash" option is true by default and makes it unslash special backslash sequences correctly (like a unix shell prompt does). It can be set to false for backwards compatibility but is recommended strongly that we use true as much as possible. + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXStringTokenizer(PHXStringBuffer str)`
Constructs a string tokenizer for the specified string. | +| `PHXStringTokenizer(PHXStringBuffer str, boolean doUnslash)`
Constructs a string tokenizer for the specified string. | +| `PHXStringTokenizer(PHXStringBuffer str, java.lang.String delim)`
Constructs a string tokenizer for the specified string. | +| `PHXStringTokenizer(PHXStringBuffer str, java.lang.String delim, boolean doUnslash)`
Constructs a string tokenizer for the specified string. | +| `PHXStringTokenizer(java.lang.String str)`
Constructs a string tokenizer for the specified string. | +| `PHXStringTokenizer(java.lang.String str, boolean doUnslash)`
Constructs a string tokenizer for the specified string. | +| `PHXStringTokenizer(java.lang.String str, java.lang.String delim)`
Constructs a string tokenizer for the specified string. | +| `PHXStringTokenizer(java.lang.String str, java.lang.String delim, boolean doUnslash)`
Constructs a string tokenizer for the specified string. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `int` | `countTokens()`
Calculates the number of times that this tokenizer's `nextToken` method can be called before it generates an exception. | +| `long` | `getCurrentPosition()` | +| `java.lang.String` | `getRemainder()`
Returns the remainder of the string (stuff not yet returned via nextToken()) | +| `PHXStringBuffer` | `getRemainder2()`
Returns the remainder of the string (stuff not yet returned via nextToken()) | +| `boolean` | `hasMoreElements()`
Returns the same value as the `hasMoreTokens` method. | +| `boolean` | `hasMoreTokens()`
Tests if there are more tokens available from this tokenizer's string. | +| `static void` | `main(java.lang.String[] args)` | +| `java.lang.Object` | `nextElement()`
Returns the same value as the `nextToken` method, except that its declared return value is `Object` rather than `String`. | +| `java.lang.String` | `nextToken()`
Returns the next token from this string tokenizer. | +| `java.lang.String` | `nextToken(java.lang.String delim)`
Returns the next token in this string tokenizer's string. | +| `PHXStringBuffer` | `nextToken2()`
Returns the next token from this string tokenizer. | +| `PHXStringBuffer` | `nextToken2(boolean returnValue)`
Returns the next token from this string tokenizer. | +| `PHXStringBuffer` | `nextToken2(java.lang.String delim)`
Returns the next token in this string tokenizer's string. | +| `void` | `setQuoteChar(char c)`
Sets the character to be used to indicate the start and end of strings. | +| `void` | `skipDelimiters()`
Skips delimiters. | +| `boolean` | `wasLastTokenQuoted()`
Indicates whether the last token retrieved was a quoted string | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(java.lang.String str, + java.lang.String delim) +``` +Constructs a string tokenizer for the specified string. The characters in the `delim` argument are the delimiters for separating tokens. If the `returnTokens` flag is `true`, then the delimiter characters are also returned as tokens. Each delimiter is returned as a string of length one. If the flag is `false`, the delimiter characters are skipped and only serve as separators between tokens. + +**Parameters:** +- `str` - a string to be parsed. +- `delim` - the delimiters. + +**Throws:** +- `java.lang.IllegalArgumentException` - thrown if " is specified as a delimiter + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(java.lang.String str, + java.lang.String delim, + boolean doUnslash) +``` +Constructs a string tokenizer for the specified string. The characters in the `delim` argument are the delimiters for separating tokens. If the `returnTokens` flag is `true`, then the delimiter characters are also returned as tokens. Each delimiter is returned as a string of length one. If the flag is `false`, the delimiter characters are skipped and only serve as separators between tokens. + +**Parameters:** +- `str` - a string to be parsed. +- `delim` - the delimiters. +- `doUnslash` - Whether to unslash slashed characters (\n) + +**Throws:** +- `java.lang.IllegalArgumentException` - thrown if " is specified as a delimiter + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(PHXStringBuffer str, + java.lang.String delim) +``` +Constructs a string tokenizer for the specified string. The characters in the `delim` argument are the delimiters for separating tokens. If the `returnTokens` flag is `true`, then the delimiter characters are also returned as tokens. Each delimiter is returned as a string of length one. If the flag is `false`, the delimiter characters are skipped and only serve as separators between tokens. + +**Parameters:** +- `str` - a string to be parsed. +- `delim` - the delimiters. + +**Throws:** +- `java.lang.IllegalArgumentException` - thrown if " is specified as a delimiter + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(PHXStringBuffer str, + java.lang.String delim, + boolean doUnslash) +``` +Constructs a string tokenizer for the specified string. The characters in the `delim` argument are the delimiters for separating tokens. If the `returnTokens` flag is `true`, then the delimiter characters are also returned as tokens. Each delimiter is returned as a string of length one. If the flag is `false`, the delimiter characters are skipped and only serve as separators between tokens. + +**Parameters:** +- `str` - a string to be parsed. +- `delim` - the delimiters. +- `doUnslash` - Whether to unslash slashed characters (\n) + +**Throws:** +- `java.lang.IllegalArgumentException` - thrown if " is specified as a delimiter + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(java.lang.String str) +``` +Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is `"\t\n\r"`: the space character, the tab character, the newline character, and the carriage-return character. + +**Parameters:** +- `str` - a string to be parsed. + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(java.lang.String str, + boolean doUnslash) +``` +Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is `"\t\n\r"`: the space character, the tab character, the newline character, and the carriage-return character. + +**Parameters:** +- `str` - a string to be parsed. +- `doUnslash` - Whether to unslash slashed characters (\n) + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(PHXStringBuffer str) +``` +Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is `"\t\n\r"`: the space character, the tab character, the newline character, and the carriage-return character. + +**Parameters:** +- `str` - a string to be parsed. + +### PHXStringTokenizer + +```java +public PHXStringTokenizer(PHXStringBuffer str, + boolean doUnslash) +``` +Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is `"\t\n\r"`: the space character, the tab character, the newline character, and the carriage-return character. + +**Parameters:** +- `str` - a string to be parsed. +- `doUnslash` - Whether to unslash slashed characters (\n) + + +## Method Detail + +### setQuoteChar + +```java +public void setQuoteChar(char c) +``` +Sets the character to be used to indicate the start and end of strings. By default it is double quotes: '"'. Use this function to set it to a single quote instead. + +**Parameters:** +- `c` - the quote character + +### getCurrentPosition + +```java +public long getCurrentPosition() +``` + +### skipDelimiters + +```java +public void skipDelimiters() +``` +Skips delimiters. + +### wasLastTokenQuoted + +```java +public boolean wasLastTokenQuoted() +``` +Indicates whether the last token retrieved was a quoted string + +**Returns:** +- true or false + +### hasMoreTokens + +```java +public boolean hasMoreTokens() +``` +Tests if there are more tokens available from this tokenizer's string. + +**Returns:** +- `true` if there are more tokens available from this tokenizer's string; `false` otherwise. + +### getRemainder + +```java +public java.lang.String getRemainder() +``` +Returns the remainder of the string (stuff not yet returned via nextToken()) + +**Returns:** +- the remainder of the untokenized string + +### getRemainder2 + +```java +public PHXStringBuffer getRemainder2() +``` +Returns the remainder of the string (stuff not yet returned via nextToken()) + +**Returns:** +- the remainder of the untokenized string + +### nextToken + +```java +public java.lang.String nextToken() +``` +Returns the next token from this string tokenizer. + +**Returns:** +- the next token from this string tokenizer. + +**Throws:** +- `java.util.NoSuchElementException` - if there are no more tokens in this tokenizer's string. + +### nextToken2 + +```java +public PHXStringBuffer nextToken2() +``` +Returns the next token from this string tokenizer. + +**Returns:** +- the next token from this string tokenizer. + +**Throws:** +- `java.util.NoSuchElementException` - if there are no more tokens in this tokenizer's string. + +### nextToken2 + +```java +public PHXStringBuffer nextToken2(boolean returnValue) +``` +Returns the next token from this string tokenizer. + +**Parameters:** +- `returnValue` - if false, the value returned is always null + +**Returns:** +- the next token from this string tokenizer. + +**Throws:** +- `java.util.NoSuchElementException` - if there are no more tokens in this tokenizer's string. + +### nextToken + +```java +public java.lang.String nextToken(java.lang.String delim) +``` +Returns the next token in this string tokenizer's string. The new delimiter set remains the default after this call. + +**Parameters:** +- `delim` - the new delimiters. + +**Returns:** +- the next token, after switching to the new delimiter set. + +**Throws:** +- `java.util.NoSuchElementException` - if there are no more tokens in this tokenizer's string. +- `java.lang.IllegalArgumentException` - thrown if " is specified as a delimeter + +### nextToken2 + +```java +public PHXStringBuffer nextToken2(java.lang.String delim) +``` +Returns the next token in this string tokenizer's string. The new delimiter set remains the default after this call. + +**Parameters:** +- `delim` - the new delimiters. + +**Returns:** +- the next token, after switching to the new delimiter set. + +**Throws:** +- `java.util.NoSuchElementException` - if there are no more tokens in this tokenizer's string. +- `java.lang.IllegalArgumentException` - thrown if " is specified as a delimeter + +### hasMoreElements + +```java +public boolean hasMoreElements() +``` +Returns the same value as the `hasMoreTokens` method. It exists so that this class can implement the `Enumeration` interface. + +**Specified by:** +- `hasMoreElements` in interface `java.util.Enumeration` + +**Returns:** +- `true` if there are more tokens; `false` otherwise. + +### nextElement + +```java +public java.lang.Object nextElement() +``` +Returns the same value as the `nextToken` method, except that its declared return value is `Object` rather than `String`. It exists so that this class can implement the `Enumeration` interface. + +**Specified by:** +- `nextElement` in interface `java.util.Enumeration` + +**Returns:** +- the next token in the string. + +**Throws:** +- `java.util.NoSuchElementException` - if there are no more tokens in this tokenizer's string. + +### countTokens + +```java +public int countTokens() +``` +Calculates the number of times that this tokenizer's `nextToken` method can be called before it generates an exception. + +**Returns:** +- the number of tokens remaining in the string using the current delimiter set. + +### main + +```java +public static void main(java.lang.String[] args) +``` diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md new file mode 100644 index 0000000000..b6f0ffbce6 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md @@ -0,0 +1,183 @@ +# com.phoenix_int.aserver.util +## Enum: Parser.Mode + +**Package:** `com.phoenix_int.aserver.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Enum + ↳ com.phoenix_int.aserver.util.Parser.Mode +``` + +**All Implemented Interfaces:** +- java.io.Serializable, java.lang.Comparable + +**Enclosing interface:** +- [Parser](../../../../com/phoenix_int/aserver/util/Parser.html) + +--- +**Declaration** + +```java +public static enum Parser.Mode +extends java.lang.Enum +``` + +File-access mode. Moved to type-safe enum from legacy integer constants. + +## Enum Constant Summary + +| Enum Constant and Description | +|------------------------------| +| `AUTOMATIC` | +| `BUFFERED` | +| `RANDOM` | + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static long` | `FILE_SIZE_LIMIT` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `static Parser.Mode` | `fromCode(int code)` | +| `int` | `getCode()`
Retrieve the legacy integer code assigned to this access mode | +| `IPHXLineStore` | `newLineStore(java.io.File file)` | +| `IPHXLineStore` | `newLineStore(java.io.File file, com.phoenix_int.util.PHXFileUtils.Encoding encoding)` | +| `abstract IPHXLineStore` | `newLineStore(java.io.File file, com.phoenix_int.util.PHXFileUtils.Encoding encoding, com.phoenix_int.util.IProgressListener progress)`
Create a new line store consistent with the file-access mode | +| `static Parser.Mode` | `valueOf(java.lang.String name)`
Returns the enum constant of this type with the specified name. | +| `static Parser.Mode[]` | `values()`
Returns an array containing the constants of this enum type, in the order they are declared. | + +### Methods inherited from class java.lang.Enum + +`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf` + +### Methods inherited from class java.lang.Object + +`getClass, notify, notifyAll, wait, wait, wait` + +## Enum Constant Detail + +### RANDOM + +```java +public static final Parser.Mode RANDOM +``` + +### BUFFERED + +```java +public static final Parser.Mode BUFFERED +``` + +### AUTOMATIC + +```java +public static final Parser.Mode AUTOMATIC +``` + +## Field Detail + +### FILE_SIZE_LIMIT + +```java +public static final long FILE_SIZE_LIMIT +``` + +**See Also:** +- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.Parser.Mode.FILE_SIZE_LIMIT) + +## Method Detail + +### values + +```java +public static Parser.Mode[] values() +``` +Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: + +```java +for (Parser.Mode c : Parser.Mode.values()) + System.out.println(c); +``` + +**Returns:** +- an array containing the constants of this enum type, in the order they are declared + +### valueOf + +```java +public static Parser.Mode valueOf(java.lang.String name) +``` +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.) + +**Parameters:** +- `name` - the name of the enum constant to be returned. + +**Returns:** +- the enum constant with the specified name + +**Throws:** +- `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name +- `java.lang.NullPointerException` - if the argument is null + +### getCode + +```java +public int getCode() +``` +Retrieve the legacy integer code assigned to this access mode + +**Returns:** +- code + +### newLineStore + +```java +public IPHXLineStore newLineStore(java.io.File file) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### newLineStore + +```java +public IPHXLineStore newLineStore(java.io.File file, + com.phoenix_int.util.PHXFileUtils.Encoding encoding) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### newLineStore + +```java +public abstract IPHXLineStore newLineStore(java.io.File file, + com.phoenix_int.util.PHXFileUtils.Encoding encoding, + com.phoenix_int.util.IProgressListener progress) + throws java.io.IOException +``` +Create a new line store consistent with the file-access mode + +**Parameters:** +- `file` - + +**Returns:** +- line store + +**Throws:** +- `java.io.IOException` + +### fromCode + +```java +public static Parser.Mode fromCode(int code) +``` diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md new file mode 100644 index 0000000000..c94e87844b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md @@ -0,0 +1,49 @@ +## Interface: Parser + +**Package:** `com.phoenix_int.aserver.util` + +**All Known Implementing Classes:** +- [PHXFileParser](../../../../com/phoenix_int/aserver/util/PHXFileParser.html) + +-- + +**Declaration** + +```java +public interface Parser +``` + +Interface to define the methods of a parser. Defined after-the-fact from the existing PHXFileParser with the intent to be useful for PHXXMLParser. + +## Nested Class Summary + +| Modifier and Type | Interface and Description | +|-------------------|-------------------------| +| `static class` | `Parser.Mode`
File-access mode. Moved to type-safe enum from legacy integer constants | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `close()`
Close the parser | +| `void` | `writeTo(java.io.OutputStreamWriter fw)`
Write any changes to the output stream | + +## Method Detail + +### writeTo + +```java +void writeTo(java.io.OutputStreamWriter fw) + throws java.io.IOException +``` +Write any changes to the output stream + +**Throws:** +- `java.io.IOException` + +### close + +```java +void close() +``` +Close the parser \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md new file mode 100644 index 0000000000..5879bbf594 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md @@ -0,0 +1,40 @@ +# Package com.phoenix_int.aserver.util +Provides general purpose utility functions. + +## Interface Summary +| Interface | Description | +| --- | --- | +| [IPHXLineStore](../../../../com/phoenix_int/aserver/util/IPHXLineStore.html) | This is the interface for holding a set of lines. | +| [IPHXStringReplacer](../../../../com/phoenix_int/aserver/util/IPHXStringReplacer.html) | This is the interface for a replacing strings, used by the PHXStringReplacer class | +| [Parser](../../../../com/phoenix_int/aserver/util/Parser.html) | Interface to define the methods of a parser. | + +## Class Summary +| Class | Description | +| --- | --- | +| [PHXFileLoader](../../../../com/phoenix_int/aserver/util/PHXFileLoader.html) | This is a utility class for loading data files. | +| [PHXFileName](../../../../com/phoenix_int/aserver/util/PHXFileName.html) | this is a utility class for easily managing file names. | +| [PHXFileParser](../../../../com/phoenix_int/aserver/util/PHXFileParser.html) | This is a utility class for loading data files and extracting data. | +| [PHXIcon](../../../../com/phoenix_int/aserver/util/PHXIcon.html) | This class provides utility functions for loading and creating an icon file | +| [PHXNameDivider](../../../../com/phoenix_int/aserver/util/PHXNameDivider.html) | this is a utility class for breaking down names into smaller parts. | +| [PHXProcess](../../../../com/phoenix_int/aserver/util/PHXProcess.html) | This is a utility class that extends `java.lang.Process` with a system dependent process ID. | +| [PHXProcessInfo](../../../../com/phoenix_int/aserver/util/PHXProcessInfo.html) | This class represents information about a running process on the system. | +| [PHXRuntime](../../../../com/phoenix_int/aserver/util/PHXRuntime.html) | This is a utility class for running processes. | +| [PHXStringBuffer](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html) | Class that behaves like a `java.lang.StringBuffer` but has logic for cacheing out to disk if the size grows over a limit (currently 512K). | +| [PHXStringReplacer](../../../../com/phoenix_int/aserver/util/PHXStringReplacer.html) | This is a utility class for replacing fields within a string. | +| [PHXStringTokenizer](../../../../com/phoenix_int/aserver/util/PHXStringTokenizer.html) | This is a more sophisticated version of the Java StringTokenizer. | + +## Enum Summary +| Enum | Description | +| --- | --- | +| [Parser.Mode](../../../../com/phoenix_int/aserver/util/Parser.Mode.html) | File-access mode
Moved to type-safe enum from legacy integer constants | + +## Exception Summary +| Exception | Description | +| --- | --- | +| [PHXClassNotFoundException](../../../../com/phoenix_int/aserver/util/PHXClassNotFoundException.html) | Simple wrapper for `ClassNotFoundException` which can contain additional logging info. | +| [PHXGetByUrlException](../../../../com/phoenix_int/aserver/util/PHXGetByUrlException.html) | An exception that is thrown when encountering an error getting a file's contents via url | +| [PHXNoSuchReplacementException](../../../../com/phoenix_int/aserver/util/PHXNoSuchReplacementException.html) | An exception that is thrown when a replacement string cannot be found | +| [PHXNoSuchTokenException](../../../../com/phoenix_int/aserver/util/PHXNoSuchTokenException.html) | An exception that is thrown when an object cannot be found | + +## Package com.phoenix_int.aserver.util Description +Provides general purpose utility functions.Put @see and @since tags down here. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md new file mode 100644 index 0000000000..c57c6fa244 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md @@ -0,0 +1,39 @@ +# Hierarchy For Package com.phoenix_int.aserver.util +**Package Hierarchies:** +- [All Packages](../../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - com.phoenix_int.aserver.util.[PHXFileLoader](../../../../com/phoenix_int/aserver/util/PHXFileLoader.html) + - com.phoenix_int.aserver.util.[PHXFileName](../../../../com/phoenix_int/aserver/util/PHXFileName.html) + - com.phoenix_int.aserver.util.[PHXFileParser](../../../../com/phoenix_int/aserver/util/PHXFileParser.html)(implements com.phoenix_int.aserver.util.[Parser](../../../../com/phoenix_int/aserver/util/Parser.html)) + - com.phoenix_int.aserver.util.[PHXIcon](../../../../com/phoenix_int/aserver/util/PHXIcon.html) + - com.phoenix_int.aserver.util.[PHXNameDivider](../../../../com/phoenix_int/aserver/util/PHXNameDivider.html) + - com.phoenix_int.aserver.util.[PHXProcessInfo](../../../../com/phoenix_int/aserver/util/PHXProcessInfo.html) + - com.phoenix_int.aserver.util.[PHXRuntime](../../../../com/phoenix_int/aserver/util/PHXRuntime.html) + - com.phoenix_int.aserver.util.[PHXStringBuffer](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html)(implements java.io.Serializable) + - com.phoenix_int.aserver.util.[PHXStringReplacer](../../../../com/phoenix_int/aserver/util/PHXStringReplacer.html) + - com.phoenix_int.aserver.util.[PHXStringTokenizer](../../../../com/phoenix_int/aserver/util/PHXStringTokenizer.html)(implements java.util.Enumeration) + - java.lang.Process + - com.phoenix_int.aserver.util.[PHXProcess](../../../../com/phoenix_int/aserver/util/PHXProcess.html)(implements com.phoenix_int.aserver.util.IPHXStreamRegExListener) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - com.phoenix_int.aserver.util.[PHXGetByUrlException](../../../../com/phoenix_int/aserver/util/PHXGetByUrlException.html) + - com.phoenix_int.aserver.util.[PHXNoSuchReplacementException](../../../../com/phoenix_int/aserver/util/PHXNoSuchReplacementException.html) + - com.phoenix_int.aserver.util.[PHXNoSuchTokenException](../../../../com/phoenix_int/aserver/util/PHXNoSuchTokenException.html) + - java.lang.ReflectiveOperationException + - java.lang.ClassNotFoundException + - com.phoenix_int.aserver.util.[PHXClassNotFoundException](../../../../com/phoenix_int/aserver/util/PHXClassNotFoundException.html) + +## Interface Hierarchy + +- com.phoenix_int.aserver.util.[IPHXLineStore](../../../../com/phoenix_int/aserver/util/IPHXLineStore.html) +- com.phoenix_int.aserver.util.[IPHXStringReplacer](../../../../com/phoenix_int/aserver/util/IPHXStringReplacer.html) +- com.phoenix_int.aserver.util.[Parser](../../../../com/phoenix_int/aserver/util/Parser.html) + +## Enum Hierarchy + +- java.lang.Object + - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) + - com.phoenix_int.aserver.util.[Parser.Mode](../../../../com/phoenix_int/aserver/util/Parser.Mode.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md new file mode 100644 index 0000000000..6b065fd46e --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md @@ -0,0 +1,381 @@ +# Class: AbstractFile + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile +``` + +**Implemented Interfaces** + +- `ParseableFile`, `java.io.Closeable`, `java.lang.AutoCloseable` + +**Direct Known Subclasses** + +- `CAEOutputFile`, `PHXRowFieldFile`, `XPathFile` + +--- + +## Declaration + +```java +public abstract class AbstractFile +extends java.lang.Object +implements ParseableFile, java.io.Closeable +``` + +Common implementation for files (not file variables) used in script wrappers. + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile +`ParseableFile.Mode` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `protected com.phoenix_int.util.PHXFileUtils.Encoding` | `encoding` | +| `protected java.lang.String` | `fileName` | +| `protected ParseableFile.Mode` | `mode` | +| `protected Parser` | `parser` | +| `protected java.lang.String` | `templateFileName` | +| `protected PHXScriptWrapperObject` | `wrapper` | + +## Constructor Summary + +| Modifier | Constructor and Description | +|----------|----------------------------| +| `protected` | `AbstractFile(java.io.File baseDir, ParseableFile.Mode mode)`
Pre-QuickWrap `PHXRowFieldFile` constructor did not have a `PHXScriptWrapperObject` argument. | +| `protected` | `AbstractFile(PHXScriptWrapperObject wrapper, ParseableFile.Mode mode)` | +| `protected` | `AbstractFile(PHXScriptWrapperObject wrapper, java.io.File dir, ParseableFile.Mode mode)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `protected void` | `actionByMode(ParseableFile.Mode mode)`
Perform an action consistent with ParseableFile.Mode | +| `void` | `backup()`
Backup the file on disk. | +| `void` | `close()`
Close the file and free up resources | +| `void` | `delete()`
Delete the file from disk. | +| `protected void` | `ensureFileParser(ParseableFile.Mode mode)`
Ensure there is a valid parser | +| `com.phoenix_int.util.PHXFileUtils.Encoding` | `getEncoding()` | +| `protected java.io.File` | `getRealFile(java.lang.String fileName)`
Get the file on disk, possibly relative to the current run-share directory | +| `protected abstract Parser` | `newParser(java.io.File rFile, Parser.Mode pmode)`
Generate a new parser for the given file and mode | +| `void` | `readTemplate()`
Read the template. | +| `void` | `setEncoding(com.phoenix_int.util.PHXFileUtils.Encoding enc)` | +| `void` | `setEncoding(java.lang.String enc)` | +| `void` | `setFileToGenerateOrParse(java.lang.String fileName)`
Set the file to generate or to parse, depending on the mode | +| `void` | `setTempEmbedded(java.lang.String option)`
This method applies only to ModelCenter and has no function in ModelCenter Remote Execution | +| `void` | `setTemplateFile(java.lang.String templateFileName)`
Set the template file to read. | +| `void` | `setVariable(java.lang.String name, java.lang.String value)`
Sets the value of a variable | +| `protected abstract void` | `transferVars(ParseableFile.Mode mode)`
Transfer values for variables that have been defined using methods from the concrete implementation | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### mode + +```java +protected final ParseableFile.Mode mode +``` + +### wrapper + +```java +protected final PHXScriptWrapperObject wrapper +``` + +### parser + +```java +protected Parser parser +``` + +### templateFileName + +```java +protected java.lang.String templateFileName +``` + +### fileName + +```java +protected java.lang.String fileName +``` + +### encoding + +```java +protected com.phoenix_int.util.PHXFileUtils.Encoding encoding +``` + +## Constructor Detail + +### AbstractFile + +```java +protected AbstractFile(java.io.File baseDir, + ParseableFile.Mode mode) +``` +Pre-QuickWrap `PHXRowFieldFile` constructor did not have a `PHXScriptWrapperObject` argument. This constructor handles the legacy case, which, in all likelihood, will continue to be used. + +**Parameters:** +- `baseDir` - base directory containing template files, etc. +- `mode` - parsing mode + +### AbstractFile + +```java +protected AbstractFile(PHXScriptWrapperObject wrapper, + ParseableFile.Mode mode) +``` + +### AbstractFile + +```java +protected AbstractFile(PHXScriptWrapperObject wrapper, + java.io.File dir, + ParseableFile.Mode mode) +``` + +**Parameters:** +- `wrapper` - may be null for legacy constructor compatibility +- `dir` - +- `mode` - + +## Method Detail + +### backup + +```java +public void backup() +``` +Backup the file on disk. File is at the same location with ".bac" appended to the end. If a file by that name already exists, it is deleted prior to moving. + +**Specified by:** +- `backup` in interface `ParseableFile` + +### close + +```java +public void close() +``` +Close the file and free up resources + +**Specified by:** +- `close` in interface `ParseableFile` +- `close` in interface `java.io.Closeable` +- `close` in interface `java.lang.AutoCloseable` + +### delete + +```java +public void delete() +``` +Delete the file from disk. + +**Specified by:** +- `delete` in interface `ParseableFile` + +### newParser + +```java +protected abstract Parser newParser(java.io.File rFile, + Parser.Mode pmode) + throws java.io.IOException +``` +Generate a new parser for the given file and mode + +**Parameters:** +- `rFile` - The file to open +- `pmode` - caching mode for underlying parser + +**Throws:** +- `java.io.IOException` + +### ensureFileParser + +```java +protected void ensureFileParser(ParseableFile.Mode mode) + throws java.io.IOException +``` +Ensure there is a valid parser + +**Parameters:** +- `mode` - parser mode in current context + +**Throws:** +- `java.io.IOException` + +### getEncoding + +```java +public com.phoenix_int.util.PHXFileUtils.Encoding getEncoding() +``` + +### setEncoding + +```java +public void setEncoding(com.phoenix_int.util.PHXFileUtils.Encoding enc) +``` + +### setEncoding + +```java +public void setEncoding(java.lang.String enc) +``` + +### getRealFile + +```java +protected java.io.File getRealFile(java.lang.String fileName) +``` +Get the file on disk, possibly relative to the current run-share directory + +**Parameters:** +- `fileName` - + +**Returns:** + +### actionByMode + +```java +protected void actionByMode(ParseableFile.Mode mode) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException +``` +Perform an action consistent with `ParseableFile.Mode` + +**Parameters:** +- `mode` - + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` + +### readTemplate + +```java +public void readTemplate() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException +``` +Read the template. In MCRE 7.1, this method was changed to never throw any exceptions. Reading the templates allows you to fill in default values if you can, but is not mandatory. + +**Specified by:** +- `readTemplate` in interface `ParseableFile` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` + +### setFileToGenerateOrParse + +```java +public void setFileToGenerateOrParse(java.lang.String fileName) +``` +Set the file to generate or to parse, depending on the mode + +**Specified by:** +- `setFileToGenerateOrParse` in interface `ParseableFile` + +### setTempEmbedded + +```java +public void setTempEmbedded(java.lang.String option) +``` +This method applies only to ModelCenter and has no function in ModelCenter Remote Execution + +**Specified by:** +- `setTempEmbedded` in interface `ParseableFile` + +### setTemplateFile + +```java +public void setTemplateFile(java.lang.String templateFileName) +``` +Set the template file to read. If the template file is not specified, it defaults to the file that is parsed or generated, for `Mode.PARSE` or `Mode.GENERATE`, respectively. + +**Specified by:** +- `setTemplateFile` in interface `ParseableFile` + +**Parameters:** +- `templateFileName` - file name + +### setVariable + +```java +public void setVariable(java.lang.String name, + java.lang.String value) + throws PHXNoSuchObjectException +``` +Sets the value of a variable + +**Specified by:** +- `setVariable` in interface `ParseableFile` + +**Parameters:** +- `name` - variable name +- `value` - variable value as a string + +**Throws:** +- `PHXNoSuchObjectException` + +### transferVars + +```java +protected abstract void transferVars(ParseableFile.Mode mode) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException +``` +Transfer values for variables that have been defined using methods from the concrete implementation, i.e. `PHXRowFieldFile.defineVar(String, String, boolean, String)`. Variables defined using `PHXScriptWrapperObject.addVariable(String, String, boolean)` must be explicitly transferred using methods of the concrete implementation class + +**Parameters:** +- `mode` - + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md new file mode 100644 index 0000000000..1beef56c2d --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md @@ -0,0 +1,188 @@ +# Class: CAEOutputFile + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile +``` + +**Implemented Interfaces** + +- `OutputFile2`, `ParseableFile`, `java.io.Closeable`, `java.lang.AutoCloseable` + +--- +## Declaration + +```java +public class CAEOutputFile +extends AbstractFile +implements OutputFile2 +``` + +This represents a binary output file from a CAE program such as NASTRAN or LSDyna. + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile + `ParseableFile.Mode` + +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile +`encoding`, `fileName`, `mode`, `parser`, `templateFileName`, `wrapper` + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `CAEOutputFile(PHXScriptWrapperObject wrapper, java.io.File file)` | +| `CAEOutputFile(PHXScriptWrapperObject wrapper, java.io.File file, FileType type)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `defineArrayVar(java.lang.String name, java.lang.String specifier)` | +| `void` | `defineVar(java.lang.String name, java.lang.String specifier)` | +| `protected Parser` | `newParser(java.io.File rFile, Parser.Mode pmode)`
Generate a new parser for the given file and mode | +| `void` | `parse()`
Parse the output file | +| `void` | `setFileToParse(java.lang.String fileName)`
Set the file to parse | +| `protected void` | `transferVars(ParseableFile.Mode mode)`
Transfer values for variables that have been defined using methods from the concrete implementation | + +### Methods inherited from class AbstractFile + +`actionByMode`, `backup`, `close`, `delete`, `ensureFileParser`, `getEncoding`, `getRealFile`, `readTemplate`, `setEncoding`, `setEncoding`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, `setVariable` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### CAEOutputFile + +```java +public CAEOutputFile(PHXScriptWrapperObject wrapper, + java.io.File file, + FileType type) + throws PHXLicenseException +``` + +**Throws:** +- `PHXLicenseException` + +### CAEOutputFile + +```java +public CAEOutputFile(PHXScriptWrapperObject wrapper, + java.io.File file) + throws PHXLicenseException +``` + +**Throws:** +- `PHXLicenseException` + +## Method Detail + +### defineArrayVar + +```java +public void defineArrayVar(java.lang.String name, + java.lang.String specifier) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### defineVar + +```java +public void defineVar(java.lang.String name, + java.lang.String specifier) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### parse + +```java +public void parse() throws java.lang.Exception +``` +Parse the output file + +**Specified by:** +- `parse` in interface `OutputFile2` + +**Throws:** +- `java.lang.Exception` + +### newParser + +```java +protected Parser newParser(java.io.File rFile, + Parser.Mode pmode) + throws java.io.IOException +``` +Generate a new parser for the given file and mode + +**Specified by:** +- `newParser` in class `AbstractFile` + +**Parameters:** +- `rFile` - The file to open +- `pmode` - caching mode for underlying parser + +**Throws:** +- `java.io.IOException` + +### transferVars + +```java +protected void transferVars(ParseableFile.Mode mode) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Transfer values for variables that have been defined using methods from the concrete implementation, i.e. `PHXRowFieldFile.defineVar(String, String, boolean, String)`. Variables defined using `PHXScriptWrapperObject.addVariable(String, String, boolean)` must be explicitly transferred using methods of the concrete implementation class + +**Specified by:** +- `transferVars` in class `AbstractFile` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### setFileToParse + +```java +public void setFileToParse(java.lang.String fileName) +``` +Set the file to parse + +**Specified by:** +- `setFileToParse` in interface `OutputFile2` + +**Parameters:** +- `fileName` - \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md new file mode 100644 index 0000000000..3d84b8ad69 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md @@ -0,0 +1,68 @@ +# Interface: IPHXRange + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Interface Hierarchy** + +``` +↳ com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRange +``` + +**All Known Implementing Classes:** +[PHXCAERange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.html), [PHXRowFieldRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.html) + +--- +**Declaration** + +```java +public interface IPHXRange +``` + +## Method Summary + +| Modifier and Type | Method and Description | +|-----------------------|---------------------------------------| +| `void` | `assertEquals(IPHXRange other)` | +| `void` | `fromString(java.lang.String str)` | +| `java.lang.String` | `getPageName()` | +| `java.lang.String` | `toString()` | +| `java.lang.String` | `toString(boolean fullName)` | + +## Method Detail + +### fromString + +```java +void fromString(java.lang.String str) +``` + +### toString + +```java +java.lang.String toString() +``` + +**Overrides:** +`toString` in class `java.lang.Object` + +### toString + +```java +java.lang.String toString(boolean fullName) +``` + +### assertEquals + +```java +void assertEquals(IPHXRange other) + throws java.lang.Exception +``` + +**Throws:** +`java.lang.Exception` + +### getPageName + +```java +java.lang.String getPageName() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md new file mode 100644 index 0000000000..8360a93c6d --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md @@ -0,0 +1,31 @@ +# Interface: IPHXRangeChangeListener + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Interface Hierarchy** + +``` +↳ com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRangeChangeListener +``` +--- +**Declaration** + +```java +public interface IPHXRangeChangeListener +``` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `onRangesChanged(java.lang.Object var, java.util.Vector rangesAdded, java.util.Vector rangesRemoved)` | + +## Method Detail + +### onRangesChanged + +```java +void onRangesChanged(java.lang.Object var, + java.util.Vector rangesAdded, + java.util.Vector rangesRemoved) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md new file mode 100644 index 0000000000..4bc662b5cd --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md @@ -0,0 +1,73 @@ +# Interface: InputFile + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**All Superinterfaces** + +- `ParseableFile` + +**All Known Implementing Classes** + +- `PHXRowFieldFile`, `XPathFile` +--- +## Declaration + +```java +public interface InputFile +extends ParseableFile +``` + +Interface for input files (not file variables) used in script-wrappers + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile +`ParseableFile.Mode` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `generate()`
Generate the input file | +| `void` | `setFileToGenerate(java.lang.String fileName)`
Set the file to be generated | + +### Methods inherited from interface ParseableFile + +`backup`, `close`, `delete`, `readTemplate`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, `setVariable` + +## Method Detail + +### generate + +```java +void generate() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException +``` +Generate the input file + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` + +### setFileToGenerate + +```java +void setFileToGenerate(java.lang.String fileName) +``` +Set the file to be generated + +**Parameters:** +- `fileName` - file name \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md new file mode 100644 index 0000000000..a283820cf4 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md @@ -0,0 +1,81 @@ +# Interface: OutputFile + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Interface Hierarchy** + +``` +↳ com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile +``` + +**All Superinterfaces:** +[ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) + +**All Known Implementing Classes:** +[PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html), [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) + +@Deprecated in favor of [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) + +--- +**Declaration** + +```java +@Deprecated +public interface OutputFile +extends ParseableFile +``` + +Interface for output files (not file variables) used in script-wrappers + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile +`ParseableFile.Mode` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `parse()`
@Deprecated. Parse the output file | +| `void` | `setFileToParse(java.lang.String fileName)`
@Deprecated. Set the file to be parsed | + +### Methods inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile +`backup`, `close`, `delete`, `readTemplate`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, `setVariable` + +## Method Detail + +### parse + +```java +void parse() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException +``` +@Deprecated. Parse the output file + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` + +### setFileToParse + +```java +void setFileToParse(java.lang.String fileName) +``` +@Deprecated. Set the file to be parsed + +**Parameters:** +- `fileName` - file name \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md new file mode 100644 index 0000000000..327f483b1e --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md @@ -0,0 +1,50 @@ +# Interface: OutputFile2 + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Interface Hierarchy** + +``` +↳ com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile2 +``` + +**All Known Implementing Classes:** +[CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html), [PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html), [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) +--- +**Declaration** + +```java +public interface OutputFile2 +``` + +Interface for output files (not file variables) used in script-wrappers + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `parse()`
Parse the output file | +| `void` | `setFileToParse(java.lang.String fileName)`
Sets the file that will be parsed. | + +## Method Detail + +### parse + +```java +void parse() + throws java.lang.Exception +``` +Parse the output file + +**Throws:** +- `java.lang.Exception` + +### setFileToParse + +```java +void setFileToParse(java.lang.String fileName) +``` +Sets the file that will be parsed. Usually this is synonymous with [ParseableFile.setFileToGenerateOrParse(String)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html#setFileToGenerateOrParse-java.lang.String-) + +**Parameters:** +- `fileName` - The file to parse \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md new file mode 100644 index 0000000000..ecdef15cf4 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md @@ -0,0 +1,120 @@ +# Class: PHXBookmark + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark +``` +--- + +**Declaration** + +```java +public class PHXBookmark + extends java.lang.Object +``` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `java.lang.Object` | `owner` | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXBookmark(java.lang.String name, PHXRowFieldRange range)`
Constructor | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `assertEquals(PHXBookmark other)`
Test comparison function. | +| `static java.lang.String` | `correctName(java.lang.String tempName)` | +| `java.util.Vector` | `getChildren(java.util.Vector bookmarks, boolean immOnly)` | +| `java.lang.String` | `getName()` | +| `PHXRowFieldRange` | `getRange()` | +| `void` | `setName(java.lang.String name)` | +| `void` | `setRange(PHXRowFieldRange range)` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### owner + +```java +public java.lang.Object owner +``` + +## Constructor Detail + +### PHXBookmark + +```java +public PHXBookmark(java.lang.String name, + PHXRowFieldRange range) +``` + +**Parameters:** +- `name` - a unique bookmark name +- `range` - the range identifying the bookmark + +## Method Detail + +### getName + +```java +public java.lang.String getName() +``` + +### setName + +```java +public void setName(java.lang.String name) +``` + +### getRange + +```java +public PHXRowFieldRange getRange() +``` + +### setRange + +```java +public void setRange(PHXRowFieldRange range) +``` + +### getChildren + +```java +public java.util.Vector getChildren(java.util.Vector bookmarks, + boolean immOnly) +``` + +### assertEquals + +```java +public void assertEquals(PHXBookmark other) + throws java.lang.Exception +``` +Test comparison function. If the two objects are not equal, an exception is thrown + +**Parameters:** +- `other` - the data model to compare this to + +**Throws:** +- `java.lang.Exception` - thrown if the data models do not match + +### correctName + +```java +public static java.lang.String correctName(java.lang.String tempName) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md new file mode 100644 index 0000000000..5eb2b0749c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md @@ -0,0 +1,52 @@ +# Class: PHXBookmarkNotFoundException + +**Package:** +- `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmarkNotFoundException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** +```java +public class PHXBookmarkNotFoundException +extends java.lang.Exception +``` + +**See Also:** +- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmarkNotFoundException) + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXBookmarkNotFoundException(java.lang.String bookmarkName)` | + +## Method Summary + +### Methods inherited from class java.lang.Throwable + +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXBookmarkNotFoundException + +```java +public PHXBookmarkNotFoundException(java.lang.String bookmarkName) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md new file mode 100644 index 0000000000..cb741798f2 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md @@ -0,0 +1,146 @@ +# Class: PHXCAERange + +**Package:** +- `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange +``` + +**Implemented Interfaces** + +- [IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) + +---- + +**Declaration** + +```java +public class PHXCAERange +extends java.lang.Object +implements IPHXRange +``` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static java.lang.String` | `NAME_SEPARATOR` | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXCAERange()` | +| `PHXCAERange(java.lang.String str)` | +| `PHXCAERange(java.lang.String pageName, java.lang.String str)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `assertEquals(IPHXRange other)` | +| `void` | `fromString(java.lang.String str)` | +| `java.lang.String` | `getPageName()` | +| `void` | `setPageName(java.lang.String pageName)` | +| `java.lang.String` | `toString()` | +| `java.lang.String` | `toString(boolean fullName)` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Field Detail + +### NAME_SEPARATOR + +```java +public static final java.lang.String NAME_SEPARATOR +``` + +**See Also:** +- [Constant Field Values](../../../../../../constant-values.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange.NAME_SEPARATOR) + +## Constructor Detail + +### PHXCAERange + +```java +public PHXCAERange() +``` + +### PHXCAERange + +```java +public PHXCAERange(java.lang.String str) +``` + +### PHXCAERange + +```java +public PHXCAERange(java.lang.String pageName, + java.lang.String str) +``` + +## Method Detail + +### fromString + +```java +public void fromString(java.lang.String str) +``` + +**Specified by:** +- `fromString` in interface `IPHXRange` + +### toString + +```java +public java.lang.String toString() +``` + +**Specified by:** +- `toString` in interface `IPHXRange` + +**Overrides:** +- `toString` in class `java.lang.Object` + +### toString + +```java +public java.lang.String toString(boolean fullName) +``` + +**Specified by:** +- `toString` in interface `IPHXRange` + +### assertEquals + +```java +public void assertEquals(IPHXRange other) + throws java.lang.Exception +``` + +**Specified by:** +- `assertEquals` in interface `IPHXRange` + +**Throws:** +- `java.lang.Exception` + +### setPageName + +```java +public void setPageName(java.lang.String pageName) +``` + +### getPageName + +```java +public java.lang.String getPageName() +``` + +**Specified by:** +- `getPageName` in interface `IPHXRange` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md new file mode 100644 index 0000000000..101f84b484 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md @@ -0,0 +1,1014 @@ +# Class: PHXRowFieldFile + +**Package:** +- `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile +``` + +**Implemented Interfaces** + +- [InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html) +- [OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) +- [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) +- [ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) +- java.io.Closeable +- java.lang.AutoCloseable + +--- +**Declaration** + +```java +public class PHXRowFieldFile +extends AbstractFile +implements InputFile, OutputFile, OutputFile2 +``` + +Class implements the parsing capabilities of the RowField type files from the fileWrapper facility. Typical use would be to write a function which creates an instance of this class and implements the parsing using the `transferVar()` function. Then, a mode can be passed in which specifies whether the function should read the template file, generate an input file, or parse an output file. +You will want to read the documentation on the fileWrapper utility for more specifics on how exactly the file parsing and options work. + +Example usage from a java scriptwrapper (Comments show fileWrapper equivalents): + +```java + //RowFieldInputFile freqIN + void rowFieldFreqIN(int mode) + throws Exception + { + RowFieldFile file = new RowFieldFile(super.wrapper, mode) + //templateFile: freq.txt.template + file.setTemplateFile("freq.txt.template"); + //fileToGenerate: freq.txt + file.setFileToGenerateOrParse("freq.txt"); + + //variable: W1 double 1 2 + file.transferVar(super.W1, 1, 2); + //variable: W2 double 2 2 + file.transferVar(super.W2, 2, 2); + //variable: u1 double 3 2 + file.transferVar(super.u1, 3, 2); + //variable: u2 double 4 2 + file.transferVar(super.u2, 4, 2); + + //Actually generate a file if we are told to + if ( mode == RowFieldFile.GENERATE ) + file.generate(); + } +``` + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile +`ParseableFile.Mode` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static int` | `GENERATE`
Deprecated. in favor of [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) | +| `static int` | `PARSE`
Deprecated. in favor of [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE) | +| `static int` | `READ_TEMPLATE`
Deprecated. in favor of [ParseableFile.Mode.READ_TEMPLATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#READ_TEMPLATE) | + +### Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile + +`encoding`, `fileName`, `mode`, `parser`, `templateFileName`, `wrapper` + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXRowFieldFile(PHXScriptWrapperObject wrapper)`
Defaults to [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) | +| `PHXRowFieldFile(PHXScriptWrapperObject wrapper, int mode)`
Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#PHXRowFieldFile-com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject-com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode-) | +| `PHXRowFieldFile(PHXScriptWrapperObject wrapper, ParseableFile.Mode mode)` | +| `PHXRowFieldFile(java.lang.String baseDirectory, int mode)`
Legacy (pre-QW) constructor. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `clearMarks()`
Removes effects of any previous markAsBeginning() or markAsEnd() calls | +| `void` | `defineBookmark(java.lang.String name, java.lang.String parent, java.lang.String start)` | +| `void` | `defineSection(java.lang.String name, java.lang.String start, java.lang.String end, java.lang.String delimiters)` | +| `void` | `defineVar(java.lang.String name, java.lang.String type, boolean isInput, java.lang.String rangeStr)` | +| `void` | `defineVar(java.lang.String name, java.lang.String type, boolean isInput, java.lang.String rangeStr, java.lang.String units, java.lang.String description, java.lang.String lowerBound, java.lang.String upperBound, java.lang.String enumValues, java.lang.String enumAliases, java.lang.String format)` | +| `void` | `defineVar(java.lang.String name, java.lang.String type, boolean isInput, java.lang.String rangesStr, java.lang.String units, java.lang.String description, java.lang.String lowerBound, java.lang.String upperBound, java.lang.String enumValues, java.lang.String enumAliases, java.lang.String format, java.lang.String fformat)` | +| `protected void` | `ensureFileParser(ParseableFile.Mode mode)`
Ensure there is a valid parser | +| `void` | `generate()`
Generate the input file | +| `void` | `markAsBeginning(int row)`
Makes the specified row act as row 1 for all subsequent calls until another markAsBeginning or clearMarks call. | +| `void` | `markAsBeginning(java.lang.String find)`
Searches for the specified string and makes the row where the string was found act as row 1 for all subsequent calls until another markAsBeginning or clearMarks call. | +| `void` | `markAsBeginning(java.lang.String find, int occurrence, int offset, boolean regex)`
Searches for the specified string and makes the row where the string was found act as row 1 for all subsequent calls until another markAsBeginning or clearMarks call. | +| `void` | `markAsEnd(int row)`
Makes the specified row act as row -1 (end of file) for all subsequent calls until another markAsBeginning or clearMarks call. | +| `void` | `markAsEnd(java.lang.String find)`
Searches for the specified string, starting from the end of the file and working towards the beginning, and makes the row where the string was found act as row -1 (end of file) for all subsequent calls until another markAsEnd or clearMarks call. | +| `void` | `markAsEnd(java.lang.String find, int occurrence, int offset, boolean regex)`
Searches for the specified string and makes the row where the string was found act as row -1 (end of file) for all subsequent calls until another markAsEnd or clearMarks call. | +| `protected Parser` | `newParser(java.io.File rFile, Parser.Mode pmode)`
Generate a new parser for the given file and mode | +| `void` | `parse()`
Parse the output file | +| `double` | `readDouble(int row, int field)`
Reads a value out of the input file. | +| `long` | `readLong(int row, int field)`
Reads a value out of the input file. | +| `java.lang.String` | `readValue(int row, int field)`
Reads a value out of the input file. | +| `void` | `setDecimalSeparator(char separator)`
Set decimal separator for floating point value literals. | +| `void` | `setDelimiters(java.lang.String delimiters)`
Sets the delimiters which should be used for parsing lines into fields. | +| `void` | `setFileToGenerate(java.lang.String fileName)`
Set the file to be generated | +| `void` | `setFileToParse(java.lang.String fileName)`
Set the file to be parsed | +| `void` | `transferArray(PHXSimpleArray var, int rowstart, int rowend, int fieldstart, int fieldend)`
Transfers the data for a particular array. | +| `void` | `transferArray(PHXSimpleArray var, int rowstart, int rowend, int fieldstart, int fieldend, boolean resizable, java.lang.String fformat)`
Transfers the data for a particular array. | +| `void` | `transferArray(PHXSimpleArray var, int rowstart, int rowend, int fieldstart, int fieldend, boolean resizable, java.lang.String fformat, int numDimensions)`
Transfers the data for a particular array. | +| `void` | `transferArray(PHXSimpleArray var, int rowstart, int rowend, int fieldstart, int fieldend, int numDimensions)`
Transfers the data for a particular array. | +| `void` | `transferKeyVar(PHXSimpleType var, java.lang.String key)`
Transfers the data for a particular variable. | +| `void` | `transferKeyVar(PHXSimpleType var, java.lang.String key, int occurrence, int rowOffset, int field, java.lang.String fformat)`
Transfers the data for a particular variable. | +| `void` | `transferVar(PHXSimpleType var, int row, int field)`
Transfers the data for a particular variable. | +| `void` | `transferVar(PHXSimpleType var, int row, int field, java.lang.String fformat)`
Transfers the data for a particular variable. | +| `void` | `transferVar(java.lang.String name, PHXSimpleType var, int row, int field)` | +| `void` | `transferVar(java.lang.String name, PHXSimpleType var, int row, int field, java.lang.String fformat)` | +| `protected void` | `transferVars(ParseableFile.Mode mode)`
Note that if wrapper is null, variable collection should be empty, and there should be no harm in calling this method | +| `void` | `writeValue(int row, int field, java.lang.String val)`
Writes a token out to the output file. | + +### Methods inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile + +`actionByMode`, `backup`, `close`, `delete`, `getEncoding`, `getRealFile`, `readTemplate`, `setEncoding`, `setEncoding`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, s`etVariable` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +### Methods inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile + +`backup`, `close`, `delete`, `readTemplate`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, `setVariable` + +## Field Detail + +### GENERATE + +```java +@Deprecated +public static final int GENERATE +``` +Deprecated. in favor of [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) + +This mode makes the row field file prepare to generate the output file by reading the template file, then replacing the specified values passed to `transferVar()`. + +### PARSE + +```java +@Deprecated +public static final int PARSE +``` +Deprecated. in favor of [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE) +This mode makes the row field file read in values from the `fileToParse` when `transferVar()` is called. + +### READ_TEMPLATE + +```java +@Deprecated +public static final int READ_TEMPLATE +``` +Deprecated. in favor of [ParseableFile.Mode.READ_TEMPLATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#READ_TEMPLATE) + +This mode makes the row field file read in values from the template file when `transferVar()` is called. + +## Constructor Detail + +### PHXRowFieldFile + +```java +public PHXRowFieldFile(PHXScriptWrapperObject wrapper) +``` +Defaults to [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) + +**Parameters:** +- `wrapper` - script-wrapper object + +### PHXRowFieldFile + +```java +public PHXRowFieldFile(PHXScriptWrapperObject wrapper, ParseableFile.Mode mode) +``` + +### PHXRowFieldFile + +```java +@Deprecated +public PHXRowFieldFile(PHXScriptWrapperObject wrapper, int mode) +``` +Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#PHXRowFieldFile-com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject-com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode-) + +**Parameters:** +- `wrapper` - The row field file will find files relative to the run directory specified in this wrapper object. +- `mode` - parser mode + +### PHXRowFieldFile + +```java +public PHXRowFieldFile(java.lang.String baseDirectory, int mode) +``` +Legacy (pre-QW) constructor. + +Note: Using this constructor will make the resultant object incompatible with certain methods. This was necessary for compatibility with QuickWrap. The new constructors accept [PHXScriptWrapperObject](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html). This constructor passes `null` instead. + +**Parameters:** +- `baseDirectory` - All files will be relative to this directory +- `mode` - parser mode + +## Method Detail + +### generate + +```java +public void generate() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Generate the input file + +**Specified by:** +- `generate` in interface `InputFile` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### setFileToGenerate + +```java +public void setFileToGenerate(java.lang.String fileName) +``` +Set the file to be generated + +**Specified by:** +- `setFileToGenerate` in interface `InputFile` + +**Parameters:** +- `fileName` - file name + +### parse + +```java +public void parse() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Parse the output file + +**Specified by:** +- `parse` in interface `OutputFile` +- `parse` in interface `OutputFile2` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### setFileToParse + +```java +public void setFileToParse(java.lang.String fileName) +``` +Set the file to be parsed + +**Specified by:** +- `setFileToParse` in interface `OutputFile` +- `setFileToParse` in interface `OutputFile2` + +**Parameters:** +- `fileName` - file name + +### newParser + +```java +protected Parser newParser(java.io.File rFile, + Parser.Mode pmode) + throws java.io.IOException +``` +Generate a new parser for the given file and mode + +**Specified by:** +- `newParser` in class `AbstractFile` + +**Parameters:** +- `rFile` - The file to open +- `pmode` - caching mode for underlying parser + +**Throws:** +- `java.io.IOException` + +### ensureFileParser + +```java +protected void ensureFileParser(ParseableFile.Mode mode) + throws java.io.IOException +``` +Ensure there is a valid parser + +**Overrides:** +- `ensureFileParser` in class `AbstractFile` + +**Parameters:** +- `mode` - parser mode in current context + +**Throws:** +- `java.io.IOException` + +### defineSection + +```java +public void defineSection(java.lang.String name, + java.lang.String start, + java.lang.String end, + java.lang.String delimiters) + throws com.phoenix_int.aserver.util.PHXNoSuchBookmarkException +``` + +**Throws:** +- `com.phoenix_int.aserver.util.PHXNoSuchBookmarkException` + +### defineBookmark + +```java +public void defineBookmark(java.lang.String name, + java.lang.String parent, + java.lang.String start) +``` + +### defineVar + +```java +public void defineVar(java.lang.String name, + java.lang.String type, + boolean isInput, + java.lang.String rangeStr) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### defineVar + +```java +public void defineVar(java.lang.String name, + java.lang.String type, + boolean isInput, + java.lang.String rangeStr, + java.lang.String units, + java.lang.String description, + java.lang.String lowerBound, + java.lang.String upperBound, + java.lang.String enumValues, + java.lang.String enumAliases, + java.lang.String format) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### defineVar + +```java +public void defineVar(java.lang.String name, + java.lang.String type, + boolean isInput, + java.lang.String rangesStr, + java.lang.String units, + java.lang.String description, + java.lang.String lowerBound, + java.lang.String upperBound, + java.lang.String enumValues, + java.lang.String enumAliases, + java.lang.String format, + java.lang.String fformat) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### transferVars + +```java +protected void transferVars(ParseableFile.Mode mode) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Note that if wrapper is null, variable collection should be empty, and there should be no harm in calling this method. + +Transfer values for variables that have been defined using methods from the concrete implementation, i.e. [defineVar(String, String, boolean, String)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#defineVar-java.lang.String-java.lang.String-boolean-java.lang.String-) + +Variables defined using [PHXScriptWrapperObject.addVariable(String, String, boolean)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html#addVariable-java.lang.String-java.lang.String-boolean-) must be explicitly transferred using methods of the concrete implementation class. + +**Specified by:** +- `transferVars` in class `AbstractFile` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### transferVar + +```java +public void transferVar(PHXSimpleType var, + int row, + int field) + throws java.io.IOException, + PHXNoSuchTokenException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The variable to read or write +- `row` - The row in the file to read/write from/to. +- `field` - The field within the row to read/write from/to. + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### transferVar + +```java +public void transferVar(java.lang.String name, + PHXSimpleType var, + int row, + int field) + throws java.io.IOException, + PHXNoSuchTokenException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### transferVar + +```java +public void transferVar(PHXSimpleType var, + int row, + int field, + java.lang.String fformat) + throws java.io.IOException, + PHXNoSuchTokenException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The variable to read or write +- `row` - The row in the file to read/write from/to. +- `field` - The field within the row to read/write from/to. +- `fformat` - The fortran style format string to apply. Pass null + for standard formatting. + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### transferVar + +```java +public void transferVar(java.lang.String name, + PHXSimpleType var, + int row, + int field, + java.lang.String fformat) + throws java.io.IOException, + PHXNoSuchTokenException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### transferArray + +```java +public void transferArray(PHXSimpleArray var, + int rowstart, + int rowend, + int fieldstart, + int fieldend) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The array to read or write +- `rowstart` - The starting row in the file to read/write from/to +- `rowend` - The ending row in the file to read/write from/to +- `fieldstart` - The starting field within the row to read/write from/to +- `fieldend` - The ending field within the row to read/write from/to + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### transferArray + +```java +public void transferArray(PHXSimpleArray var, + int rowstart, + int rowend, + int fieldstart, + int fieldend, + int numDimensions) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The array to read or write +- `rowstart` - The starting row in the file to read/write from/to +- `rowend` - The ending row in the file to read/write from/to +- `fieldstart` - The starting field within the row to read/write from/to +- `fieldend` - The ending field within the row to read/write from/to +- `numDimensions` - Either 1 or 2 to read/write 1 or 2-d arrays. + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### transferArray + +```java +public void transferArray(PHXSimpleArray var, + int rowstart, + int rowend, + int fieldstart, + int fieldend, + boolean resizable, + java.lang.String fformat) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The array to read or write +- `rowstart` - The starting row in the file to read/write from/to +- `rowend` - The ending row in the file to read/write from/to +- `fieldstart` - The starting field within the row to read/write from/to +- `fieldend` - The ending field within the row to read/write from/to +- `resizable` - Whether or not the array is resizable when using [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE). +- `fformat` - The fortran style format string to apply. Pass null for standard formatting. + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### transferArray + +```java +public void transferArray(PHXSimpleArray var, + int rowstart, + int rowend, + int fieldstart, + int fieldend, + boolean resizable, + java.lang.String fformat, + int numDimensions) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The array to read or write +- `rowstart` - The starting row in the file to read/write from/to +- `rowend` - The ending row in the file to read/write from/to +- `fieldstart` - The starting field within the row to read/write from/to +- `fieldend` - The ending field within the row to read/write from/to +- `resizable` - Whether or not the array is resizable when using [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE). +- `fformat` - The fortran style format string to apply. Pass null for standard formatting. +- `numDimensions` - The number of dimensions to read the array as. Must be 1 or 2. + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### transferKeyVar + +```java +public void transferKeyVar(PHXSimpleType var, + java.lang.String key) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + PHXNumberFormatException +``` +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The variable to read or write +- `key` - The string to search for that identifies the variable in the file. + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `PHXNumberFormatException` + +### transferKeyVar + +```java +public void transferKeyVar(PHXSimpleType var, + java.lang.String key, + int occurrence, + int rowOffset, + int field, + java.lang.String fformat) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + PHXNumberFormatException +``` +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. + +**Parameters:** +- `var` - The variable to read or write +- `key` - The string to search for that identifies the variable in the file. +- `occurrence` - (default 1). Which occurrence of string to find. +- `rowOffset` - (default 0). Once the string is found, offset by this many rows +- `field` - (default 1). Once the string is found, offset by this many fields. If a negative number is used, it will count from the end of the row backwards, but will not count past the key variable. +- `fformat` - The fortran style format string to apply. Pass null for standard formatting. + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `PHXNumberFormatException` + +### readValue + +```java +public java.lang.String readValue(int row, + int field) + throws java.io.IOException, + PHXNoSuchTokenException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE), the input file is the fileToParse, otherwise it is the template file. + +**Parameters:** +- `row` - The row of the file to read from +- `field` - The field of the file to read from. + +**Throws:** +- `java.lang.IllegalArgumentException`- This function does not work if `setDelimiters("columns")` has been specified. +- `java.io.IOException` +- `PHXNoSuchTokenException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### readLong + +```java +public long readLong(int row, + int field) + throws java.io.IOException, + PHXNoSuchTokenException, + java.lang.NumberFormatException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE), the input file is the fileToParse, otherwise it is the template file. Returns it as a long value. + +**Parameters:** +- `row` - The row of the file to read from +- `field` - The field of the file to read from. + +**Throws:** +- `java.lang.IllegalArgumentException`- This function does not work if `setDelimiters("columns")` has been specified. +- `java.io.IOException` +- `PHXNoSuchTokenException` +- `java.lang.NumberFormatException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### readDouble + +```java +public double readDouble(int row, + int field) + throws java.io.IOException, + PHXNoSuchTokenException, + java.lang.NumberFormatException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE), the input file is the fileToParse, otherwise it is the template file. Returns it as a double value. + +**Parameters:** +- `row` - The row of the file to read from +- `field` - The field of the file to read from. + +**Throws:** +- `java.lang.IllegalArgumentException`- This function does not work if `setDelimiters("columns") `has been specified. +- `java.io.IOException` +- `PHXNoSuchTokenException` +- `java.lang.NumberFormatException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### writeValue + +```java +public void writeValue(int row, + int field, + java.lang.String val) + throws java.io.IOException, + PHXNoSuchTokenException +``` +Writes a token out to the output file. This is only useful if mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE). + +**Parameters:** +- `row` - The row of the file to read from +- `field` - The field of the file to read from. +- `val` - The string to write + +**Throws:** +- `java.lang.IllegalArgumentException`- This function does not work if `setDelimiters("columns")` has been specified. +- `java.io.IOException` +- `PHXNoSuchTokenException` + +### setDelimiters + +```java +public void setDelimiters(java.lang.String delimiters) + throws java.io.IOException +``` +Sets the delimiters which should be used for parsing lines into fields. + +Acceptable values: +- "columns" - Fortran style column based fields. +- null - default delimiters (whitespace) +- "whitespace" - default delimiters (whitespace) +- "default" - default delimiters (whitespace) +- "" - default delimiters (whitespace) +- "none" - No delimiters (entire line as single field) +- Any other string is taken as a list of character delimiters + +**Throws:** +- `java.io.IOException` + +### setDecimalSeparator + +```java +public void setDecimalSeparator(char separator) +``` +Set decimal separator for floating point value literals. + +**Parameters:** +- `separator` - character to be used as a decimal separator + +### clearMarks + +```java +public void clearMarks() + throws java.io.IOException +``` +Removes effects of any previous `markAsBeginning()` or `markAsEnd()` calls + +**Throws:** +- `java.io.IOException` + +### markAsBeginning + +```java +public void markAsBeginning(java.lang.String find) + throws java.io.IOException, + PHXNoSuchTokenException +``` +Searches for the specified string and makes the row where the string was found act as row 1 for all subsequent calls until another `markAsBeginning` or `clearMarks` call. + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` + +### markAsBeginning + +```java +public void markAsBeginning(java.lang.String find, + int occurrence, + int offset, + boolean regex) + throws java.io.IOException, + PHXNoSuchTokenException +``` +Searches for the specified string and makes the row where the string was found act as row 1 for all subsequent calls until another `markAsBeginning` or `clearMarks` call. + +**Parameters:** +- `find` - The string to search for. +- `occurrence` - Search for the Nth occurrence of string (default 1) +- `offset` - After finding string, move down offset rows. May be negative to move up. (default 0) +- `regex` - If `true`, the find parameter is a regular expression. (default `false`) + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` + +### markAsBeginning + +```java +public void markAsBeginning(int row) + throws java.io.IOException, + PHXNoSuchTokenException +``` +Makes the specified row act as row 1 for all subsequent calls until another `markAsBeginning` or `clearMarks` call. + +**Parameters:** +- `row` - The row to set + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` + +### markAsEnd + +```java +public void markAsEnd(java.lang.String find) + throws java.io.IOException, + PHXNoSuchTokenException +``` +Searches for the specified string, starting from the end of the file and working towards the beginning, and makes the row where the string was found act as row -1 (end of file) for all subsequent calls until another `markAsEnd` or `clearMarks` call. + +**Parameters:** +- `find` - The string to search for. + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` + +### markAsEnd + +```java +public void markAsEnd(java.lang.String find, + int occurrence, + int offset, + boolean regex) + throws java.io.IOException, + PHXNoSuchTokenException +``` +Searches for the specified string and makes the row where the string was found act as row -1 (end of file) for all subsequent calls until another `markAsEnd` or `clearMarks` call. + +**Parameters:** +- `find` - The string to search for. +- `occurrence` - Search for the Nth occurrence of string (default 1) +- `offset` - After finding string, move down offset rows. May be negative to move up. (default 0) +- `regex` - If `true`, the find parameter is a regular expression. (default `false`) + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` + +### markAsEnd + +```java +public void markAsEnd(int row) + throws java.io.IOException, + PHXNoSuchTokenException +``` +Makes the specified row act as row -1 (end of file) for all subsequent calls until another `markAsBeginning` or `clearMarks` call. + +**Parameters:** +- `row` - The row to set + +**Throws:** +- `java.io.IOException` +- `PHXNoSuchTokenException` diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md new file mode 100644 index 0000000000..a9822fc66b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md @@ -0,0 +1,447 @@ +# Class: PHXRowFieldRange + +**Package:** +- `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange +``` + +**Implemented Interfaces** + +- [IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) + +--- +**Declaration** + +```java +public class PHXRowFieldRange +extends java.lang.Object +implements IPHXRange +``` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static java.lang.String` | `NAME_SEPARATOR` | +| `static java.lang.String` | `RANGE_SEPARATOR` | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `PHXRowFieldRange()` | +| `PHXRowFieldRange(java.lang.String str)` | +| `PHXRowFieldRange(java.lang.String start, java.lang.String end)` | +| `PHXRowFieldRange(java.lang.String pageName, int row)` | +| `PHXRowFieldRange(java.lang.String pageName, int row, int field)` | +| `PHXRowFieldRange(java.lang.String pageName, java.lang.String parent, int startRow)` | +| `PHXRowFieldRange(java.lang.String pageName, java.lang.String parent, java.lang.String startMark, int startOccurrence)` | +| `PHXRowFieldRange(java.lang.String pageName, java.lang.String startRow, java.lang.String endRow)` | +| `PHXRowFieldRange(java.lang.String pageName, java.lang.String parent, java.lang.String start, java.lang.String end)` | +| `PHXRowFieldRange(java.lang.String pageName, java.lang.String startRow, java.lang.String endRow, java.lang.String startCol, java.lang.String endCol)` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `int` | `absoluteEndRow(IPHXLineStore lines, java.util.Vector bookmarks, java.util.Vector sections)` | +| `int` | `absoluteStartRow(IPHXLineStore lines, java.util.Vector bookmarks, java.util.Vector sections)`
Returns the actual starting row number | +| `void` | `assertEquals(IPHXRange other)`
Test comparison function. | +| `void` | `clearEndingMark()` | +| `void` | `clearStartingMark()` | +| `void` | `fromString(java.lang.String str)` | +| `int` | `getAbsoluteStartRow()`
Returns the stored starting row number, assuming it has been stored. | +| `java.lang.String` | `getDelimiters()` | +| `java.lang.String` | `getEnd()` | +| `int` | `getEndCol()` | +| `java.lang.String` | `getEndMark()` | +| `int` | `getEndOccurrence()` | +| `int` | `getEndOffset()` | +| `java.lang.String` | `getEndParent()` | +| `int` | `getEndRow()` | +| `int` | `getNumDimensions()` | +| `int` | `getNumDimensions(java.lang.String fformat)` | +| `java.lang.String` | `getPageName()` | +| `java.lang.String` | `getParent()` | +| `java.lang.String` | `getRowColString()` | +| `java.lang.String` | `getStart()` | +| `java.lang.String` | `getStart(boolean addEscapes)` | +| `int` | `getStartCol()` | +| `java.lang.String` | `getStartMark()` | +| `int` | `getStartOccurrence()` | +| `int` | `getStartOffset()` | +| `int` | `getStartRow()` | +| `boolean` | `isArray()` | +| `boolean` | `isColArray()` | +| `boolean` | `isHorizontallyResizable()` | +| `boolean` | `isRowArray()` | +| `void` | `setAbsoluteStartRow(int row)`
Sets the stored starting row number. | +| `void` | `setDelimiters(java.lang.String delim)` | +| `void` | `setEndingCol(int col)` | +| `void` | `setEndingMark(java.lang.String mark, int occurrence, int offset)` | +| `void` | `setEndingRow(int row)` | +| `void` | `setEndParent(java.lang.String parent)` | +| `void` | `setPageName(java.lang.String pageName)` | +| `void` | `setParent(java.lang.String parent)` | +| `void` | `setStartingCol(int col)` | +| `void` | `setStartingMark(java.lang.String mark, int occurrence, int offset)` | +| `void` | `setStartingRow(int row)` | +| `static java.util.Vector` | `split(java.lang.String rangeStrings)`
Splits a multi-range string into individual range strings. | +| `java.lang.String` | `toString()` | +| `java.lang.String` | `toString(boolean showPageName)` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Field Detail + +### RANGE_SEPARATOR + +```java +public static final java.lang.String RANGE_SEPARATOR +``` + +**See Also:** +- [Constant Field Values](../../../../../../constant-values.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange.RANGE_SEPARATOR) + +### NAME_SEPARATOR + +```java +public static final java.lang.String NAME_SEPARATOR +``` + +**See Also:** +- [Constant Field Values](../../../../../../constant-values.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange.NAME_SEPARATOR) + +## Constructor Detail + +### PHXRowFieldRange + +```java +public PHXRowFieldRange() +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String str) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String start, + java.lang.String end) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String pageName, + java.lang.String parent, + java.lang.String start, + java.lang.String end) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String pageName, + int row) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String pageName, + int row, + int field) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String pageName, + java.lang.String parent, + int startRow) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String pageName, + java.lang.String parent, + java.lang.String startMark, + int startOccurrence) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String pageName, + java.lang.String startRow, + java.lang.String endRow) +``` + +### PHXRowFieldRange + +```java +public PHXRowFieldRange(java.lang.String pageName, + java.lang.String startRow, + java.lang.String endRow, + java.lang.String startCol, + java.lang.String endCol) +``` + +# Method Detail + +### generate + +```java +public void generate() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Generate the input file + +**Specified by:** +- `generate` in interface `InputFile` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### setFileToGenerate + +```java +public void setFileToGenerate(java.lang.String fileName) +``` +Set the file to be generated + +**Specified by:** +- `setFileToGenerate` in interface `InputFile` + +**Parameters:** +- `fileName` - file name + +### parse + +```java +public void parse() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Parse the output file + +**Specified by:** +- `parse` in interface `OutputFile` +- `parse` in interface `OutputFile2` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` + +### setFileToParse + +```java +public void setFileToParse(java.lang.String fileName) +``` +Set the file to be parsed + +**Specified by:** +- `setFileToParse` in interface `OutputFile` +- `setFileToParse` in interface `OutputFile2` + +**Parameters:** +- `fileName` - file name + +### newParser + +```java +protected Parser newParser(java.io.File rFile, + Parser.Mode pmode) + throws java.io.IOException +``` +Generate a new parser for the given file and mode + +**Specified by:** +- `newParser` in class `AbstractFile` + +**Parameters:** +- `rFile` - The file to open +- `pmode` - caching mode for underlying parser + +**Throws:** +- `java.io.IOException` + +### ensureFileParser + +```java +protected void ensureFileParser(ParseableFile.Mode mode) + throws java.io.IOException +``` +Ensure there is a valid parser + +**Overrides:** +- `ensureFileParser` in class `AbstractFile` + +**Parameters:** +- `mode` - parser mode in current context + +**Throws:** +- `java.io.IOException` + +### defineSection + +```java +public void defineSection(java.lang.String name, + java.lang.String start, + java.lang.String end, + java.lang.String delimiters) + throws com.phoenix_int.aserver.util.PHXNoSuchBookmarkException +``` + +**Throws:** +- `com.phoenix_int.aserver.util.PHXNoSuchBookmarkException` + +### defineBookmark + +```java +public void defineBookmark(java.lang.String name, + java.lang.String parent, + java.lang.String start) +``` + +### defineVar + +```java +public void defineVar(java.lang.String name, + java.lang.String type, + boolean isInput, + java.lang.String rangeStr) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### defineVar + +```java +public void defineVar(java.lang.String name, + java.lang.String type, + boolean isInput, + java.lang.String rangeStr, + java.lang.String units, + java.lang.String description, + java.lang.String lowerBound, + java.lang.String upperBound, + java.lang.String enumValues, + java.lang.String enumAliases, + java.lang.String format) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### defineVar + +```java +public void defineVar(java.lang.String name, + java.lang.String type, + boolean isInput, + java.lang.String rangesStr, + java.lang.String units, + java.lang.String description, + java.lang.String lowerBound, + java.lang.String upperBound, + java.lang.String enumValues, + java.lang.String enumAliases, + java.lang.String format, + java.lang.String fformat) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### transferVars + +```java +protected void transferVars(ParseableFile.Mode mode) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException, + com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException +``` +Note that if wrapper is null, variable collection should be empty, and there should be no harm in calling this method + +Transfer values for variables that have been defined using methods from the concrete implementation, i.e. [defineVar(String, String, boolean, String)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#defineVar-java.lang.String-java.lang.String-boolean-java.lang.String-) + +Variables defined using [PHXScriptWrapperObject.addVariable(String, String, boolean)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html#addVariable-java.lang.String-java.lang.String-boolean-) must be explicitly transferred using methods of the concrete implementation class + +**Specified by:** +- `transferVars` in class `AbstractFile` + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` +- `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md new file mode 100644 index 0000000000..248458177f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md @@ -0,0 +1,66 @@ +# Class: PHXRunShareContext + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.PHXRunShare + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXRunShareContext +``` + +**Implemented Interfaces** + +- `IPHXMonitorable`, `com.phoenix_int.aserver.trace.IPHXTraceGenerator` + +--- +**Declaration** + +```java +public class PHXRunShareContext +extends PHXRunShare +``` + +This class handles runshare capabilities for any component which needs it. It can create temp directories, deal w/ auto-copy and auto-delete of important files, return errors and block until it is safe to run. It also handles providing monitors for stdout and stderr as well as for monitoring started processes. + +This class can only handle one single process running at a time. If you need to run multiple processes, use multiple instances of this class. You can use this same object over and over by calling `lock()` and `unlock()` multiple times. + +## Nested Class Summary + +### Nested classes/interfaces inherited from class com.phoenix_int.aserver.PHXRunShare +`PHXRunShare.RunInfo` + +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.PHXRunShare +`DEL_AUTO, DEL_FALSE, DEL_TRUE, MODE_ERROR, MODE_NONE, MODE_SHARE, MODE_WAIT` + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `PHXRunShareContext(java.lang.String baseDir, java.lang.String wrapperID)` | + +## Method Summary + +### Methods inherited from class com.phoenix_int.aserver.PHXRunShare +`addFileToCopy`, `addRunDirChangedListener`, `addTraceListener`, `cleanTempDir`, `finalize`, `getAutoChangeDir`, `getAutoDelete`, `getBaseDirectory`, `getDictionary`, `getDirectory`, `getIgnoreErrors`, `getMode`, `getMonitor`, `getShell`, `getWrapperID`, `halt`, `listMonitorableFiles`, `listProcesses`, `lock`, `removeRunDirChangedListener`, `removeTraceListener`, `reset`, `run`, `run2`, `setAutoChangeDir`, `setAutoDelete`, `setDictionary`, `setDirectTransfer`, `setFilesToCopy`, `setIgnoreErrors`, `setMode`, `setRunDirectory`, `setRunReplacer`, `setShell`, `timeout`, `unlock` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXRunShareContext + +```java +public PHXRunShareContext(java.lang.String baseDir, + java.lang.String wrapperID) +``` + +**Parameters:** + +- `baseDir` - The directory on disk where the files associated w/ this component are located. +- `wrapperID` - A unique ID which identifies this component. This is used to synchronize runshare access across multiple instances of the same component. Typically the full path on disk to the component's main file is used for this ID. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md new file mode 100644 index 0000000000..169603845a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md @@ -0,0 +1,53 @@ +# Class: PHXScriptWrapperAPIException + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperAPIException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` +--- +**Declaration** + +```java +public class PHXScriptWrapperAPIException +extends java.lang.Exception +``` + +Represents a problem with transferring data in a `PHXRowFieldFile` object. + +**See Also:** + +- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperAPIException) + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `PHXScriptWrapperAPIException(java.lang.String message)`
Creates a new instance of `PHXScriptWrapperAPIException` | + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `setStackTrace`, `toString` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXScriptWrapperAPIException + +```java +public PHXScriptWrapperAPIException(java.lang.String message) +``` +Creates a new instance of `PHXScriptWrapperAPIException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md new file mode 100644 index 0000000000..7dd9cd6b23 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md @@ -0,0 +1,467 @@ +# Class: PHXScriptWrapperObject + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject +``` + +**Declaration** + +```java +public class PHXScriptWrapperObject +extends java.lang.Object +``` + +This object is passed to Script Wrapper scripts and provides the "wrapper" global object which provides runtime services for the wrapper. + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `PHXScriptWrapperObject(com.phoenix_int.aserver.util.scriptwrapper.PHXScriptWrapper wrapper)`
Constructs a wrapper object from a ScriptWrapper instance. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addAutoClose(java.io.Closeable file)`
Add the opened file to the file Handlers list | +| `void` | `addConsoleVariables()` | +| `void` | `addFileInfo(PHXRowFieldFile rff, java.lang.String fileName, ParseableFile.Mode mode)` | +| `void` | `addMethod(java.lang.String methodName)`
Publicizes a method to our clients. | +| `void` | `addMethod(java.lang.String methodName, boolean downloadInputs)`
Publicizes a method to our clients. | +| `void` | `addMethod(java.lang.String methodName, java.lang.String fullName)`
Publicizes a method to our clients. | +| `void` | `addMethod(java.lang.String methodName, java.lang.String fullName, boolean downloadInputs)`
Publicizes a method to our clients. | +| `IPHXType` | `addVariable(java.lang.String name, java.lang.String type, boolean isInput)`
Adds a variable to this component. | +| `void` | `backupFile(java.lang.String varName, java.lang.String fileName)`
Backup the file on disk. | +| `void` | `defaultExecutableMapping(java.lang.String name, java.lang.String location)` | +| `void` | `deleteFile(java.lang.String varName, java.lang.String fileName)`
Deletes the given file variable's file | +| `com.phoenix_int.aserver.ascore.PHXConnection` | `getConnection()`
gets the connection object | +| `java.util.Map` | `getDictionary()`
Gets context information for the incoming connection that is running this wrapper. | +| `java.lang.String` | `getDirectory()`
Returns the directory where this component was loaded from | +| `java.lang.String` | `getRunDirectory()`
Returns the current "run" directory, which is the same as getDirectory() unless run sharing is being used. | +| `PHXRunShareContext` | `getRunShare()`
Returns the `PHXRunShareContext` object used for process control and monitoring with this component | +| `IPHXType` | `getVariable(java.lang.String name)`
Returns a reference to the named variable. | +| `void` | `parseFile(java.lang.String varName, java.lang.String fileName, boolean throwParseError)`
Read the given file variable from the specified file | +| `void` | `removeAutoClose(java.io.Closeable file)`
Remove the file from the file Handlers list | +| `void` | `removeVariable(java.lang.String name)`
Dynamically removes a variable from this component | +| `void` | `requireAnalysisServerVersion(int majorVersion, int minorVersion)`
Verifies we're running a compatible version of ModelCenter Remote Execution | +| `void` | `setBinary(java.lang.String varName)`
Make a given file variable binary | +| `void` | `setConnection(com.phoenix_int.aserver.ascore.PHXConnection c)`
sets the connection object | +| `void` | `sleep(long millisecs)`
sleeps for a period of time | +| `void` | `trace(java.lang.String msg)`
Prints a string to the trace window | +| `void` | `updateConsoleVariables()` | +| `void` | `writeFile(java.lang.String varName, java.lang.String fileName)`
Write the given file variable out to the specified file | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXScriptWrapperObject + +```java +public PHXScriptWrapperObject(com.phoenix_int.aserver.util.scriptwrapper.PHXScriptWrapper wrapper) +``` +Constructs a wrapper object from a ScriptWrapper instance. + +## Method Detail + +### addMethod + +```java +public void addMethod(java.lang.String methodName) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +Publicizes a method to our clients. There must be a method defined in the script by this name. Clients of MCRE will be able to call this method + +**Parameters:** + +- `methodName` - The name of the method to publicize + +**Throws:** + +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` + +### addMethod + +```java +public void addMethod(java.lang.String methodName, + java.lang.String fullName) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +Publicizes a method to our clients. There must be a method defined in the script by this name. Clients of MCRE will be able to call this method + +**Parameters:** + +- `methodName` - The name of the method to publicize. +- `fullName` - A human readable name to show in GUI programs for this method. For example, ModelCenter will show this in the right click menu of a component. + +**Throws:** + +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` + +### addMethod + +```java +public void addMethod(java.lang.String methodName, + boolean downloadInputs) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +Publicizes a method to our clients. There must be a method defined in the script by this name. Clients of MCRE will be able to call this method + +**Parameters:** + +- `methodName` - The name of the method to publicize. +- `downloadInputs` - Hint passed to the client on whether the inputs should be downloaded after the method is run. + +**Throws:** + +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` + +### addMethod + +```java +public void addMethod(java.lang.String methodName, + java.lang.String fullName, + boolean downloadInputs) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException +``` +Publicizes a method to our clients. There must be a method defined in the script by this name. Clients of MCRE will be able to call this method + +**Parameters:** + +- `methodName` - The name of the method to publicize. +- `fullName` - A human readable name to show in GUI programs for this method. For example, ModelCenter will show this in the right click menu of a component. +- `downloadInputs` - Hint passed to the client on whether the inputs should be downloaded after the method is run. + +**Throws:** + +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` + +### addVariable + +```java +public IPHXType addVariable(java.lang.String name, + java.lang.String type, + boolean isInput) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` +Adds a variable to this component. Returns a reference to the new variable. Valid types are: + +| Type | Aliases | Associated PHXType | +| --- | --- | --- | +| double | real | PHXDouble | +| integer | int,long | PHXLong | +| string | str | PHXString | +| boolean | bool | PHXBoolean | +| geometry | geom | PHXGeometry | +| file | | PHXRawFile | + +All types except `PHXGeometry` and `PHXRawFile` may be made into arrays by adding [] at the end of the type string. In that case, the associated `PHXArray` class is used to represent a resizable, multi-dimensional array. + +**Parameters:** + +- `name` - The full name of the new variable. May include group specification with '.'. +- `type` - The type of variable to create. Use the same type strings as for the variable: statemensts at the top of the ScriptWrapper. +- `isInput` - If true, the variable will be an input, if false, it will be an output. + +**Throws:** + +- `PHXNameAlreadyInUseException` - Thrown if there is already a variable by that name. +- `PHXInvalidNameException` - Thrown if the name uses invalid characters like space. +- `PHXInvalidTypeException` - Thrown if the type string is not understood + +### getVariable + +```java +public IPHXType getVariable(java.lang.String name) + throws PHXNoSuchObjectException +``` +Returns a reference to the named variable. + +**Throws:** + +- `PHXNoSuchObjectException` + +### removeVariable + +```java +public void removeVariable(java.lang.String name) + throws PHXNoSuchObjectException +``` +Dynamically removes a variable from this component + +**Throws:** + +- `PHXNoSuchObjectException` + +### addConsoleVariables + +```java +public void addConsoleVariables() + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` + +**Throws:** + +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### updateConsoleVariables + +```java +public void updateConsoleVariables() + throws PHXNoSuchObjectException +``` + +**Throws:** + +- `PHXNoSuchObjectException` + +### getDirectory + +```java +public java.lang.String getDirectory() +``` +Returns the directory where this component was loaded from + +### getRunShare + +```java +public PHXRunShareContext getRunShare() +``` +Returns the PHXRunShareContext object used for process control and monitoring with this component + +### getRunDirectory + +```java +public java.lang.String getRunDirectory() +``` +Returns the current "run" directory, which is the same as `getDirectory()` unless run sharing is being used. + +### sleep + +```java +public void sleep(long millisecs) +``` +sleeps for a period of time + +**Parameters:** + +- `millisecs` - the amount of time to sleep + +### getConnection + +```java +public com.phoenix_int.aserver.ascore.PHXConnection getConnection() +``` +gets the connection object + +### setConnection + +```java +public void setConnection(com.phoenix_int.aserver.ascore.PHXConnection c) +``` +sets the connection object + +### getDictionary + +```java +public java.util.Map getDictionary() +``` +Gets context information for the incoming connection that is running this wrapper. Currently only for internal use. + +**Returns:** + +- a Map of string/value pairs giving context information about the environment inside which the component is running. + +### setBinary + +```java +public void setBinary(java.lang.String varName) + throws PHXInvalidTypeException, + PHXNoSuchObjectException +``` +Make a given file variable binary + +**Parameters:** + +- `varName` - the name of the file variable + +**Throws:** + +- `PHXInvalidTypeException` +- `PHXNoSuchObjectException` + +### writeFile + +```java +public void writeFile(java.lang.String varName, + java.lang.String fileName) + throws PHXInvalidTypeException, + PHXNoSuchObjectException, + java.io.IOException +``` +Write the given file variable out to the specified file + +**Parameters:** + +- `varName` - the name of the file variable +- `fileName` - the name of the target file + +**Throws:** + +- `PHXInvalidTypeException` +- `PHXNoSuchObjectException` +- `java.io.IOException` + +### parseFile + +```java +public void parseFile(java.lang.String varName, + java.lang.String fileName, + boolean throwParseError) + throws PHXInvalidTypeException, + PHXNoSuchObjectException, + java.io.IOException +``` +Read the given file variable from the specified file + +**Parameters:** + +- `varName` - the name of the file variable +- `fileName` - the name of the target file + +**Throws:** + +- `PHXInvalidTypeException` +- `PHXNoSuchObjectException` +- `java.io.IOException` + +### deleteFile + +```java +public void deleteFile(java.lang.String varName, + java.lang.String fileName) + throws PHXInvalidTypeException, + PHXNoSuchObjectException, + java.io.IOException +``` +Deletes the given file variable's file + +**Parameters:** + +- `varName` - the name of the file variable +- `fileName` - the name of the target file + +**Throws:** + +- `PHXInvalidTypeException` +- `PHXNoSuchObjectException` +- `java.io.IOException` + +### backupFile + +```java +public void backupFile(java.lang.String varName, + java.lang.String fileName) + throws PHXInvalidTypeException, + PHXNoSuchObjectException, + java.io.IOException +``` +Backup the file on disk. File is at the same location with ".bac" appended to the end. If a file by that name already exists, it is deleted prior to moving. + +**Parameters:** + +- `varName` - the name of the file variable +- `fileName` - the name of the target file + +**Throws:** + +- `PHXInvalidTypeException` +- `PHXNoSuchObjectException` +- `java.io.IOException` + +### defaultExecutableMapping + +```java +public void defaultExecutableMapping(java.lang.String name, + java.lang.String location) +``` + +### trace + +```java +public void trace(java.lang.String msg) +``` +Prints a string to the trace window + +**Parameters:** + +- `msg` - the message to print + +### requireAnalysisServerVersion + +```java +public void requireAnalysisServerVersion(int majorVersion, + int minorVersion) + throws PHXVersionException +``` +Verifies we're running a compatible version of ModelCenter Remote Execution + +**Parameters:** + +- `majorVersion` - required major version +- `minorVersion` - required minor version + +**Throws:** + +- `PHXVersionException` + +### addAutoClose + +```java +public void addAutoClose(java.io.Closeable file) +``` +Add the opened file to the file Handlers list + +**Parameters:** + +- `file` - the closeable file + +### removeAutoClose + +```java +public void removeAutoClose(java.io.Closeable file) +``` +Remove the file from the file Handlers list + +**Parameters:** + +- `file` - the closeable file + +### addFileInfo + +```java +public void addFileInfo(PHXRowFieldFile rff, + java.lang.String fileName, + ParseableFile.Mode mode) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md new file mode 100644 index 0000000000..02ea7b96f3 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md @@ -0,0 +1,144 @@ +# Class: PHXSection + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection +``` + +**Implemented Interfaces** + +- `java.lang.Cloneable` +--- +**Declaration** + +```java +public class PHXSection +extends java.lang.Object +implements java.lang.Cloneable +``` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `java.lang.Object` | `owner` | + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `PHXSection(java.lang.String name, PHXBookmark start, PHXBookmark end, java.lang.String delimiters)`
Creates a new instance of PHXSection | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `assertEquals(PHXSection other)`
Test comparison function. | +| `PHXSection` | `copy()` | +| `java.lang.String` | `getDelimiters()` | +| `PHXBookmark` | `getEnd()` | +| `java.lang.String` | `getName()` | +| `PHXBookmark` | `getStart()` | +| `void` | `setDelimiters(java.lang.String delimiters)` | +| `void` | `setEnd(PHXBookmark end)` | +| `void` | `setName(java.lang.String name)` | +| `void` | `setStart(PHXBookmark start)` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### owner + +```java +public java.lang.Object owner +``` + +## Constructor Detail + +### PHXSection + +```java +public PHXSection(java.lang.String name, + PHXBookmark start, + PHXBookmark end, + java.lang.String delimiters) +``` +Creates a new instance of `PHXSection` + +## Method Detail + +### copy + +```java +public PHXSection copy() +``` + +### getName + +```java +public java.lang.String getName() +``` + +### setName + +```java +public void setName(java.lang.String name) +``` + +### getStart + +```java +public PHXBookmark getStart() +``` + +### setStart + +```java +public void setStart(PHXBookmark start) +``` + +### getEnd + +```java +public PHXBookmark getEnd() +``` + +### setEnd + +```java +public void setEnd(PHXBookmark end) +``` + +### getDelimiters + +```java +public java.lang.String getDelimiters() +``` + +### setDelimiters + +```java +public void setDelimiters(java.lang.String delimiters) +``` + +### assertEquals + +```java +public void assertEquals(PHXSection other) + throws java.lang.Exception +``` +Test comparison function. If the two objects are not equal, an + exception is thrown + +**Parameters:** +- `other`- the data model to compare this to + +**Throws:** +- `java.lang.Exception`- thrown if the data models do not match \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md new file mode 100644 index 0000000000..42ca75f1bd --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md @@ -0,0 +1,52 @@ +# Class: PHXSectionNotFoundException + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXSectionNotFoundException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** + +```java +public class PHXSectionNotFoundException +extends java.lang.Exception +``` + +**See Also:** + +- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXSectionNotFoundException) + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `PHXSectionNotFoundException(java.lang.String sectionName)` | + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXSectionNotFoundException + +```java +public PHXSectionNotFoundException(java.lang.String sectionName) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md new file mode 100644 index 0000000000..3ffe427e7c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md @@ -0,0 +1,56 @@ +# Class: PHXVersionException + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.PHXVersionException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** + +```java +public class PHXVersionException +extends java.lang.Exception +``` + +**See Also:** + +- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXVersionException) + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `PHXVersionException(int requiredMajorVersion, int requiredMinorVersion, int foundMajorVersion, int foundMinorVersion)`
Creates a new instance of PHXVersionException | + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXVersionException + +```java +public PHXVersionException(int requiredMajorVersion, + int requiredMinorVersion, + int foundMajorVersion, + int foundMinorVersion) +``` +Creates a new instance of `PHXVersionException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md new file mode 100644 index 0000000000..755549366e --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md @@ -0,0 +1,133 @@ +# Enum: ParseableFile.Mode + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Enclosing interface:** +- [ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Enum + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode +``` + +**Implemented Interfaces** + +- `java.io.Serializable`, +- `java.lang.Comparable` + +--- +**Declaration** + +```java +public static enum ParseableFile.Mode + extends java.lang.Enum +``` + +File mode. Moved to type-safe enum from legacy integer constants. + +## Enum Constant Summary + +| Enum Constant and Description | +|-----------------------------| +| `GENERATE` | +| `PARSE` | +| `READ_TEMPLATE` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `static ParseableFile.Mode` | `fromCode(int code)`
Utility function for determining the enum from the legacy integer code | +| `int` | `getCode()`
Retrieve the legacy integer code assigned to this mode | +| `com.phoenix_int.aserver.trace.PHXTraceFileEvent.Type` | `getEventType()` | +| `static ParseableFile.Mode` | `valueOf(java.lang.String name)`
Returns the enum constant of this type with the specified name. | +| `static ParseableFile.Mode[]` | `values()`
Returns an array containing the constants of this enum type, in the order they are declared. | + +### Methods inherited from class java.lang.Enum + +`clone`, `compareTo`, `equals`, `finalize`, `getDeclaringClass`, `hashCode`, `name`, `ordinal`, `toString`, `valueOf` + +### Methods inherited from class java.lang.Object + +`getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Enum Constant Detail + +### GENERATE +``` +public static final ParseableFile.Mode GENERATE +``` + +### PARSE +``` +public static final ParseableFile.Mode PARSE +``` + +### READ_TEMPLATE +``` +public static final ParseableFile.Mode READ_TEMPLATE +``` +## Method Detail + +### values + +```java +public static ParseableFile.Mode[] values() +``` +Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: + +```java +for (ParseableFile.Mode c : ParseableFile.Mode.values()) + System.out.println(c); +``` + +**Returns:** +- an array containing the constants of this enum type, in the order they are declared + +### valueOf + +```java +public static ParseableFile.Mode valueOf(java.lang.String name) +``` +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.) + +**Parameters:** +- `name` - the name of the enum constant to be returned. + +**Returns:** +- the enum constant with the specified name + +**Throws:** +- `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name +- `java.lang.NullPointerException` - if the argument is null + +### getEventType + +```java +public com.phoenix_int.aserver.trace.PHXTraceFileEvent.Type getEventType() +``` + +### getCode + +```java +public int getCode() +``` +Retrieve the legacy integer code assigned to this mode + +**Returns:** +- code + +### fromCode + +```java +public static ParseableFile.Mode fromCode(int code) +``` +Utility function for determining the enum from the legacy integer code + +**Parameters:** +- `code` - + +**Returns:** \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md new file mode 100644 index 0000000000..01b9a7da93 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md @@ -0,0 +1,127 @@ +# Interface: ParseableFile + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**All Known Subinterfaces:** +: [InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), [OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) + +**All Known Implementing Classes:** +: [AbstractFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.html), [CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html), [PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html), [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) + +--- +**Declaration:** +```java +public interface ParseableFile +``` + +Interface for files (not file variables) used in script wrappers + +## Nested Class Summary + +| Modifier and Type | Interface and Description | +|-------------------|-------------------------| +| `static class` | `ParseableFile.Mode`
File mode. Moved to type-safe enum from legacy integer constants | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `backup()`
Backup the file on disk. | +| `void` | `close()`
Close the file and free up resources | +| `void` | `delete()`
Delete the file from disk. | +| `void` | `readTemplate()`
Read the template. | +| `void` | `setFileToGenerateOrParse(java.lang.String fileName)`
Set the file to generate or to parse, depending on the mode | +| `void` | `setTempEmbedded(java.lang.String option)`
This method applies only to ModelCenter and has no function in ModelCenter Remote Execution | +| `void` | `setTemplateFile(java.lang.String templateFileName)`
Set the template file to read. | +| `void` | `setVariable(java.lang.String name, java.lang.String value)`
Sets the value of a variable | + +## Method Detail + +### backup + +```java +void backup() +``` +Backup the file on disk. File is at the same location with ".bac" appended to the end. If a file by that name already exists, it is deleted prior to moving. + +### close + +```java +void close() +``` +Close the file and free up resources + +### delete + +```java +void delete() +``` +Delete the file from disk. + +### readTemplate + +```java +void readTemplate() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException, + PHXBookmarkNotFoundException, + PHXSectionNotFoundException +``` +Read the template. In MCRE 7.1, this method was changed to never throw any exceptions. Reading the templates allows you to fill in default values if you can, but is not mandatory. + +**Throws:** +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` +- `PHXBookmarkNotFoundException` +- `PHXSectionNotFoundException` + +### setFileToGenerateOrParse + +```java +void setFileToGenerateOrParse(java.lang.String fileName) +``` +Set the file to generate or to parse, depending on the mode + +**Parameters:** +- `fileName` - + +### setTempEmbedded + +```java +void setTempEmbedded(java.lang.String option) +``` +This method applies only to ModelCenter and has no function in ModelCenter Remote Execution + +### setTemplateFile + +```java +void setTemplateFile(java.lang.String templateFileName) +``` +Set the template file to read. If the template file is not specified, it defaults to the file that is parsed or generated, for `Mode.PARSE` or `Mode.GENERATE`, respectively. + +**Parameters:** +- `templateFileName` - file name + +### setVariable + +```java +void setVariable(java.lang.String name, + java.lang.String value) + throws PHXNoSuchObjectException +``` +Sets the value of a variable + +**Parameters:** +- `name` - variable name +- `value` - variable value as a string + +**Throws:** +- `PHXNoSuchObjectException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md new file mode 100644 index 0000000000..499ef8da92 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md @@ -0,0 +1,327 @@ +# Class: XPathFile + +**Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile + ↳ com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile +``` + +**Implemented Interfaces** + +- `InputFile`, `OutputFile`, `OutputFile2`, `ParseableFile`, `java.io.Closeable`, `java.lang.AutoCloseable` + +--- +**Declaration** + +```java +public class XPathFile +extends AbstractFile +implements OutputFile, OutputFile2, InputFile +``` + +Represents an XML file (not a file variable) used in a script wrapper, with access to the XML node values via XPath statements + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile + `ParseableFile.Mode` + +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile +`encoding`, `fileName`, `mode`, `parser`, `templateFileName`, `wrapper` + +## Constructor Summary + +| Constructor and Description | +|---------------------| +| `XPathFile(PHXScriptWrapperObject wrapper, ParseableFile.Mode mode)`
Constructs a new XPathFile | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `addVariable(java.lang.String name, java.lang.String type, boolean isInput, java.lang.String xpath)`
Add a variable to the wrapper. | +| `void` | `generate()`
Generate the input file | +| `com.phoenix_int.aserver.util.XPathParser` | `getParser()`
Get the XPath parser | +| `protected com.phoenix_int.aserver.util.XPathParser` | `newParser(java.io.File file)`
Allow a sub-class to form a parser using custom options/features, such as handling DTD and entities | +| `protected Parser` | `newParser(java.io.File rFile, Parser.Mode pmode)`
Generate a new parser for the given file and mode | +| `void` | `parse()`
Parse the output file | +| `void` | `setFileToGenerate(java.lang.String fileName)`
Set the file to be generated | +| `void` | `setFileToParse(java.lang.String fileName)`
Set the file to be parsed | +| `void` | `transferArray(PHXSimpleArray var, java.lang.String exp)`
Transfer an array of values, either from the file to the variable, or vice-versa, depending on ParseableFile.Mode | +| `void` | `transferVar(IPHXType var, java.lang.String exp)`
Transfer a value, either from the file to the variable, or vice-versa, depending on ParseableFile.Mode | +| `protected void` | `transferVars(ParseableFile.Mode mode)`
Transfer values for variables that have been defined using methods from the concrete implementation | + +### Methods inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile + +`actionByMode`, `backup`, `close`, `delete`, `ensureFileParser`, `getEncoding`, `getRealFile`, `readTemplate`, `setEncoding`, `setEncoding`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, `setVariable` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +### Methods inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile + +`backup`, `close`, `delete`, `readTemplate`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, `setVariable` + +## Constructor Detail + +### XPathFile + +```java +public XPathFile(PHXScriptWrapperObject wrapper, + ParseableFile.Mode mode) +``` +Construct a new XPathFile + +**Parameters:** + +- `wrapper` - script wrapper object +- `mode` - parser mode + +## Method Detail + +### addVariable + +```java +public void addVariable(java.lang.String name, + java.lang.String type, + boolean isInput, + java.lang.String xpath) + throws PHXNameAlreadyInUseException, + PHXInvalidNameException, + PHXInvalidTypeException +``` +Add a variable to the wrapper. The transfer of variable values will be handled automatically during any call to `generate()`, `parse()`, or `AbstractFile.readTemplate()`. + +**Parameters:** + +- `name` - variable name +- `type` - variable type +- `isInput` - whether variable is an input +- `xpath` - XPath expression + +**Throws:** + +- `PHXNameAlreadyInUseException` +- `PHXInvalidNameException` +- `PHXInvalidTypeException` + +### newParser + +```java +protected Parser newParser(java.io.File rFile, + Parser.Mode pmode) + throws java.io.IOException +``` +Generate a new parser for the given file and mode + +**Specified by:** + +- `newParser` in class `AbstractFile` + +**Parameters:** + +- `rFile` - The file to open +- `pmode` - caching mode for underlying parser + +**Throws:** + +- `java.io.IOException` + +### newParser + +```java +protected com.phoenix_int.aserver.util.XPathParser newParser(java.io.File file) + throws java.io.IOException, + org.xml.sax.SAXException, + javax.xml.parsers.ParserConfigurationException +``` +Allow a sub-class to form a parser using custom options/features, such as handling DTD and entities + +**Parameters:** + +- `file` - + +**Returns:** + +**Throws:** + +- `java.io.IOException` +- `org.xml.sax.SAXException` +- `javax.xml.parsers.ParserConfigurationException` + +### getParser + +```java +public com.phoenix_int.aserver.util.XPathParser getParser() + throws java.io.IOException +``` +Get the XPath parser + +**Returns:** + +**Throws:** + +- `java.io.IOException` + +### transferVars + +```java +protected void transferVars(ParseableFile.Mode mode) + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Transfer values for variables that have been defined using methods from the concrete implementation, i.e.[PHXRowFieldFile.defineVar(String, String, boolean, String)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#defineVar-java.lang.String-java.lang.String-boolean-java.lang.String-) + +Variables defined using[PHXScriptWrapperObject.addVariable(String, String, boolean)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html#addVariable-java.lang.String-java.lang.String-boolean-)must be explicitly transferred using methods of the concrete implementation class + +**Specified by:** + +- `transferVars` in class `AbstractFile` + +**Throws:** + +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### transferArray + +```java +public void transferArray(PHXSimpleArray var, + java.lang.String exp) + throws PHXNoSuchTokenException, + java.io.IOException, + javax.xml.xpath.XPathExpressionException +``` +Transfer an array of values, either from the file to the variable, or vice-versa, depending on `ParseableFile.Mode` + +**Parameters:** + +- `var` - array variable +- `exp` - XPath expression + +**Throws:** + +- `PHXNoSuchTokenException` +- `java.io.IOException` +- `javax.xml.xpath.XPathExpressionException` + +### transferVar + +```java +public void transferVar(IPHXType var, + java.lang.String exp) + throws javax.xml.xpath.XPathExpressionException, + PHXNoSuchTokenException, + java.io.IOException +``` +Transfer a value, either from the file to the variable, or vice-versa, depending on `ParseableFile.Mode` + +**Parameters:** + +- `var` - variable +- `exp` - XPath expression + +**Throws:** + +- `javax.xml.xpath.XPathExpressionException` +- `PHXNoSuchTokenException` +- `java.io.IOException` + +### parse + +```java +public void parse() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Parse the output file + +**Specified by:** + +- `parse` in interface `OutputFile` +- `parse` in interface `OutputFile2` + +**Throws:** + +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### setFileToParse + +```java +public void setFileToParse(java.lang.String fileName) +``` +Set the file to be parsed + +**Specified by:** + +- `setFileToParse` in interface `OutputFile` +- `setFileToParse` in interface `OutputFile2` + +**Parameters:** + +- `fileName` - file name + +### generate + +```java +public void generate() + throws java.io.IOException, + com.phoenix_int.aserver.util.PHXInvalidFormatException, + PHXNoSuchTokenException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + PHXNumberFormatException +``` +Generate the input file + +**Specified by:** + +- `generate` in interface `InputFile` + +**Throws:** + +- `java.io.IOException` +- `com.phoenix_int.aserver.util.PHXInvalidFormatException` +- `PHXNoSuchTokenException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `PHXNumberFormatException` + +### setFileToGenerate + +```java +public void setFileToGenerate(java.lang.String fileName) +``` +Set the file to be generated + +**Specified by:** + +- `setFileToGenerate` in interface `InputFile` + +**Parameters:** + +- `fileName` - file name \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md new file mode 100644 index 0000000000..da6f8e5112 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md @@ -0,0 +1,47 @@ +# Package com.phoenix_int.aserver.util.scriptwrapper.api + +Provides utilities which are designed to make writing ScriptWrappers +with FileWrapper-like capabilities. + +## Interface Summary +| Interface | Description | +| --- | --- | +| [InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html) | Interface for input files (not file variables) used in script-wrappers | +| [IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) | | +| [IPHXRangeChangeListener](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.html) | | +| [OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) | Deprecatedin favor of [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) | +| [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) | Interface for output files (not file variables) used in script-wrappers | +| [ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) | Interface for files (not file variables) used in script wrappers | + +## Class Summary +| Class | Description | +| --- | --- | +| [AbstractFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.html) | Common implementation for files (not file variables) used in script wrappers. | +| [CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html) | This represents a binary output file from a CAE program such as NASTRAN or LSDyna. | +| [PHXBookmark](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.html) | | +| [PHXCAERange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.html) | | +| [PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html) | Class implements the parsing capabilities of the RowField type files from the fileWrapper facility. | +| [PHXRowFieldRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.html) | | +| [PHXRunShareContext](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.html) | This class handles runshare capabilities for any component which needs it. | +| [PHXScriptWrapperObject](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html) | This object is passed to Script Wrapper scripts and provides the "wrapper" global object which provides runtime services for the wrapper. | +| [PHXSection](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.html) | | +| [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) | Represents an XML file (not a file variable) used in a script wrapper, with access to the XML node values via XPath statements | + +## Enum Summary +| Enum | Description | +| --- | --- | +| [ParseableFile.Mode](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html) | File mode + Moved to type-safe enum from legacy integer constants | + + ## Exception Summary +| Exception | Description | +| --- | --- | +| [PHXBookmarkNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.html) | | +| [PHXScriptWrapperAPIException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.html) | Represents a problem with transferring data in a `PHXRowFieldFile` object. | +| [PHXSectionNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.html) | | +| [PHXVersionException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.html) | | + +## Package com.phoenix_int.aserver.util.scriptwrapper.api Description +Provides utilities which are designed to make writing ScriptWrappers +with FileWrapper-like capabilities. These classes may also be used +from Java Components. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md new file mode 100644 index 0000000000..c1fb0f48fd --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md @@ -0,0 +1,39 @@ +# Hierarchy For Package com.phoenix_int.aserver.util.scriptwrapper.api +**Package Hierarchies:** +- [All Packages](../../../../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - com.phoenix_int.aserver.util.scriptwrapper.api.[AbstractFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.html)(implements java.io.Closeable, com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmark](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXCAERange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html)) + - com.phoenix_int.aserver.[PHXRunShare](../../../../../../com/phoenix_int/aserver/PHXRunShare.html)(implements com.phoenix_int.aserver.[IPHXMonitorable](../../../../../../com/phoenix_int/aserver/IPHXMonitorable.html), com.phoenix_int.aserver.trace.IPHXTraceGenerator) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRunShareContext](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperObject](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSection](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.html)(implements java.lang.Cloneable) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmarkNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperAPIException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSectionNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXVersionException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.html) + +## Interface Hierarchy + +- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRangeChangeListener](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) + +## Enum Hierarchy + +- java.lang.Object + - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) + - com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile.Mode](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md new file mode 100644 index 0000000000..d4f3cbee8c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md @@ -0,0 +1,126 @@ +# Class: Environment + +**Package:** `com.phoenix_int.pacz.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.util.AbstractMap + ↳ java.util.HashMap + ↳ com.phoenix_int.pacz.api.Environment +``` + +**Implemented Interfaces** + +- `java.io.Serializable`, `java.lang.Cloneable`, `java.util.Map` + +--- +**Deprecated:** see `com.phoenix_int.pacz.api.v2.Environment` + +```java +@Deprecated +public class Environment +extends java.util.HashMap +``` + +Environment variables for component configuration + +## Nested Class Summary + +### Nested classes/interfaces inherited from class java.util.AbstractMap +`java.util.AbstractMap.SimpleEntry`, `java.util.AbstractMap.SimpleImmutableEntry` + +### Nested classes/interfaces inherited from interface java.util.Map +`java.util.Map.Entry` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static java.lang.String` | `COMPONENT_DIR`
**Deprecated.** Pre-defined component directory environment variable | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `Environment()`
**Deprecated.** Constructor | +| `Environment(java.util.Map dictionary)`
**Deprecated.** Copy constructor | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `evaluateKey(java.lang.String key)`
**Deprecated.** Get the value for the specified environment variable | +| `java.lang.String` | `evaluateString(java.lang.String str)`
**Deprecated.** Substitute environment variables in specified string with corresponding environment values | + +### Methods inherited from class java.util.HashMap +`clear`, `clone`, `compute`, `computeIfAbsent`, `computeIfPresent`, `containsKey`, `containsValue`, `entrySet`, `forEach`, `get`, `getOrDefault`, `isEmpty`, `keySet`, `merge`, `put`, `putAll`, `putIfAbsent`, `remove`, `remove`, `replace`, `replace`, `replaceAll`, `size`, `values` + +### Methods inherited from class java.util.AbstractMap +`equals`, `hashCode`, `toString` + +### Methods inherited from class java.lang.Object +`finalize`, `getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +### Methods inherited from interface java.util.Map +`equals`, `hashCode` + +## Field Detail + +### COMPONENT_DIR + +```java +public static final java.lang.String COMPONENT_DIR +``` +**Deprecated.** Pre-defined component directory environment variable + +**See Also:** +- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.pacz.api.Environment.COMPONENT_DIR) + +## Constructor Detail + +### Environment + +```java +public Environment() +``` +**Deprecated.** Constructor + +### Environment + +```java +public Environment(java.util.Map dictionary) +``` +**Deprecated.** Copy constructor + +**Parameters:** +- `dictionary` - dictionary to copy; if null, an empty map will be used + +## Method Detail + +### evaluateString + +```java +public java.lang.String evaluateString(java.lang.String str) +``` +**Deprecated.** Substitute environment variables in specified string with corresponding environment values + +**Parameters:** +- `str` - string on which to perform substitutions + +**Returns:** +- string with substituted environment values + +### evaluateKey + +```java +public java.lang.String evaluateKey(java.lang.String key) +``` +**Deprecated.** Get the value for the specified environment variable + +**Parameters:** +- `key` - environment variable for which to get value + +**Returns:** +- value of environment variable; null if not found \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md new file mode 100644 index 0000000000..003bfdee0a --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md @@ -0,0 +1,260 @@ +# Interface: IComponentConfig + +**Package:** `com.phoenix_int.pacz.api` + +--- +**Deprecated:** see `com.phoenix_int.pacz.api.v2.IComponentConfig` + +```java +@Deprecated +public interface IComponentConfig +``` + +Configuration for PACZ file + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.Object` | `getAdditionalConfigValue(java.lang.String valueName)`
**Deprecated.** Get additional configuration value based on specified value name. | +| `java.util.Map` | `getAdditionalConfigValues()`
**Deprecated.** Get additional configuration values as key-value pair map | +| `java.lang.String` | `getASComponent()`
**Deprecated.** Get ModelCenter Remote Execution component name | +| `java.util.List` | `getCommandLineArguments()`
**Deprecated.** Get command line arguments to be passed to component executable | +| `java.lang.String` | `getDescription()`
**Deprecated.** Get component description | +| `Environment` | `getEnvironment()`
**Deprecated.** Get component environment | +| `java.lang.String` | `getExecutable()`
**Deprecated.** Get name of component executable | +| `java.net.URI` | `getHelpUri()`
**Deprecated.** Get URI of help to use for component | +| `java.net.URI` | `getIconUri()`
**Deprecated.** Get URI of icon to use for component | +| `java.util.List` | `getInputs()`
**Deprecated.** Get component inputs | +| `java.util.List` | `getInstanceFiles()`
**Deprecated.** Get component instance files | +| `java.util.List` | `getOutputs()`
**Deprecated.** Get component outputs | +| `java.util.Map` | `getProperties()`
**Deprecated.** Get additional component properties | +| `java.util.List` | `getRequiredFeatures()`
**Deprecated.** Get list of features required for component to execute | +| `RunFolderPreference` | `getRunFolderPreference()`
**Deprecated.** Get run folder preference for component | +| `java.lang.String` | `getVersion()`
**Deprecated.** Get component version | +| `void` | `setAdditionalConfigValue(java.lang.String valueName, java.lang.Object value)`
**Deprecated.** Set additional configuration value key-value pair in map. | +| `void` | `setDescription(java.lang.String description)`
**Deprecated.** Set component description | +| `void` | `setRequiredFeatures(java.util.List requiredFeatures)`
**Deprecated.** Set list features required for component to execute | +| `void` | `setVersion(java.lang.String version)`
**Deprecated.** Set component version | + +## Method Detail + +### getEnvironment + +```java +Environment getEnvironment() +``` +**Deprecated.** Get component environment + +**Returns:** +- component environment + +**See Also:** +- [Environment](../../../../com/phoenix_int/pacz/api/Environment.html) + +### getRunFolderPreference + +```java +RunFolderPreference getRunFolderPreference() +``` +**Deprecated.** Get run folder preference for component + +**Returns:** +- component run folder preference + +**See Also:** +- [RunFolderPreference](../../../../com/phoenix_int/pacz/api/RunFolderPreference.html) + +### getVersion + +```java +java.lang.String getVersion() +``` +**Deprecated.** Get component version + +**Returns:** +- component version + +### setVersion + +```java +void setVersion(java.lang.String version) +``` +**Deprecated.** Set component version + +**Parameters:** +- `version` - component version to use; if null, an empty version will be used + +### getDescription + +```java +java.lang.String getDescription() +``` +**Deprecated.** Get component description + +**Returns:** +- component description + +### setDescription + +```java +void setDescription(java.lang.String description) +``` +**Deprecated.** Set component description + +**Parameters:** +- `description` - component description to use; if null, an empty description will be used + +### getRequiredFeatures + +```java +java.util.List getRequiredFeatures() +``` +**Deprecated.** Get list of features required for component to execute + +**Returns:** +- list of required features + +### setRequiredFeatures + +```java +void setRequiredFeatures(java.util.List requiredFeatures) +``` +**Deprecated.** Set list features required for component to execute + +**Parameters:** +- `requiredFeatures` - list of features required for component to execute; if null, an empty list will be used + +### getExecutable + +```java +java.lang.String getExecutable() +``` +**Deprecated.** Get name of component executable + +**Returns:** +- component executable name + +### getCommandLineArguments + +```java +java.util.List getCommandLineArguments() +``` +**Deprecated.** Get command line arguments to be passed to component executable + +**Returns:** +- list of command line arguments + +### getInputs + +```java +java.util.List getInputs() +``` +**Deprecated.** Get component inputs + +**Returns:** +- list of component inputs + +**See Also:** +- [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) + +### getOutputs + +```java +java.util.List getOutputs() +``` +**Deprecated.** Get component outputs + +**Returns:** +- list of component outputs + +**See Also:** +- [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) + +### getInstanceFiles + +```java +java.util.List getInstanceFiles() +``` +**Deprecated.** Get component instance files + +**Returns:** +- list of component instance files + +**See Also:** +- [IInstanceFile](../../../../com/phoenix_int/pacz/api/IInstanceFile.html) + +### getProperties + +```java +java.util.Map getProperties() +``` +**Deprecated.** Get additional component properties + +**Returns:** +- key-value pair of component properties + +### getASComponent + +```java +java.lang.String getASComponent() +``` +**Deprecated.** Get ModelCenter Remote Execution component name + +**Returns:** +- ModelCenter Remote Execution component name + +### getHelpUri + +```java +java.net.URI getHelpUri() +``` +**Deprecated.** Get URI of help to use for component + +**Returns:** +- component help URI; null if no help + +### getIconUri + +```java +java.net.URI getIconUri() +``` +**Deprecated.** Get URI of icon to use for component + +**Returns:** +- component icon URI; null if no icon + +### setAdditionalConfigValue + +```java +void setAdditionalConfigValue(java.lang.String valueName, + java.lang.Object value) +``` +**Deprecated.** Set additional configuration value key-value pair in map. If key exists, the existing value will be overwritten with the new value. If key does not exist, the new key-value pair will be inserted into the map. + +**Parameters:** +- `valueName` - name of value to set in additional values map +- `value` - value to set for value name + +### getAdditionalConfigValues + +```java +java.util.Map getAdditionalConfigValues() +``` +**Deprecated.** Get additional configuration values as key-value pair map + +**Returns:** +- additional configuration value map + +### getAdditionalConfigValue + +```java +java.lang.Object getAdditionalConfigValue(java.lang.String valueName) +``` +**Deprecated.** Get additional configuration value based on specified value name. + +**Parameters:** +- `valueName` - name of value to get + +**Returns:** +- value for specified value name, or null if name does not exist in map \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md new file mode 100644 index 0000000000..6699af38bb --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md @@ -0,0 +1,42 @@ +# Interface: IInstanceFile + +**Package:** `com.phoenix_int.pacz.api` + +--- +**Deprecated:** see `com.phoenix_int.pacz.api.v2.IInstanceFile` + +```java +@Deprecated +public interface IInstanceFile +``` + +Instance file within a component + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getName()`
**Deprecated.** Get name of instance file | +| `java.lang.String` | `getPath()`
**Deprecated.** Get path of instance file | + +## Method Detail + +### getName + +```java +java.lang.String getName() +``` +**Deprecated.** Get name of instance file + +**Returns:** +- name of instance file + +### getPath + +```java +java.lang.String getPath() +``` +**Deprecated.** Get path of instance file + +**Returns:** +- path of instance file \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md new file mode 100644 index 0000000000..72048bb066 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md @@ -0,0 +1,294 @@ +# Interface: IRuntimeVariable + +**Package:** `com.phoenix_int.pacz.api` + +--- +**Deprecated:** see `com.phoenix_int.pacz.api.v2.IRuntimeVariable` + +```java +@Deprecated +public interface IRuntimeVariable +``` + +Component variable interface + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.Object` | `getDefaultValue()`
**Deprecated.** Get default value of variable | +| `java.lang.String` | `getDescription()`
**Deprecated.** Get variable description | +| `java.lang.String[]` | `getEnumAliases()`
**Deprecated.** Get names/aliases for the enumerated type | +| `java.lang.Object[]` | `getEnumValues()`
**Deprecated.** Get values for the enumerated type | +| `java.lang.String` | `getFormat()`
**Deprecated.** Get variable format string | +| `java.lang.Number` | `getLowerBound()`
**Deprecated.** Get lower bound of variable; may be null | +| `java.util.Map` | `getMetaData()`
**Deprecated.** Get additional variable meta data | +| `java.lang.String` | `getName()`
**Deprecated.** Get variable name | +| `VariableDataType` | `getType()`
**Deprecated.** Get variable data type | +| `java.lang.String` | `getUnits()`
**Deprecated.** Get variable units | +| `java.lang.Number` | `getUpperBound()`
**Deprecated.** Get upper bound of variable; may be null | +| `boolean` | `isArray()`
**Deprecated.** Whether or not variable is an array type | +| `boolean` | `isEnum()`
**Deprecated.** Whether or not variable is an enumerated type | +| `boolean` | `isNumeric()`
**Deprecated.** Whether or not variable is a numeric type | +| `void` | `setDefaultValue(java.lang.Object defaultValue)`
**Deprecated.** Set default value of variable | +| `void` | `setDescription(java.lang.String description)`
**Deprecated.** Set variable description | +| `void` | `setEnums(java.lang.String[] enumAliases, java.lang.Object[] enumValues)`
**Deprecated.** Set the names/aliases and corresponding values for the enumerated type | +| `void` | `setFormat(java.lang.String format)`
**Deprecated.** Set variable format string | +| `void` | `setLowerBound(java.lang.Number lowerBound)`
**Deprecated.** Set lower bound of variable; may be null | +| `void` | `setMetaData(java.lang.String key, java.lang.String value)`
**Deprecated.** Set meta data property; will create a new entry it does not exist | +| `void` | `setName(java.lang.String name)`
**Deprecated.** Set variable name | +| `void` | `setUnits(java.lang.String units)`
**Deprecated.** Set variable units | +| `void` | `setUpperBound(java.lang.Number upperBound)`
**Deprecated.** Set upper bound of variable; may be null | + +## Method Detail + +### getName + +```java +java.lang.String getName() +``` +**Deprecated.** Get variable name + +**Returns:** +- variable name + +### setName + +```java +void setName(java.lang.String name) +``` +**Deprecated.** Set variable name + +**Parameters:** +- `name` - variable name to use + +### getType + +```java +VariableDataType getType() +``` +**Deprecated.** Get variable data type + +**Returns:** +- variable data type + +**See Also:** +- [VariableDataType](../../../../com/phoenix_int/pacz/api/VariableDataType.html) + +### getFormat + +```java +java.lang.String getFormat() +``` +**Deprecated.** Get variable format string + +**Returns:** +- variable format string + +### setFormat + +```java +void setFormat(java.lang.String format) +``` +**Deprecated.** Set variable format string + +**Parameters:** +- `format` - format string to use + +### getUnits + +```java +java.lang.String getUnits() +``` +**Deprecated.** Get variable units + +**Returns:** +- variable units + +### setUnits + +```java +void setUnits(java.lang.String units) +``` +**Deprecated.** Set variable units + +**Parameters:** +- `units` - units to use + +### getDescription + +```java +java.lang.String getDescription() +``` +**Deprecated.** Get variable description + +**Returns:** +- variable description + +### setDescription + +```java +void setDescription(java.lang.String description) +``` +**Deprecated.** Set variable description + +**Parameters:** +- `description` - description to use + +### getDefaultValue + +```java +java.lang.Object getDefaultValue() +``` +**Deprecated.** Get default value of variable + +**Returns:** +- variable default value + +### setDefaultValue + +```java +void setDefaultValue(java.lang.Object defaultValue) +``` +**Deprecated.** Set default value of variable + +**Parameters:** +- `defaultValue` - default value to use + +### getUpperBound + +```java +java.lang.Number getUpperBound() +``` +**Deprecated.** Get upper bound of variable; may be null + +Only applicable to variables of numeric type + +**Returns:** +- variable upper bound or null if no upper bound + +### setUpperBound + +```java +void setUpperBound(java.lang.Number upperBound) +``` +**Deprecated.** Set upper bound of variable; may be null + +Only applicable to variables of numeric type + +**Parameters:** +- `upperBound` - upper bound to use; null for none + +### getLowerBound + +```java +java.lang.Number getLowerBound() +``` +**Deprecated.** Get lower bound of variable; may be null + +Only applicable to variables of numeric type + +**Returns:** +- variable lower bound or null if no lower bound + +### setLowerBound + +```java +void setLowerBound(java.lang.Number lowerBound) +``` +**Deprecated.** Set lower bound of variable; may be null + +Only applicable to variables of numeric type + +**Parameters:** +- `lowerBound` - lower bound to use; null for none + +### getEnumValues + +```java +java.lang.Object[] getEnumValues() +``` +**Deprecated.** Get values for the enumerated type + +**Returns:** +- array of values for the enumerated type or null if variable is not an enumerated type + +### getEnumAliases + +```java +java.lang.String[] getEnumAliases() +``` +**Deprecated.** Get names/aliases for the enumerated type + +**Returns:** +- array of names/aliases for the enumerated type or null if variable is not an enumerated type + +### setEnums + +```java +void setEnums(java.lang.String[] enumAliases, java.lang.Object[] enumValues) +``` +**Deprecated.** Set the names/aliases and corresponding values for the enumerated type + +**Parameters:** +- `enumAliases` - array of names/aliases of enumerated type; must have same length as values +- `enumValues` - array of values of enumerated type; must have same length as aliases + +**Throws:** +- `java.lang.IllegalArgumentException` - if aliases and values are not of same length + +### getMetaData + +```java +java.util.Map getMetaData() +``` +**Deprecated.** Get additional variable meta data + +**Returns:** +- key-value pair of variable meta data + +### setMetaData + +```java +void setMetaData(java.lang.String key, + java.lang.String value) + throws java.lang.IllegalArgumentException +``` +**Deprecated.** Set meta data property; will create a new entry it does not exist + +**Parameters:** +- `key` - meta data property for which to set value +- `value` - value to set + +**Throws:** +- `java.lang.IllegalArgumentException` - if key is null or empty + +### isNumeric + +```java +boolean isNumeric() +``` +**Deprecated.** Whether or not variable is a numeric type + +**Returns:** +- true if numeric type, false otherwise + +### isArray + +```java +boolean isArray() +``` +**Deprecated.** Whether or not variable is an array type + +**Returns:** +- true if array type, false otherwise + +### isEnum + +```java +boolean isEnum() +``` +**Deprecated.** Whether or not variable is an enumerated type + +**Returns:** +- true if enumerated type, false otherwise \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md new file mode 100644 index 0000000000..855f353db3 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md @@ -0,0 +1,129 @@ +# Enum: RunFolderPreference + +**Package:** `com.phoenix_int.pacz.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Enum + ↳ com.phoenix_int.pacz.api.RunFolderPreference +``` + +**Implemented Interfaces** +- `java.io.Serializable`, `java.lang.Comparable` + +--- + +**Deprecated.** + +See `com.phoenix_int.pacz.api.v2.RunFolderPreferece` + +```java +@Deprecated +public enum RunFolderPreference + extends java.lang.Enum +``` + +Preference for how files within the .pacz should be handled when running a component. + +## Enum Constant Summary + +| Enum Constant and Description | +|------------------------------| +| `PER_PROCESS`
**Deprecated.**
New run directory should be created for each process of a component. | +| `PER_RUN`
**Deprecated.** + +New run directory should be created for each run of a component. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `toString()`
**Deprecated.**
Get value of enumeration | +| `static RunFolderPreference` | `valueOf(java.lang.String name)`
**Deprecated.**
Returns the enum constant of this type with the specified name. | +| `static RunFolderPreference[]` | `values()`
**Deprecated.**
Returns an array containing the constants of this enum type, in the order they are declared. | + +### Methods inherited from class `java.lang.Enum` +`clone`, `compareTo`, `equals`, `finalize`, `getDeclaringClass`, `hashCode`, `name`, `ordinal`, `valueOf` + +### Methods inherited from class `java.lang.Object` +`getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Enum Constant Detail + +### PER_RUN + +```java +public static final RunFolderPreference PER_RUN +``` + +**Deprecated.** + +New run directory should be created for each run of a component. If one process is used to execute multiple runs of a component, each run will have a separate directory to keep its files. This preference should be used when needing result capture, or if a component modifies files during its execution (including log files). + +### PER_PROCESS + +```java +public static final RunFolderPreference PER_PROCESS +``` + +**Deprecated.** + +New run directory should be created for each process of a component. If one process is used to execute multiple runs of a component, only one directory will be created for all runs to use. This preference should be used when result capture is not needed, or if a component does not modify files during its execution (including log files). This mode should be chosen if unsure which mode a component should use. + +## Method Detail + +### values + +```java +public static RunFolderPreference[] values() +``` + +**Deprecated.** + +Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: + +```java +for (RunFolderPreference c : RunFolderPreference.values()) + System.out.println(c); +``` + +**Returns:** +- an array containing the constants of this enum type, in the order they are declared + +### valueOf + +```java +public static RunFolderPreference valueOf(java.lang.String name) +``` + +**Deprecated.** + +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.) + +**Parameters:** +- `name` - the name of the enum constant to be returned. + +**Returns:** +- the enum constant with the specified name + +**Throws:** +- `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name +- `java.lang.NullPointerException` - if the argument is null + +### toString + +```java +public java.lang.String toString() +``` + +**Deprecated.** + +Get value of enumeration + +**Overrides:** +- `toString` in class `java.lang.Enum` + +**Returns:** +- enumeration value \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md new file mode 100644 index 0000000000..30078ec61f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md @@ -0,0 +1,226 @@ +# Enum: VariableDataType + +**Package:** `com.phoenix_int.pacz.api` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Enum + ↳ com.phoenix_int.pacz.api.VariableDataType +``` + +**Implemented Interfaces** +- `java.io.Serializable`, `java.lang.Comparable` + +--- + +**Deprecated.** + +IRuntimeVariables are now using the canonical PHX type identifiers which are literal strings (see `com.phoenix_int.pacz.api.v2`) + +```java +@Deprecated +public enum VariableDataType + extends java.lang.Enum +``` + +Supported variable data types + +## Enum Constant Summary + +| Enum Constant and Description | +|------------------------------| +| `BOOLEAN`
**Deprecated.**
Variable is of boolean type | +| `BOOLEAN_ARRAY`
**Deprecated.**
Variable is of boolean array type | +| `DOUBLE`
**Deprecated.**
Variable is of double type | +| `DOUBLE_ARRAY`
**Deprecated.**
Variable is of double array type | +| `FILE`
**Deprecated.**
Variable is of file type | +| `FILE_ARRAY`
**Deprecated.**
Variable is of file array type | +| `INTEGER`
**Deprecated.**
Variable is of integer type | +| `INTEGER_ARRAY`
**Deprecated.**
Variable is of integer array type | +| `STRING`
**Deprecated.**
Variable is of string type | +| `STRING_ARRAY`
**Deprecated.**
Variable is of string array type | +| `UNSPECIFIED`
**Deprecated.**
Variable type is unspecified | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `toString()`
**Deprecated.**
Get value of enumeration | +| `static VariableDataType` | `valueOf(java.lang.String name)`
**Deprecated.**
Returns the enum constant of this type with the specified name. | +| `static VariableDataType[]` | `values()`
**Deprecated.**
Returns an array containing the constants of this enum type, in the order they are declared. | + +### Methods inherited from class `java.lang.Enum` +`clone`, `compareTo`, `equals`, `finalize`, `getDeclaringClass`, `hashCode`, `name`, `ordinal`, `valueOf` + +### Methods inherited from class `java.lang.Object` +`getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Enum Constant Detail + +### UNSPECIFIED + +```java +public static final VariableDataType UNSPECIFIED +``` + +**Deprecated.** + +Variable type is unspecified + +### BOOLEAN + +```java +public static final VariableDataType BOOLEAN +``` + +**Deprecated.** + +Variable is of boolean type + +### STRING + +```java +public static final VariableDataType STRING +``` + +**Deprecated.** + +Variable is of string type + +### DOUBLE + +```java +public static final VariableDataType DOUBLE +``` + +**Deprecated.** + +Variable is of double type + +### INTEGER + +```java +public static final VariableDataType INTEGER +``` + +**Deprecated.** + +Variable is of integer type + +### FILE + +```java +public static final VariableDataType FILE +``` + +**Deprecated.** + +Variable is of file type + +### BOOLEAN_ARRAY + +```java +public static final VariableDataType BOOLEAN_ARRAY +``` + +**Deprecated.** + +Variable is of boolean array type + +### STRING_ARRAY + +```java +public static final VariableDataType STRING_ARRAY +``` + +**Deprecated.** + +Variable is of string array type + +### DOUBLE_ARRAY + +```java +public static final VariableDataType DOUBLE_ARRAY +``` + +**Deprecated.** + +Variable is of double array type + +### INTEGER_ARRAY + +```java +public static final VariableDataType INTEGER_ARRAY +``` + +**Deprecated.** + +Variable is of integer array type + +### FILE_ARRAY + +```java +public static final VariableDataType FILE_ARRAY +``` + +**Deprecated.** + +Variable is of file array type + +## Method Detail + +### values + +```java +public static VariableDataType[] values() +``` + +**Deprecated.** + +Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: + +```java +for (VariableDataType c : VariableDataType.values()) + System.out.println(c); +``` + +**Returns:** +- an array containing the constants of this enum type, in the order they are declared + +### valueOf + +```java +public static VariableDataType valueOf(java.lang.String name) +``` + +**Deprecated.** + +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.) + +**Parameters:** +- `name` - the name of the enum constant to be returned. + +**Returns:** +- the enum constant with the specified name + +**Throws:** +- `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name +- `java.lang.NullPointerException` - if the argument is null + +### toString + +```java +public java.lang.String toString() +``` + +**Deprecated.** + +Get value of enumeration + +**Overrides:** +- `toString` in class `java.lang.Enum` + +**Returns:** +- enumeration value \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md new file mode 100644 index 0000000000..04ee173cff --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md @@ -0,0 +1,204 @@ +# Package com.phoenix_int.pacz.api +PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products Analysis + Server and ModelCenter Server. + + +## Interface Summary +| Interface | Description | +| --- | --- | +| [IComponentConfig](../../../../com/phoenix_int/pacz/api/IComponentConfig.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.IComponentConfig` | +| [IInstanceFile](../../../../com/phoenix_int/pacz/api/IInstanceFile.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.IInstanceFile` | +| [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.IRuntimeVariable` | + +## Class Summary +| Class | Description | +| --- | --- | +| [Environment](../../../../com/phoenix_int/pacz/api/Environment.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.Environment` | + +## Enum Summary +| Enum | Description | +| --- | --- | +| [RunFolderPreference](../../../../com/phoenix_int/pacz/api/RunFolderPreference.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.RunFolderPreferece` | +| [VariableDataType](../../../../com/phoenix_int/pacz/api/VariableDataType.html) | Deprecated
`IRuntimeVariables` are now using the canonical PHX type identifiers which are literal strings (see `com.phoenix_int.pacz.api.v2`) | + +## Package com.phoenix_int.pacz.api Description +PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products ModelCenter Remote Execution and ModelCenter Server. A PACZ is a zip archive with component files and a file containing metadata (extension ".pacj"; see below for details) that specifies its usage. + +Note: PACZ files must be created using an archiving tool that supports UTF-8 encoding for filenames. + +## PACJ Configuration File + +Each PACZ file contains an internal PACJ file, which is a metadata file with an extension of ".pacj". This file is a simple text file that contains information about the component/workflow specified in JSON and must always be named "component.pacj". The PACJ format specifies fields that describe the component, and the information it contains is case sensitive. Much of the information in the file is used by many programs to describe the component. + +Each PACJ file is broken into three sections: component-specific metadata, information about the variables associated with a component, and information about instance files associated with each component. + +### Component-specific metadata section + +Component-specific metadata contains information about the component from a high level. This information includes a description of the component, what version it is, who authored it, and what icon to present to the user. + +See [IComponentConfig](../../../../com/phoenix_int/pacz/api/IComponentConfig.html)for the interface representing the component configuration metadata + +All fields listed below should be used in the component-specific configuration, unless otherwise specified: + +| Field name | Description | Corresponding method | +| --- | --- | --- | +| Field name | Description | Corresponding method | +| `version` | A human-readable string of the version info | [IComponentConfig.getVersion()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getVersion--) | +| `author` | The author of this component | Not currently implemented | +| `description` | A description of this component | [IComponentConfig.getDescription()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getDescription--) | +| `ASComponent` | The MCRE name of the underlying component | [IComponentConfig.getASComponent()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getASComponent--) | +| `icon` | The file relative to the ".pacj" file (usually stored in the ".pacz" file) to be used as an icon (optional) | [IComponentConfig.getIconUri()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getIconUri--) | +| `commandArgs` | Reserved for future use. Do not specify. | [IComponentConfig.getCommandLineArguments()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getCommandLineArguments--) | +| `requires` | Reserved for future use. Must currently be specified as ["analysisserver"] | [IComponentConfig.getRequiredFeatures()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getRequiredFeatures--) | +| `properties` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getProperties()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getProperties--) | +| `inputs` | A list of all input variables.See below for variable definitions. | [IComponentConfig.getInputs()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getInputs--) | +| `outputs` | A list of all output variables.See below for variable definitions. | [IComponentConfig.getOutputs()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getOutputs--) | +| `instanceFiles` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getInstanceFiles()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getInstanceFiles--) | + +### Variables section + +The Variables section is specified by the`inputs`and`outputs`properties and contains information about the variables used in the component. Both inputs and outputs have the same general format and contain specific information about the variable, including the name, type, and other information as specified below. + +Input variables should be specified in an array in the field `inputs`and output variables should be specified in an array in the field `outputs`. + +See [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html)for the interface describing variables. + +All fields listed below should be used for each variable, unless otherwise specified: + +| Field name | Description | Corresponding method | +| --- | --- | --- | +| `name` | The name of the variable. (in dotted notation) | [IRuntimeVariable.getName()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getName--) | +| `type` | The type of the variable. (See [VariableDataType](../../../../com/phoenix_int/pacz/api/VariableDataType.html)) | [IRuntimeVariable.getType()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getType--) | +| `enumAliases` | An array containing names for enumerated lists. If this property is specified, `enumValues`must also be specified. (optional) | [IRuntimeVariable.getEnumAliases()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getEnumAliases--) | +| `enumValues` | An array containing values for enumerated lists. If this property is specified, `enumAliases`must also be specified. (optional) | [IRuntimeVariable.getEnumValues()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getEnumValues--) | +| `upperBound` | The upper bound for this variable. (optional) | [IRuntimeVariable.getUpperBound()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getUpperBound--) | +| `lowerBound` | The lower bound for this variable. (optional) | [IRuntimeVariable.getLowerBound()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getLowerBound--) | +| `units` | The units for this variable. (optional) | [IRuntimeVariable.getUnits()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getUnits--) | +| `description` | The description for this variable. (optional) | [IRuntimeVariable.getDescription()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getDescription--) | +| `defaultValue` | A default value to present to the user | [IRuntimeVariable.getDefaultValue()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getDefaultValue--) | + +Variable type may be specified using one of the following types. Types are case-sensitive and must be written exactly as listed. + +| Variable types | +| --- | +| `Double` | +| `DoubleArray` | +| `Integer` | +| `IntegerArray` | +| `Boolean` | +| `BooleanArray` | +| `String` | +| `StringArray` | +| `File` | +| `FileArray` | + +**Notes:** + +- Default values are not currently supported for variables of type`File`or`FileArray`and should be omitted. +- Array default values should be specified by a string that contains the bounding dimensions of the array enclosed in square + brackets, followed by a comma-separated list of values enclosed in curly braces. For more information, see how to[specify array values.](../../../../../QuickWrap/specifyArrayValues.html) +- Enumerated values should be specified in standard JSON format, using square brackets and a list of comma-separated values, + with special characters such as quotes escaped by a backslash, for example, "Hi! I\'m a PACJ enum value". Note that this format is different from the format used in components and wrappers. +- PACJ files must be encoded in UTF-8. + +### Instance Files section + +The Instance Files section specifies exactly which files inside of the PACZ archive are important to running the component. This feature is currently unimplemented and will be entirely ignored. However, this feature may be implemented at any time and therefore should be used to help document the internal component. + +See [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html)for the interface describing instance files. + +Instance files should be located in a field called`instanceFiles`and should be an array of objects, each containing the following values: + +| Field name | Description | Corresponding method | +| --- | --- | --- | +| `name` | The name of the instance file | [IInstanceFile.getName()](../../../../com/phoenix_int/pacz/api/IInstanceFile.html#getName--) | +| `path` | The path to the instance file. The environment variable `COMPONENT_DIR` (which can be substituted in strings using the syntax `${COMPONENT_DIR}`) should be used to point to the file relative to the root of the PACZ. | [IInstanceFile.getPath()](../../../../com/phoenix_int/pacz/api/IInstanceFile.html#getPath--) | + +## Validation + +When ModelCenter Remote Execution or ModelCenter Server attempts to load a PACZ file, it will attempt to validate the contents of the PACJ configuration file against the referenced component. The following conditions are checked and must be satisfied in order for the PACZ to be loaded: + +- All variables that are specified in the component must be present in the PACJ configuration. +- All variables that are specified in the PACJ configuration must be present in the component. +- The names of the variables must match between the PACJ configuration and the component. +- The variable types must match between the PACJ configuration and the component. +- All variables specified as inputs in the PACJ must be inputs in the configuration, and all output variables in the + PACJ must be outputs in the component. +- The default values of variables specified in the PACJ configuration must match the default (or initial) values of variables in the component. + +## Example PACJ Configuration File +```java + + { + "version": "1.0", + "author": "Phoenix Integration", + "description": "Lunar mission model", + "ASComponent": "LunarMission", + "icon": "lunar.png", + "commandArgs": [], + "requires": ["java", + "analysisserver"], + "properties": { + }, + "inputs": [{ + "name": "Model.Script.Crew_Size", + "type": "Integer", + "defaultValue": 3, + "lowerBound": 1, + "upperBound": 6 + }, + { + "name": "Model.Script.Earth_Entry", + "type": "String", + "enumValues": ["direct", + "aerobraking", + "propulsive"], + "enumAliases": ["direct", + "aerobraking", + "propulsive"], + "defaultValue": "direct" + }, + { + "name": "Model.Script.Science_Payload_Mass", + "type": "Double", + "defaultValue": 300, + "units": "kg" + }, + { + "name": "Model.Script.Single_Stage", + "type": "Boolean", + "defaultValue": false + }, + { + "name": "Model.Script.Thrust_At_Altitude", + "type": "DoubleArray", + "defaultValue": "bounds[3, 2] { 0, 250000, 100, 280700, 350, 312000 }", + "description": "The rocket nozzle thrust (in N) at various altitudes (in km)" + }, + { + "name": "Model.Script.Excel_File", + "type": "File" + }], + "outputs": [{ + "name": "Model.Script.Total_Mission_Cost", + "type": "Double", + "defaultValue": 3.47558, + "units": "$ B" + }, + { + "name": "Model.Script.Total_Sample_Return_Mass", + "type": "Double", + "defaultValue": 38.2609, + "units": "kg" + }], + "instanceFiles": [{ + "name": "icon", + "path": "${COMPONENT_DIR}/moon.png" + }, + { + "name": "ASComponent", + "path": "${COMPONENT_DIR}/LunarMission.pxcz" + }] +} + +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md new file mode 100644 index 0000000000..a07c712209 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md @@ -0,0 +1,23 @@ +# Hierarchy For Package com.phoenix_int.pacz.api +**Package Hierarchies:** +- [All Packages](../../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - java.util.AbstractMap`` (implements java.util.Map``) + - java.util.HashMap`` (implements java.lang.Cloneable, java.util.Map``, java.io.Serializable) + - com.phoenix_int.pacz.api.[Environment](../../../../com/phoenix_int/pacz/api/Environment.html) + +## Interface Hierarchy + +- com.phoenix_int.pacz.api.[IComponentConfig](../../../../com/phoenix_int/pacz/api/IComponentConfig.html) +- com.phoenix_int.pacz.api.[IInstanceFile](../../../../com/phoenix_int/pacz/api/IInstanceFile.html) +- com.phoenix_int.pacz.api.[IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) + +## Enum Hierarchy + +- java.lang.Object + - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) + - com.phoenix_int.pacz.api.[RunFolderPreference](../../../../com/phoenix_int/pacz/api/RunFolderPreference.html) + - com.phoenix_int.pacz.api.[VariableDataType](../../../../com/phoenix_int/pacz/api/VariableDataType.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md new file mode 100644 index 0000000000..7aba794909 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md @@ -0,0 +1,128 @@ +# Class: Environment + +**Package:** `com.phoenix_int.pacz.api.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.util.AbstractMap + ↳ java.util.HashMap + ↳ com.phoenix_int.pacz.api.v2.Environment +``` + +**Implemented Interfaces** +- `java.io.Serializable`, `java.lang.Cloneable`, `java.util.Map` + +--- + +**Declaration** + +```java +public class Environment + extends java.util.HashMap +``` + +Environment variables for component configuration + +**See Also:** +- [Serialized Form](../../../../../serialized-form.html#com.phoenix_int.pacz.api.v2.Environment) + +## Nested Class Summary + +### Nested classes/interfaces inherited from class java.util.AbstractMap +`java.util.AbstractMap.SimpleEntry`, `java.util.AbstractMap.SimpleImmutableEntry` + +### Nested classes/interfaces inherited from interface java.util.Map +`java.util.Map.Entry` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static java.lang.String` | `COMPONENT_DIR`
Pre-defined component directory environment variable | + +## Constructor Summary + +| Constructor and Description | +|----------------------------| +| `Environment()`
Constructor | +| `Environment(java.util.Map dictionary)`
Copy constructor | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `evaluateKey(java.lang.String key)`
Get the value for the specified environment variable | +| `java.lang.String` | `evaluateString(java.lang.String str)`
Substitute environment variables in specified string with corresponding environment values | + +### Methods inherited from class java.util.HashMap +`clear`, `clone`, `compute`, `computeIfAbsent`, `computeIfPresent`, `containsKey`, `containsValue`, `entrySet`, `forEach`, `get`, `getOrDefault`, `isEmpty`, `keySet`, `merge`, `put`, `putAll`, `putIfAbsent`, `remove`, `remove`, `replace`, `replace`, `replaceAll`, `size`, `values` + +### Methods inherited from class java.util.AbstractMap +`equals`, `hashCode`, `toString` + +### Methods inherited from class java.lang.Object +`finalize`, `getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +### Methods inherited from interface java.util.Map +`equals`, `hashCode` + +## Field Detail + +### COMPONENT_DIR + +```java +public static final java.lang.String COMPONENT_DIR +``` +Pre-defined component directory environment variable + +**See Also:** +- [Constant Field Values](../../../../../constant-values.html#com.phoenix_int.pacz.api.v2.Environment.COMPONENT_DIR) + +## Constructor Detail + +### Environment + +```java +public Environment() +``` +Constructor + +### Environment + +```java +public Environment(java.util.Map dictionary) +``` +Copy constructor + +**Parameters:** +- `dictionary` - dictionary to copy; if null, an empty map will be used + +## Method Detail + +### evaluateString + +```java +public java.lang.String evaluateString(java.lang.String str) +``` +Substitute environment variables in specified string with corresponding environment values + +**Parameters:** +- `str` - string on which to perform substitutions + +**Returns:** +- string with substituted environment values + +### evaluateKey + +```java +public java.lang.String evaluateKey(java.lang.String key) +``` +Get the value for the specified environment variable + +**Parameters:** +- `key` - environment variable for which to get value + +**Returns:** +- value of environment variable; null if not found \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md new file mode 100644 index 0000000000..ed2218ae84 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md @@ -0,0 +1,356 @@ +# Interface: IComponentConfig + +**Package:** `com.phoenix_int.pacz.api.v2` + +--- +**Declaration** + +```java +public interface IComponentConfig +``` + +Configuration for PACZ file + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.Object` | `getAdditionalConfigValue(java.lang.String valueName)`
Get additional configuration value based on specified value name. | +| `java.util.Map` | `getAdditionalConfigValues()`
Get additional configuration values as key-value pair map | +| `java.lang.String` | `getASComponent()`
Get ModelCenter Remote Execution component name | +| `java.lang.String` | `getAuthor()`
Get the author of this component. | +| `java.util.List` | `getCommandLineArguments()`
Get command line arguments to be passed to component executable | +| `java.lang.String` | `getComment()`
Get the comment associated with this component. | +| `java.lang.String` | `getDescription()`
Get component description | +| `Environment` | `getEnvironment()`
Get component environment | +| `java.lang.String` | `getExecutable()`
Get name of component executable | +| `java.net.URI` | `getHelpUri()`
Get URI of help to use for component | +| `java.net.URI` | `getIconUri()`
Get URI of icon to use for component | +| `java.util.List` | `getInputs()`
Get component inputs | +| `java.util.List` | `getInstanceFiles()`
Get component instance files | +| `java.util.List` | `getOutputs()`
Get component outputs | +| `java.util.Map` | `getProperties()`
Get additional component properties | +| `java.util.List` | `getRequiredFeatures()`
Get list of features required for component to execute | +| `RunFolderPreference` | `getRunFolderPreference()`
Get run folder preference for component | +| `java.lang.String` | `getVersion()`
Get component version | +| `void` | `setAdditionalConfigValue(java.lang.String valueName, java.lang.Object value)`
Set additional configuration value key-value pair in map. | +| `void` | `setAuthor(java.lang.String author)`
Set the author of this component. | +| `void` | `setComment(java.lang.String comment)`
Set a comment to be associated with this component. | +| `void` | `setDescription(java.lang.String description)`
Set component description | +| `void` | `setIconUri(java.net.URI iconUri)`
Set component icon URI | +| `void` | `setInputs(java.util.List inputs)`
Set component inputs | +| `void` | `setInstanceFiles(java.util.List instanceFiles)`
Set component instance files | +| `void` | `setOutputs(java.util.List outputs)`
Set component outputs | +| `void` | `setRequiredFeatures(java.util.List requiredFeatures)`
Set list features required for component to execute | +| `void` | `setVersion(java.lang.String version)`
Set component version | + +## Method Detail + +### getEnvironment + +```java +Environment getEnvironment() +``` +Get component environment + +**Returns:** +- component environment + +**See Also:** +- [Environment](../../../../../com/phoenix_int/pacz/api/v2/Environment.html) + +### getRunFolderPreference + +```java +RunFolderPreference getRunFolderPreference() +``` +Get run folder preference for component + +**Returns:** +- component run folder preference + +**See Also:** +- [RunFolderPreference](../../../../../com/phoenix_int/pacz/api/v2/RunFolderPreference.html) + +### getVersion + +```java +java.lang.String getVersion() +``` +Get component version + +**Returns:** +- component version + +### setVersion + +```java +void setVersion(java.lang.String version) +``` +Set component version + +**Parameters:** +- `version` - component version to use; if null, an empty version will be used + +### getDescription + +```java +java.lang.String getDescription() +``` +Get component description + +**Returns:** +- component description + +### setDescription + +```java +void setDescription(java.lang.String description) +``` +Set component description + +**Parameters:** +- `description` - component description to use; if null, an empty description will be used + +### getRequiredFeatures + +```java +java.util.List getRequiredFeatures() +``` +Get list of features required for component to execute + +**Returns:** +- list of required features + +### setRequiredFeatures + +```java +void setRequiredFeatures(java.util.List requiredFeatures) +``` +Set list features required for component to execute + +**Parameters:** +- `requiredFeatures` - list of features required for component to execute; if null, an empty list will be used + +### getExecutable + +```java +java.lang.String getExecutable() +``` +Get name of component executable + +**Returns:** +- component executable name + +### getCommandLineArguments + +```java +java.util.List getCommandLineArguments() +``` +Get command line arguments to be passed to component executable + +**Returns:** +- list of command line arguments + +### getInputs + +```java +java.util.List getInputs() +``` +Get component inputs + +**Returns:** +- list of component inputs + +**See Also:** +- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) + +### setInputs + +```java +void setInputs(java.util.List inputs) +``` +Set component inputs + +**Parameters:** +- `inputs` - list of component inputs to use + +**See Also:** +- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) + +### getOutputs + +```java +java.util.List getOutputs() +``` +Get component outputs + +**Returns:** +- list of component outputs + +**See Also:** +- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) + +### setOutputs + +```java +void setOutputs(java.util.List outputs) +``` +Set component outputs + +**Parameters:** +- `outputs` - list of component outputs to use + +**See Also:** +- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) + +### getInstanceFiles + +```java +java.util.List getInstanceFiles() +``` +Get component instance files + +**Returns:** +- list of component instance files + +**See Also:** +- [IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) + +### setInstanceFiles + +```java +void setInstanceFiles(java.util.List instanceFiles) +``` +Set component instance files + +**Parameters:** +- `instanceFiles` - list of component instance files to use + +**See Also:** +- [IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) + +### getProperties + +```java +java.util.Map getProperties() +``` +Get additional component properties + +**Returns:** +- key-value pair of component properties + +### getASComponent + +```java +java.lang.String getASComponent() +``` +Get ModelCenter Remote Execution component name + +**Returns:** +- ModelCenter Remote Execution component name + +### getHelpUri + +```java +java.net.URI getHelpUri() +``` +Get URI of help to use for component + +**Returns:** +- component help URI; null if no help + +### getIconUri + +```java +java.net.URI getIconUri() +``` +Get URI of icon to use for component + +**Returns:** +- component icon URI; null if no icon + +### setIconUri + +```java +void setIconUri(java.net.URI iconUri) +``` +Set component icon URI + +**Parameters:** +- `iconUri` - icon URI to use; if null, component will have no icon + +### setAdditionalConfigValue + +```java +void setAdditionalConfigValue(java.lang.String valueName, + java.lang.Object value) +``` +Set additional configuration value key-value pair in map. If key exists, the existing value will be overwritten with the new value. If key does not exist, the new key-value pair will be inserted into the map. + +**Parameters:** +- `valueName` - name of value to set in additional values map +- `value` - value to set for value name + +### getAdditionalConfigValues + +```java +java.util.Map getAdditionalConfigValues() +``` +Get additional configuration values as key-value pair map + +**Returns:** +- additional configuration value map + +### getAdditionalConfigValue + +```java +java.lang.Object getAdditionalConfigValue(java.lang.String valueName) +``` +Get additional configuration value based on specified value name. + +**Parameters:** +- `valueName` - name of value to get + +**Returns:** +- value for specified value name, or null if name does not exist in map + +### getAuthor + +```java +java.lang.String getAuthor() +``` +Get the author of this component. + +**Returns:** +- The author of this component. + +### setAuthor + +```java +void setAuthor(java.lang.String author) +``` +Set the author of this component. + +**Parameters:** +- `author` - The author to set to this component. + +### getComment + +```java +java.lang.String getComment() +``` +Get the comment associated with this component. + +**Returns:** +- The comment associated with this component. + +### setComment + +```java +void setComment(java.lang.String comment) +``` +Set a comment to be associated with this component. + +**Parameters:** +- `comment` - The comment to associate with this component. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IInstanceFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IInstanceFile.md new file mode 100644 index 0000000000..f86940c34f --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IInstanceFile.md @@ -0,0 +1,42 @@ +# Interface: IInstanceFile + +**Package:** `com.phoenix_int.pacz.api.v2` + +--- + +**Declaration** + +```java +public interface IInstanceFile +``` + +Instance file within a component + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `getName()`
Get name of instance file | +| `java.lang.String` | `getPath()`
Get path of instance file | + +## Method Detail + +### getName + +```java +java.lang.String getName() +``` +Get name of instance file + +**Returns:** +- name of instance file + +### getPath + +```java +java.lang.String getPath() +``` +Get path of instance file + +**Returns:** +- path of instance file \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md new file mode 100644 index 0000000000..8440c3d116 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md @@ -0,0 +1,184 @@ +# Interface: IRuntimeVariable + +**Package:** `com.phoenix_int.pacz.api.v2` + +**All Superinterfaces** + +- [IPHXType](../../../../../com/phoenix_int/aserver/types/IPHXType.html) +- [IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html) +- [IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +- com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata + +--- +**Declaration:** +```java +public interface IRuntimeVariable +extends IPHXType2, IPHXUnits, com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata +``` + +Component variable interface + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `IRuntimeVariable` | `createCopy()`
Get a clone of this variable, including its metadata and value. | +| `java.lang.String` | `getDescription()`
Get variable description | +| `java.util.Map` | `getMetaData()`
Get additional variable meta data | +| `java.lang.String` | `getType()`
Get variable data type | +| `java.lang.String` | `getVariableName()`
Get variable name | +| `boolean` | `isArray()`
Whether or not variable is an array type | +| `boolean` | `isEnum()`
Whether or not variable is an enumerated type | +| `boolean` | `isNumeric()`
Whether or not variable is a numeric type | +| `void` | `setDescription(java.lang.String description)`
Set variable description | +| `void` | `setMetaData(java.lang.String key, java.lang.String value)`
Set meta data property; will create a new entry if it does not exist | +| `void` | `setVariableName(java.lang.String name)`
Set variable name | +| `PHXSimpleType` | `toPHXSimpleType()`
Get the PHXSimpleType version of variable | + +#### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`Accept`, `fromString2`, `toString2` + +#### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType +`fromString`, `toString` + +#### Methods inherited from interface com.phoenix_int.aserver.types.IPHXUnits +`getUnits`, `setUnits` + +#### Methods inherited from interface com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata +`getOptionalEnumAliases`, `getOptionalEnumValues`, `getOptionalFormat`, `getOptionalLowerBound`, `getOptionalUpperBound` + +## Method Detail + +### getVariableName + +```java +java.lang.String getVariableName() +``` +Get variable name + +**Returns:** +- variable name + +### setVariableName + +```java +void setVariableName(java.lang.String name) +``` +Set variable name + +**Parameters:** +- `name` - variable name to use + +### getDescription + +```java +java.lang.String getDescription() +``` +Get variable description + +**Returns:** +- description of variable + +### setDescription + +```java +void setDescription(java.lang.String description) +``` +Set variable description + +**Parameters:** +- `description` - description of variable to use + +### getType + +```java +java.lang.String getType() +``` +Get variable data type + +**Returns:** +- variable data type + +**See Also:** +- [PHXTypeFactory.getVarType(java.lang.String)](../../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#getVarType-java.lang.String-) + +### getMetaData + +```java +java.util.Map getMetaData() +``` +Get additional variable meta data + +**Returns:** +- key-value pair of variable meta data + +### setMetaData + +```java +void setMetaData(java.lang.String key, + java.lang.String value) + throws java.lang.IllegalArgumentException +``` +Set meta data property; will create a new entry if it does not exist + +**Parameters:** +- `key` - meta data property for which to set value +- `value` - value to set + +**Throws:** +- `java.lang.IllegalArgumentException` - if key is null or empty + +### isNumeric + +```java +boolean isNumeric() +``` +Whether or not variable is a numeric type + +**Returns:** +- true if numeric type, false otherwise + +### isArray + +```java +boolean isArray() +``` +Whether or not variable is an array type + +**Returns:** +- true if array type, false otherwise + +### isEnum + +```java +boolean isEnum() +``` +Whether or not variable is an enumerated type + +**Returns:** +- true if enumerated type, false otherwise + +### toPHXSimpleType + +```java +PHXSimpleType toPHXSimpleType() +``` +Get the PHXSimpleType version of variable + +**Returns:** +- PHXSimpleType version of variable + +### createCopy + +```java +IRuntimeVariable createCopy() +``` +Get a clone of this variable, including its metadata and value. + +**Returns:** +- a newly constructed clone of the instance. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/RunFolderPreference.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/RunFolderPreference.md new file mode 100644 index 0000000000..11d28016f7 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/RunFolderPreference.md @@ -0,0 +1,110 @@ +# Enum: RunFolderPreference + +**Package:** `com.phoenix_int.pacz.api.v2` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Enum + ↳ com.phoenix_int.pacz.api.v2.RunFolderPreference +``` + +**Implemented Interfaces** + +- java.io.Serializable +- java.lang.Comparable + +--- +**Declaration** + +```java +public enum RunFolderPreference +extends java.lang.Enum +``` + +Preference for how files within the .pacz should be handled when running a component. + +## Enum Constant Summary + +| Enum Constant and Description | +|-----------------------------| +| `PER_PROCESS`
New run directory should be created for each process of a component. | +| `PER_RUN`
New run directory should be created for each run of a component. | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `toString()`
Get value of enumeration | +| `static RunFolderPreference` | `valueOf(java.lang.String name)`
Returns the enum constant of this type with the specified name. | +| `static RunFolderPreference[]` | `values()`
Returns an array containing the constants of this enum type, in the order they are declared. | + +#### Methods inherited from class java.lang.Enum +`clone`, `compareTo`, `equals`, `finalize`, `getDeclaringClass`, `hashCode`, `name`, `ordinal`, `valueOf` + +#### Methods inherited from class java.lang.Object +`getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Enum Constant Detail + +### PER_RUN + +```java +public static final RunFolderPreference PER_RUN +``` +New run directory should be created for each run of a component. If one process is used to execute multiple runs of a component, each run will have a separate directory to keep its files. This preference should be used when needing result capture, or if a component modifies files during its execution (including log files). + +### PER_PROCESS + +```java +public static final RunFolderPreference PER_PROCESS +``` +New run directory should be created for each process of a component. If one process is used to execute multiple runs of a component, only one directory will be created for all runs to use. This preference should be used when result capture is not needed, or if a component does not modify files during its execution (including log files). This mode should be chosen if unsure which mode a component should use. + +## Method Detail + +### values + +```java +public static RunFolderPreference[] values() +``` +Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: + +```java +for (RunFolderPreference c : RunFolderPreference.values()) + System.out.println(c); +``` + +**Returns:** +- an array containing the constants of this enum type, in the order they are declared + +### valueOf + +```java +public static RunFolderPreference valueOf(java.lang.String name) +``` +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.) + +**Parameters:** +- `name` - the name of the enum constant to be returned. + +**Returns:** +- the enum constant with the specified name + +**Throws:** +- `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name +- `java.lang.NullPointerException` - if the argument is null + +### toString + +```java +public java.lang.String toString() +``` +Get value of enumeration + +**Overrides:** +- `toString` in class `java.lang.Enum` + +**Returns:** +- enumeration value \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md new file mode 100644 index 0000000000..208eae8fff --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md @@ -0,0 +1,207 @@ +# Package com.phoenix_int.pacz.api.v2 +PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products ModelCeter Remote Execution and ModelCenter Server. + +## Interface Summary +| Interface | Description | +| --- | --- | +| [IComponentConfig](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html) | Configuration for PACZ file | +| [IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) | Instance file within a component | +| [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) | Component variable interface | + + +## Class Summary +| Class | Description | +| --- | --- | +| [Environment](../../../../../com/phoenix_int/pacz/api/v2/Environment.html) | Environment variables for component configuration | + +## Enum Summary +| Enum | Description | +| --- | --- | +| [RunFolderPreference](../../../../../com/phoenix_int/pacz/api/v2/RunFolderPreference.html) | Preference for how files within the .pacz should be handled when running a component. | + +## Package com.phoenix_int.pacz.api.v2 Description +PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products ModelCeter Remote Execution and ModelCenter Server. A PACZ is a zip archive with component files and a file containing metadata (extension ".pacj"; see below for details) that specifies its usage. + +Note: PACZ files must be created using an archiving tool that supports UTF-8 encoding for filenames. + +## PACJ Configuration File + +Each PACZ file contains an internal PACJ file, which is a metadata file with an extension of ".pacj". This file is a simple text file that contains information about the component/workflow specified in JSON and must always be named "component.pacj". The PACJ format specifies fields that describe the component, and the information it contains is case sensitive. Much of the information in the file is used by many programs to describe the component. + +Each PACJ file is broken into three sections: component-specific metadata, information about the variables associated with a component, and information about instance files associated with each component. + +### Component-specific metadata section + +Component-specific metadata contains information about the component from a high level. This information includes a description of the component, what version it is, who authored it, and what icon to present to the user. + +See [IComponentConfig](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html) for the interface representing the component configuration metadata + +All fields listed below should be used in the component-specific configuration, unless otherwise specified: + +| Field name | Description | Corresponding method | +| --- | --- | --- | +| `version` | A human-readable string of the version info | [IComponentConfig.getVersion()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getVersion--) | +| `author` | The author of this component | [IComponentConfig.getAuthor()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getAuthor--) | +| `description` | A description of this component | [IComponentConfig.getDescription()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getDescription--) | +| `ASComponent` | The MCRE name of the underlying component | [IComponentConfig.getASComponent()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getASComponent--) | +| `icon` | The file relative to the ".pacj" file (usually stored in the ".pacz" file) to be used as an icon (optional) | [IComponentConfig.getIconUri()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getIconUri--) | +| `commandArgs` | Reserved for future use. Do not specify. | [IComponentConfig.getCommandLineArguments()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getCommandLineArguments--) | +| `requires` | Reserved for future use. Must currently be specified as ["analysisserver"] | [IComponentConfig.getRequiredFeatures()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getRequiredFeatures--) | +| `properties` | An arbitrary dictionary of values that allows a plug-in writer to store data about the instance without needing to create additional files in the pacz. See the **Properties** section for more details. | [IComponentConfig.getProperties()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getProperties--) | +| `inputs` | A list of all input variables.See below for variable definitions. | [IComponentConfig.getInputs()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getInputs--) | +| `outputs` | A list of all output variables.See below for variable definitions. | [IComponentConfig.getOutputs()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getOutputs--) | +| `instanceFiles` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getInstanceFiles()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getInstanceFiles--) | + +### Variables section + +The Variables section is specified by the `inputs` and `outputs` properties and contains information about the variables used in the component. Both inputs and outputs have the same general format and contain specific information about the variable, including the name, type, and other information as specified below. + +Input variables should be specified in an array in the field `inputs` and output variables should be specified in an array in the field `outputs`. + +See [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) for the interface describing variables. + +All fields listed below should be used for each variable, unless otherwise specified: + +| Field name | Description | Corresponding method | +| --- | --- | --- | +| `name` | The name of the variable. (in dotted notation) | [IRuntimeVariable.getVariableName()](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html#getVariableName--) | +| `type` | The type of the variable. (See`String`) | [IRuntimeVariable.getType()](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html#getType--) | +| `enumAliases` | An array containing names for enumerated lists. If this property is specified,`enumValues`must also be specified. (optional) | `IRuntimeVariableMetadata.getOptionalEnumAliases()` | +| `enumValues` | An array containing values for enumerated lists. If this property is specified,`enumAliases`must also be specified. (optional) | `IRuntimeVariableMetadata.getOptionalEnumValues()` | +| `upperBound` | The upper bound for this variable. (optional) | `IRuntimeVariableMetadata.getOptionalUpperBound()` | +| `lowerBound` | The lower bound for this variable. (optional) | `IRuntimeVariableMetadata.getOptionalLowerBound()` | +| `units` | The units for this variable. (optional) | [IPHXUnits.getUnits()](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html#getUnits--) | +| `description` | The description for this variable. (optional) | [IRuntimeVariable.getDescription()](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html#getDescription--) | +| `defaultValue` | A default value to present to the user. | [IPHXType2.Accept(IVisitor)](../../../../../com/phoenix_int/aserver/types/IPHXType2.html#Accept-com.phoenix_int.aserver.types.IPHXType2.IVisitor-) | + +Variable type may be specified using one of the following types. Types are case-sensitive and must be written exactly as listed. + +| Variable types | +| --- | +| `Double` | +| `DoubleArray` | +| `Integer` | +| `IntegerArray` | +| `Boolean` | +| `BooleanArray` | +| `String` | +| `StringArray` | +| `File` | +| `FileArray` | + +**Notes:** + +- Default values are not currently supported for variables of type`File`or`FileArray`and should be omitted. +- Array default values should be specified by a string that contains the bounding dimensions of the array enclosed in square brackets, followed by a comma-separated list of values enclosed in curly braces. For more information, see how to [specify array values.](../../../../../QuickWrap/specifyArrayValues.html) +- Enumerated values should be specified in standard JSON format, using square brackets and a list of comma-separated values, with special characters such as quotes escaped by a backslash, for example, "Hi! I\'m a PACJ enum value". Note that this format is different from the format used in components and wrappers. +- PACJ files must be encoded in UTF-8. + +### Instance Files section + +The Instance Files section specifies exactly which files inside of the PACZ archive are important to running the component. This feature is currently unimplemented and will be entirely ignored. However, this feature may be implemented at any time and therefore should be used to help document the internal component. + +See [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) for the interface describing instance files. + +Instance files should be located in a field called `instanceFiles` and should be an array of objects, each containing the following values: + +| Field name | Description | Corresponding method | +| --- | --- | --- | +| `name` | The name of the instance file | [IInstanceFile.getName()](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html#getName--) | +| `path` | The path to the instance file. The environment variable `COMPONENT_DIR` (which can be substituted in strings using the syntax `${COMPONENT_DIR}`) should be used to point to the file relative to the root of the PACZ. | [IInstanceFile.getPath()](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html#getPath--) | + +### Properties section + +The Properties section specifies extra optional settings that affect how the PACZ is run. It may contain any arbitrary values that the PACZ writer wishes to add. Some keys have special meaning: + +| Property name | Description | +| --- | --- | +| avgRuntime | The amount of time an average run of the PACZ takes to complete, in ISO-8601 duration format (PnDTnHnMn.nS). Examples:
- "PT20.345S" – parses as "20.345 seconds"
- "PT15M" – parses as "15 minutes" (where a minute is 60 seconds)
If the value is missing, empty, whitespace, <=0, or not a valid ISO-8601 duration, it is ignored. | +| phx:timeout | How long to let the component run before canceling the run, in ISO-8601 duration format (PnDTnHnMn.nS). Examples:
- "PT20.345S" – parses as "20.345 seconds"
- "PT15M" – parses as "15 minutes" (where a minute is 60 seconds)
The value is optional. If the value is present and non-empty, but <=0 or not a valid ISO-8601 duration, it is an error. | + +## Validation + +When ModelCenter Remote Execution or ModelCenter Server attempts to load a PACZ file, it will attempt to validate the contents of the PACJ configuration file against the referenced component. The following conditions are checked and must be satisfied in order for the PACZ to be loaded: + +- All variables that are specified in the component must be present in the PACJ configuration. +- All variables that are specified in the PACJ configuration must be present in the component. +- The names of the variables must match between the PACJ configuration and the component. +- The variable types must match between the PACJ configuration and the component. +- All variables specified as inputs in the PACJ must be inputs in the configuration, and all output variables in the PACJ must be outputs in the component. +- The default values of variables specified in the PACJ configuration must match the default (or initial) values of variables in the component. + +## Example PACJ Configuration File +```java + + { + "version": "1.0", + "author": "Phoenix Integration", + "description": "Lunar mission model", + "ASComponent": "LunarMission", + "icon": "lunar.png", + "commandArgs": [], + "requires": ["java", + "analysisserver"], + "properties": { + }, + "inputs": [{ + "name": "Model.Script.Crew_Size", + "type": "Integer", + "defaultValue": 3, + "lowerBound": 1, + "upperBound": 6 + }, + { + "name": "Model.Script.Earth_Entry", + "type": "String", + "enumValues": ["direct", + "aerobraking", + "propulsive"], + "enumAliases": ["direct", + "aerobraking", + "propulsive"], + "defaultValue": "direct" + }, + { + "name": "Model.Script.Science_Payload_Mass", + "type": "Double", + "defaultValue": 300, + "units": "kg" + }, + { + "name": "Model.Script.Single_Stage", + "type": "Boolean", + "defaultValue": false + }, + { + "name": "Model.Script.Thrust_At_Altitude", + "type": "DoubleArray", + "defaultValue": "bounds[3, 2] { 0, 250000, 100, 280700, 350, 312000 }", + "description": "The rocket nozzle thrust (in N) at various altitudes (in km)" + }, + { + "name": "Model.Script.Excel_File", + "type": "File" + }], + "outputs": [{ + "name": "Model.Script.Total_Mission_Cost", + "type": "Double", + "defaultValue": 3.47558, + "units": "$ B" + }, + { + "name": "Model.Script.Total_Sample_Return_Mass", + "type": "Double", + "defaultValue": 38.2609, + "units": "kg" + }], + "instanceFiles": [{ + "name": "icon", + "path": "${COMPONENT_DIR}/moon.png" + }, + { + "name": "ASComponent", + "path": "${COMPONENT_DIR}/LunarMission.pxcz" + }] +} + +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md new file mode 100644 index 0000000000..703cbbd081 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md @@ -0,0 +1,29 @@ +# Hierarchy For Package com.phoenix_int.pacz.api.v2 + +**Package Hierarchies:** +- [All Packages](../../../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - java.util.AbstractMap`` (implements java.util.Map``) + - java.util.HashMap`` (implements java.lang.Cloneable, java.util.Map``, java.io.Serializable) + - com.phoenix_int.pacz.api.v2.[Environment](../../../../../com/phoenix_int/pacz/api/v2/Environment.html) + +## Interface Hierarchy + +- com.phoenix_int.pacz.api.v2.[IComponentConfig](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html) +- com.phoenix_int.pacz.api.v2.[IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) +- com.phoenix_int.aserver.types.[IPHXType](../../../../../com/phoenix_int/aserver/types/IPHXType.html) + - com.phoenix_int.aserver.types.[IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html)(also extends com.phoenix_int.aserver.types.[IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) +- com.phoenix_int.aserver.types.[IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html)(also extends com.phoenix_int.aserver.types.[IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) +- com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html)(also extends com.phoenix_int.aserver.types.[IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.aserver.types.[IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html)) + +## Enum Hierarchy + +- java.lang.Object + - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) + - com.phoenix_int.pacz.api.v2.[RunFolderPreference](../../../../../com/phoenix_int/pacz/api/v2/RunFolderPreference.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/BufferedRandomAccessFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/BufferedRandomAccessFile.md new file mode 100644 index 0000000000..996076c5a5 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/BufferedRandomAccessFile.md @@ -0,0 +1,231 @@ +# Class: BufferedRandomAccessFile + +**Package:** `com.phoenix_int.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.util.BufferedRandomAccessFile +``` + +--- +**Declaration** + +```java +public class BufferedRandomAccessFile +extends java.lang.Object +``` + +Replacement for RandomAccessFile to use buffered I/O as much as possible. Mostly identical to `java.io.RandomAccessFile` API, or at least as close enough for what I needed. + +**Note:** This class is not threadsafe. + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `protected long` | `_actualPos` | +| `protected byte[]` | `_buffer` | +| `protected long` | `_bufStart` | +| `protected long` | `_fileLen` | +| `protected long` | `_filePos` | +| `protected int` | `_readOffset` | +| `protected java.io.RandomAccessFile` | `_wrapped` | +| `protected int` | `_writeOffset` | + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `BufferedRandomAccessFile(java.io.File file, java.lang.String mode, int bufSize)`
Constructs a BufferedRandomAccessFile | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `boolean` | `_readBuf()` | +| `void` | `close()` | +| `void` | `flush()` | +| `long` | `length()` | +| `int` | `read()` | +| `int` | `read(byte[] buf)` | +| `int` | `read(byte[] buf, int offset, int len)` | +| `void` | `seek(long position)` | +| `void` | `write(byte[] buf)` | +| `void` | `write(byte[] buf, int offset, int len)` | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### _wrapped + +```java +protected java.io.RandomAccessFile _wrapped +``` + +### _filePos + +```java +protected long _filePos +``` + +### _fileLen + +```java +protected long _fileLen +``` + +### _actualPos + +```java +protected long _actualPos +``` + +### _bufStart + +```java +protected long _bufStart +``` + +### _buffer + +```java +protected byte[] _buffer +``` + +### _writeOffset + +```java +protected int _writeOffset +``` + +### _readOffset + +```java +protected int _readOffset +``` + +## Constructor Detail + +### BufferedRandomAccessFile + +```java +public BufferedRandomAccessFile(java.io.File file, + java.lang.String mode, + int bufSize) + throws java.io.IOException +``` + +**Parameters:** +- `file` - The file to open +- `mode` - Same as for RandomAccessFile's constructor +- `bufSize` - How big to make the in-memory cache. + +**Throws:** +- `java.io.IOException` + +## Method Detail + +### length + +```java +public long length() + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### seek + +```java +public void seek(long position) +``` + +### close + +```java +public void close() + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### write + +```java +public void write(byte[] buf) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### write + +```java +public void write(byte[] buf, + int offset, + int len) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### flush + +```java +public void flush() + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### read + +```java +public int read() + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### read + +```java +public int read(byte[] buf) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### read + +```java +public int read(byte[] buf, + int offset, + int len) + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` + +### _readBuf + +```java +public boolean _readBuf() + throws java.io.IOException +``` + +**Throws:** +- `java.io.IOException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md new file mode 100644 index 0000000000..953ac61c7c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md @@ -0,0 +1,156 @@ +# Class: PHXBlocker + +**Package:** `com.phoenix_int.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.util.PHXBlocker +``` + +--- + +**Declaration** + +```java +public class PHXBlocker +extends java.lang.Object +``` + +Class to simplify wait and notify calls. Can be used to block one thread until some other thread signals a continue. + +**Sample usage:** + +```java +import com.phoenix_int.util.PHXBlocker; +// +public class PHXThingie +{ + PHXBlocker _blocker; + public PHXThingie() + { + _blocker = new PHXBlocker(); //create the blocker. + //You must call setBlock(true) before block. You should + //do it in a place before it is ever possible(however remote) + //that some other thread calls unblock first. In this case, + //before the subthread is started. + _blocker.setBlock(true); +// + MyThread t = new MyThread(); + t.start(); //make a new thread that will unblock. +// + System.out.println("hi"); + _blocker.block(); //this is the crux! + System.out.println("there"); + } +// + //Thread that just sits around for 10 secs and then unblocks. + private class MyThread extends Thread + { + public void run() + { + try + { + sleep(10000); + } catch(InterruptedException ie) + {} + _blocker.unblock(); + } + } +} +``` + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `static java.lang.String` | `rcsid` | + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXBlocker()` | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `block()`
Blocks until unblock() is invoked. | +| `boolean` | `block(long timeout)`
Blocks until unblock is invoked or timeout has been reached | +| `boolean` | `getBlock()` | +| `void` | `setBlock(boolean block)`
Call setBlock() before block() and before there is any remote chance that any other thread will call unblock(). | +| `void` | `unblock()` | +| `void` | `unblockAll()`
Same as unblock except designed for multiple waiters. | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Field Detail + +### rcsid + +```java +public static final java.lang.String rcsid +``` + +**See Also:** +- [Constant Field Values](../../../constant-values.html#com.phoenix_int.util.PHXBlocker.rcsid) + +## Constructor Detail + +### PHXBlocker + +```java +public PHXBlocker() +``` + +## Method Detail + +### setBlock + +```java +public void setBlock(boolean block) +``` +Call `setBlock()` before `block()` and before there is any remote chance that any other thread will call `unblock()`. + +### getBlock + +```java +public boolean getBlock() +``` + +### block + +```java +public boolean block(long timeout) +``` +Blocks until unblock is invoked or timeout has been reached + +**Parameters:** +- `timeout` - Maximum time to wait in milliseconds. Set to 0 to wait forever. + +**Returns:** +- `true` if correctly unblocked. `false` if interrupted or timeout. + +### block + +```java +public void block() +``` +Blocks until `unblock()` is invoked. + +### unblock + +```java +public void unblock() +``` + +### unblockAll + +```java +public void unblockAll() +``` +Same as unblock except designed for multiple waiters. If there is any chance of multiple people having called `block()`, then use `unblockAll()`. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md new file mode 100644 index 0000000000..af453f8f7c --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md @@ -0,0 +1,38 @@ +# Interface: PHXInternationalize.InternationalizedMessage + +**Enclosing class:** +[PHXInternationalize](../../../com/phoenix_int/util/PHXInternationalize.html) + +**Functional Interface:** +This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference. + +**Package:** +- `com.phoenix_int.util` + +--- +**Declaration** + +```java +@FunctionalInterface +public static interface PHXInternationalize.InternationalizedMessage +``` + +Interface for a lazily computed translation message. Can be used for example to pass to a logger that will only do the translation if the log level is enabled. + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `java.lang.String` | `computeMessage()`
Compute the translation and return the message | + +## Method Detail + +### computeMessage + +```java +java.lang.String computeMessage() +``` +Compute the translation and return the message + +**Returns:** +- The translated message \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md new file mode 100644 index 0000000000..c45f748af2 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md @@ -0,0 +1,110 @@ +# Class: PHXInternationalize + +**Package:** `com.phoenix_int.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.util.PHXInternationalize +``` + +--- +**Declaration** + +```java +public class PHXInternationalize +extends java.lang.Object +``` + +Helper class to do internationalization. + +## Nested Class Summary + +|Modifier and Type |Class and Description| +|-----|-----| +| `static interface`| `PHXInternationalize.InternationalizedMessage`
Interface for a lazily computed translation message.| + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXInternationalize(java.lang.Class relC)` | +| `PHXInternationalize(java.lang.Object rel)`
Creates a new instance of PHXInternationalize | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `static void` | `setTestMode()`
In test mode it automatically prefixes all translations with some consistent garbage so that we can test that translating doesn't break anything. | +| `java.lang.String` | `tr(java.lang.String id)` | +| `java.lang.String` | `tr(java.lang.String id, java.lang.Object... args)` | +| `PHXInternationalize.InternationalizedMessage` | `trLazy(java.lang.String id)`
Return a lazily instantiated translation message that can be computed only if needed. | +| `PHXInternationalize.InternationalizedMessage` | `trLazy(java.lang.String id, java.lang.Object... args)`
Return a lazily instantiated translation message that can be computed only if needed. | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXInternationalize + +```java +public PHXInternationalize(java.lang.Class relC) +``` + +### PHXInternationalize + +```java +public PHXInternationalize(java.lang.Object rel) +``` +Creates a new instance of PHXInternationalize + +## Method Detail + +### setTestMode + +```java +public static void setTestMode() +``` +In test mode it automatically prefixes all translations with some consistent garbage so that we can test that translating doesn't break anything. + +### tr + +```java +public java.lang.String tr(java.lang.String id) +``` + +### tr + +```java +public java.lang.String tr(java.lang.String id, java.lang.Object... args) +``` + +### trLazy + +```java +public PHXInternationalize.InternationalizedMessage trLazy(java.lang.String id) +``` +Return a lazily instantiated translation message that can be computed only if needed. + +**Parameters:** +- `id` - The translation key + +**Returns:** +- An object which can be evaluated to compute the translation message + +### trLazy + +```java +public PHXInternationalize.InternationalizedMessage trLazy(java.lang.String id, java.lang.Object... args) +``` +Return a lazily instantiated translation message that can be computed only if needed. + +**Parameters:** +- `id` - The translation key +- `args` - The arguments to the translation message + +**Returns:** +- An object which can be evaluated to compute the translation message \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineAddFilter.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineAddFilter.md new file mode 100644 index 0000000000..25aaaa824b --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineAddFilter.md @@ -0,0 +1,94 @@ +# Class: PHXNewLineAddFilter + +**Package:** `com.phoenix_int.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.io.Reader + ↳ com.phoenix_int.util.PHXNewLineAddFilter +``` + +**Implemented Interfaces** + +- `java.io.Closeable`, `java.lang.AutoCloseable`, `java.lang.Readable` + +--- + +**Declaration** + +```java +public class PHXNewLineAddFilter +extends java.io.Reader +``` + +Implementation of a FilterReader that basically does the opposite of the `PHXNewLineFilter`, adding in the platform dependent newlines from java style newlines '\n'. + +## Field Summary + +### Fields inherited from class java.io.Reader + +`lock` + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXNewLineAddFilter(java.io.Reader in)`
Creates a new instance of PHXNewLineFilter | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `close()` | +| `int` | `read(char[] cbuf, int off, int len)` | + +### Methods inherited from class java.io.Reader + +`mark`, `markSupported`, `read`, `read`, `read`, `ready`, `reset`, `skip` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXNewLineAddFilter + +```java +public PHXNewLineAddFilter(java.io.Reader in) +``` +Creates a new instance of PHXNewLineFilter + +## Method Detail + +### close + +```java +public void close() + throws java.io.IOException +``` + +**Specified by:** +- `close` in interface `java.io.Closeable` +- `close` in interface `java.lang.AutoCloseable` +- `close` in class `java.io.Reader` + +**Throws:** +- `java.io.IOException` + +### read + +```java +public int read(char[] cbuf, + int off, + int len) + throws java.io.IOException +``` + +**Specified by:** +- `read` in class `java.io.Reader` + +**Throws:** +- `java.io.IOException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md new file mode 100644 index 0000000000..bb350d7d76 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md @@ -0,0 +1,92 @@ +# Class: PHXNewLineFilter + +**Package:** `com.phoenix_int.util` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.io.Reader + ↳ com.phoenix_int.util.PHXNewLineFilter +``` + +**Implemented Interfaces** + +- `java.io.Closeable`, `java.lang.AutoCloseable`, `java.lang.Readable` + +--- + +**Declaration** + +```java +public class PHXNewLineFilter +extends java.io.Reader +``` + +Implementation of a FilterReader that processes out newlines into Java style newlines '\n' with the same logic as `BufferedReader.readLine()` + +## Field Summary + +### Fields inherited from class java.io.Reader + +`lock` + +## Constructor Summary + +| Constructor and Description | +|---------------------------| +| `PHXNewLineFilter(java.io.Reader in)`
Creates a new instance of PHXNewLineFilter | + +## Method Summary + +| Modifier and Type | Method and Description | +|-------------------|----------------------| +| `void` | `close()` | +| `int` | `read(char[] cbuf, int off, int len)` | + +### Methods inherited from class java.io.Reader + +`mark`, `markSupported`, `read`, `read`, `read`, `ready`, `reset`, `skip` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXNewLineFilter + +```java +public PHXNewLineFilter(java.io.Reader in) +``` +Creates a new instance of PHXNewLineFilter + +## Method Detail + +### close + +```java +public void close() + throws java.io.IOException +``` + +**Specified by:** +- `close` in interface `java.io.Closeable` +- `close` in interface `java.lang.AutoCloseable` +- `close` in class `java.io.Reader` + +**Throws:** +- `java.io.IOException` + +### read + +```java +public int read(char[] cbuf, int off, int len) + throws java.io.IOException +``` + +**Specified by:** +- `read` in class `java.io.Reader` + +**Throws:** +- `java.io.IOException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md new file mode 100644 index 0000000000..64c89806a5 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md @@ -0,0 +1,15 @@ +# Package com.phoenix_int.util + +## Interface Summary +| Interface | Description | +| --- | --- | +| [PHXInternationalize.InternationalizedMessage](../../../com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.html) | Interface for a lazily computed translation message. | + +## Class Summary +| Class | Description | +| --- | --- | +| [BufferedRandomAccessFile](../../../com/phoenix_int/util/BufferedRandomAccessFile.html) | Replacement for `RandomAccessFile` to use buffered I/O as much as possible. | +| [PHXBlocker](../../../com/phoenix_int/util/PHXBlocker.html) | Class to simplify wait and notify calls. | +| [PHXInternationalize](../../../com/phoenix_int/util/PHXInternationalize.html) | Helper class to do internationalization. | +| [PHXNewLineAddFilter](../../../com/phoenix_int/util/PHXNewLineAddFilter.html) | Implementation of a `FilterReader` that basically does the opposite of the `PHXNewLineFilter`, adding in the platform dependent newlines from java style newlines '\n'. | +| [PHXNewLineFilter](../../../com/phoenix_int/util/PHXNewLineFilter.html) | Implementation of a `FilterReader` that processes out newlines into Java style newlines '\n' with the same logic as `BufferedReader.readLine()` | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md new file mode 100644 index 0000000000..c212f8dfc9 --- /dev/null +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md @@ -0,0 +1,17 @@ +# Hierarchy For Package com.phoenix_int.util +**Package Hierarchies:** +- [All Packages](../../../overview-tree.html) + +## Class Hierarchy + +- java.lang.Object + - com.phoenix_int.util.[BufferedRandomAccessFile](../../../com/phoenix_int/util/BufferedRandomAccessFile.html) + - com.phoenix_int.util.[PHXBlocker](../../../com/phoenix_int/util/PHXBlocker.html) + - com.phoenix_int.util.[PHXInternationalize](../../../com/phoenix_int/util/PHXInternationalize.html) + - java.io.Reader (implements java.io.Closeable, java.lang.Readable) + - com.phoenix_int.util.[PHXNewLineAddFilter](../../../com/phoenix_int/util/PHXNewLineAddFilter.html) + - com.phoenix_int.util.[PHXNewLineFilter](../../../com/phoenix_int/util/PHXNewLineFilter.html) + +## Interface Hierarchy + +- com.phoenix_int.util.[PHXInternationalize.InternationalizedMessage](../../../com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/constant-values.md b/2025R2/modelCenter_java_api/constant-values.md new file mode 100644 index 0000000000..415517998e --- /dev/null +++ b/2025R2/modelCenter_java_api/constant-values.md @@ -0,0 +1,124 @@ +# Constant Field Values + +## Contents + +- com.phoenix_int.* + +## com.phoenix_int.* + +### com.phoenix_int.aserver.PHXComponentDescription +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final int` | `VI_AVAILABLE` | `40` | +| `public static final int` | `VI_UNAVAILABLE` | `41` | +| `public static final int` | `VI_UNKNOWN` | `39` | + +### com.phoenix_int.aserver.PHXRunShare +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final int` | `DEL_AUTO` | `14` | +| `public static final int` | `DEL_FALSE` | `15` | +| `public static final int` | `DEL_TRUE` | `16` | +| `public static final int` | `MODE_ERROR` | `1` | +| `public static final int` | `MODE_NONE` | `0` | +| `public static final int` | `MODE_SHARE` | `3` | +| `public static final int` | `MODE_WAIT` | `2` | + +### com.phoenix_int.aserver.client.PHXAnalysisClient +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final int` | `ADD_PROXY_CLIENTS_REQUEST` | `18` | +| `public static final int` | `ARBITRARY_REQUEST` | `26` | +| `public static final int` | `DELETE_RUN_SHARE_REQUEST` | `23` | +| `public static final int` | `DESCRIBE_REQUEST` | `10` | +| `public static final int` | `END_REQUEST` | `2` | +| `public static final int` | `EXECUTE_REQUEST` | `9` | +| `public static final int` | `GET_BY_URL_REQUEST` | `20` | +| `public static final int` | `GET_HIERARCHY_REQUEST` | `21` | +| `public static final int` | `GET_ICON_REQUEST` | `11` | +| `public static final int` | `GET_REQUEST` | `3` | +| `public static final int` | `HISTORY_REQUEST` | `19` | +| `public static final int` | `INVOKE_REQUEST` | `17` | +| `public static final int` | `LIST_ARRAY_VALUES_REQUEST` | `15` | +| `public static final int` | `LIST_CATEGORIES_REQUEST` | `8` | +| `public static final int` | `LIST_CLASSES_REQUEST` | `6` | +| `public static final int` | `LIST_METHODS_REQUEST` | `16` | +| `public static final int` | `LIST_PROPERTIES_REQUEST` | `7` | +| `public static final int` | `LIST_REQUEST` | `5` | +| `public static final int` | `LIST_VALUES_REQUEST` | `14` | +| `public static final int` | `LIST_VALUES_URL_REQUEST` | `27` | +| `public static final int` | `SET_BY_URL_REQUEST` | `25` | +| `public static final int` | `SET_DICTIONARY_REQUEST` | `24` | +| `public static final int` | `SET_HIERARCHY_REQUEST` | `22` | +| `public static final int` | `SET_REQUEST` | `4` | +| `public static final int` | `START_REQUEST` | `1` | + +### com.phoenix_int.aserver.types.PHXTypeFactory +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final java.lang.String` | `BOOLEAN` | `"boolean"` | +| `public static final java.lang.String` | `BOOLEAN_ARRAY` | `"boolean[]"` | +| `public static final java.lang.String` | `DOUBLE` | `"double"` | +| `public static final java.lang.String` | `DOUBLE_ARRAY` | `"double[]"` | +| `public static final java.lang.String` | `FILE` | `"file"` | +| `public static final java.lang.String` | `FILE_ARRAY` | `"file[]"` | +| `public static final java.lang.String` | `GEOMETRY` | `"geometry"` | +| `public static final java.lang.String` | `LONG` | `"long"` | +| `public static final java.lang.String` | `LONG_ARRAY` | `"long[]"` | +| `public static final java.lang.String` | `OBJECT` | `"object"` | +| `public static final java.lang.String` | `REFERENCE` | `"reference"` | +| `public static final java.lang.String` | `REFERENCE_ARRAY` | `"reference[]"` | +| `public static final java.lang.String` | `STRING` | `"string"` | +| `public static final java.lang.String` | `STRING_ARRAY` | `"string[]"` | +| `public static final java.lang.String` | `UNKNOWN` | `"UNKNOWN"` | +| `public static final java.lang.String` | `UNKNOWN_ARRAY` | `"UNKNOWN[]"` | + +### com.phoenix_int.aserver.util.Parser.Mode +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final long` | `FILE_SIZE_LIMIT` | `500000L` | + +### com.phoenix_int.aserver.util.PHXFileParser +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final long` | `FILE_SIZE_LIMIT` | `500000L` | +| `public static final int` | `FIRST` | `1` | +| `public static final int` | `LAST` | `0` | +| `public static final int` | `RESIZE_DISALLOW` | `23` | +| `public static final int` | `RESIZE_ROWS` | `24` | + +### com.phoenix_int.aserver.util.PHXRuntime +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final java.lang.String` | `DEFAULT_SHELL` | `"sh"` | + +### com.phoenix_int.aserver.util.PHXStringBuffer +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final long` | `SIZECUTOFF` | `524288L` | + +### com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final java.lang.String` | `NAME_SEPARATOR` | `";"` | + +### com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final java.lang.String` | `NAME_SEPARATOR` | `"|"` | +| `public static final java.lang.String` | `RANGE_SEPARATOR` | `","` | + +### com.phoenix_int.pacz.api.Environment +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final java.lang.String` | `COMPONENT_DIR` | `"COMPONENT_DIR"` | + +### com.phoenix_int.pacz.api.v2.Environment +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final java.lang.String` | `COMPONENT_DIR` | `"COMPONENT_DIR"` | + +### com.phoenix_int.util.PHXBlocker +| Modifier and Type | Constant Field | Value | +| --- | --- | --- | +| `public static final java.lang.String` | `rcsid` | `"$Id: PHXBlocker.java,v 1.1 2001/07/05 15:00:07 nsharp Exp $"` | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/deprecated-list.md b/2025R2/modelCenter_java_api/deprecated-list.md new file mode 100644 index 0000000000..08d9e5fa02 --- /dev/null +++ b/2025R2/modelCenter_java_api/deprecated-list.md @@ -0,0 +1,67 @@ +# Deprecated API + +## Contents + +- [Deprecated Interfaces](#deprecated-interfaces) +- [Deprecated Classes](#deprecated-classes) +- [Deprecated Enums](#deprecated-enums) +- [Deprecated Fields](#deprecated-fields) +- [Deprecated Methods](#deprecated-methods) +- [Deprecated Constructors](#deprecated-constructors) + + +## Deprecated Interfaces +| Interface and Description | +| --- | +| [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.html)
see [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md) | +| [com.phoenix_int.pacz.api.IInstanceFile](com/phoenix_int/pacz/api/IInstanceFile.html)
see [com.phoenix_int.pacz.api.v2.IInstanceFile](com/phoenix_int/pacz/api/v2/IInstanceFile.md) | +| [com.phoenix_int.aserver.library.IPHXFactory](com/phoenix_int/aserver/library/IPHXFactory.html)
It is preferred to use [`IPHXFactory2`](com/phoenix_int/aserver/library/IPHXFactory2.md), as this class has methods that can leak resources | +| [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.html)
It is preferred to use [`IPHXLibrarian2`](com/phoenix_int/aserver/library/IPHXLibrarian2.md) as this class uses methods that can leak resources. | +| [com.phoenix_int.aserver.library.IPHXVersionedLibrarian](com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html)
It is preferred to use [`IPHXVersionedLibrarian3`](com/phoenix_int/aserver/library/IPHXVersionedLibrarian3.md) as this class has methods that can leak resources | +| [com.phoenix_int.aserver.library.IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html)
It is preferred to use [`IPHXVersionedLibrarian3`](com/phoenix_int/aserver/library/IPHXVersionedLibrarian3.md) as this class supports methods that can cause file leaks. | +| [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.html)
see [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) | +| [com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html)
in favor of [OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md) | + +## Deprecated Classes +| Class and Description | +| --- | +| [com.phoenix_int.pacz.api.Environment](com/phoenix_int/pacz/api/Environment.html)
see [com.phoenix_int.pacz.api.v2.Environment](com/phoenix_int/pacz/api/v2/Environment.md) | +| [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.html)
Use [AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md) instead. | +| [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.html) | +| [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.html) | + +## Deprecated Enums +| Enum and Description | +| --- | +| [com.phoenix_int.pacz.api.RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.html)
see [`com.phoenix_int.pacz.api.v2.RunFolderPreference`](com/phoenix_int/pacz/api/v2/RunFolderPreference.md) | +| [com.phoenix_int.pacz.api.VariableDataType](com/phoenix_int/pacz/api/VariableDataType.html) IRuntimeVariables are now using the canonical PHX type identifiers which are literal strings (see [`com.phoenix_int.pacz.api.v2`](com/phoenix_int/pacz/api/v2/package-summary.md)) | + +## Deprecated Fields +| Field and Description | +| --- | +| [com.phoenix_int.aserver.util.PHXFileParser.AUTOMATIC](com/phoenix_int/aserver/util/PHXFileParser.html#AUTOMATIC)
in favor of [Parser.Mode.AUTOMATIC](com/phoenix_int/aserver/util/Parser.Mode.md#AUTOMATIC) | +| [com.phoenix_int.aserver.util.PHXFileParser.BUFFERED](com/phoenix_int/aserver/util/PHXFileParser.html#BUFFERED)
in favor of [Parser.Mode.BUFFERED](com/phoenix_int/aserver/util/Parser.Mode.md#BUFFERED) | +| [com.phoenix_int.aserver.util.PHXFileParser.FILE_SIZE_LIMIT](com/phoenix_int/aserver/util/PHXFileParser.html#FILE_SIZE_LIMIT)
in favor of [Parser.Mode.FILE_SIZE_LIMIT](com/phoenix_int/aserver/util/Parser.Mode.md#FILE_SIZE_LIMIT) | +| [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile.GENERATE](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#GENERATE)
in favor of [ParseableFile.Mode.GENERATE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#GENERATE) | +| [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile.PARSE](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#PARSE)
in favor of [ParseableFile.Mode.PARSE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#PARSE) | +| [com.phoenix_int.aserver.util.PHXFileParser.RANDOM_ACCESS](com/phoenix_int/aserver/util/PHXFileParser.html#RANDOM_ACCESS)
in favor of [Parser.Mode.RANDOM](com/phoenix_int/aserver/util/Parser.Mode.md#RANDOM) | +| [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile.READ_TEMPLATE](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#READ_TEMPLATE)
in favor of [ParseableFile.Mode.READ_TEMPLATE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#READ_TEMPLATE) | + +## Deprecated Methods +| Method and Description | +| --- | +| [com.phoenix_int.aserver.types.PHXTypeFactory.allocateArray(String)](com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateArray-java.lang.String-)
Prefer [PHXTypeFactory.allocateVariable2(java.lang.String)](com/phoenix_int/aserver/types/PHXTypeFactory.md#allocateVariable2-java.lang.String-) which can properly differentiate between arrays and non-array types. | +| [com.phoenix_int.aserver.types.PHXTypeFactory.allocateVariable(String)](com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable-java.lang.String-)
Prefer [PHXTypeFactory.allocateVariable2(java.lang.String)](com/phoenix_int/aserver/types/PHXTypeFactory.md#allocateVariable2-java.lang.String-) which can properly differentiate between arrays and non-array types. | +| [com.phoenix_int.aserver.types.PHXString.arrayToString(String[])](com/phoenix_int/aserver/types/PHXString.html#arrayToString-java.lang.String:A-) | +| [com.phoenix_int.aserver.types.PHXInteger.getHasFormat()](com/phoenix_int/aserver/types/PHXInteger.html#getHasFormat--)
in favor of [PHXInteger.hasFormat()](com/phoenix_int/aserver/types/PHXInteger.md#hasFormat--) | +| [com.phoenix_int.aserver.types.PHXLong.getHasFormat()](com/phoenix_int/aserver/types/PHXLong.html#getHasFormat--)
in favor of [PHXLong.hasFormat()](com/phoenix_int/aserver/types/PHXLong.md#hasFormat--) | +| [com.phoenix_int.aserver.types.PHXRawFile.getValueStream()](com/phoenix_int/aserver/types/PHXRawFile.html#getValueStream--)
using `toString2().getInputStream()` is prefered. | +| [com.phoenix_int.aserver.library.IPHXFactory.instantiate(File, String, String)](com/phoenix_int/aserver/library/IPHXFactory.html#instantiate-java.io.File-java.lang.String-java.lang.String-)
It is preferred to use [`IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)`](com/phoenix_int/aserver/library/IPHXFactory2.md#instantiateManaged-java.io.File-java.lang.String-java.lang.String-) as this method can lead to resource leaks. | +| [com.phoenix_int.aserver.library.IPHXLibrarian.instantiate(String, String)](com/phoenix_int/aserver/library/IPHXLibrarian.html#instantiate-java.lang.String-java.lang.String-) | +| [com.phoenix_int.aserver.library.IPHXLibrarian.instantiate(String, String, String, String)](com/phoenix_int/aserver/library/IPHXLibrarian.html#instantiate-java.lang.String-java.lang.String-java.lang.String-java.lang.String-) | + +## Deprecated Construtors +| Constructor and Description | +| --- | +| [com.phoenix_int.aserver.util.PHXFileParser(String, int)](com/phoenix_int/aserver/util/PHXFileParser.html#PHXFileParser-java.lang.String-int-)
in favor of [PHXFileParser.PHXFileParser(String, Parser.Mode)](com/phoenix_int/aserver/util/PHXFileParser.md#PHXFileParser-java.lang.String-com.phoenix_int.aserver.util.Parser.Mode-) | +| [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile(PHXScriptWrapperObject, int)](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#PHXRowFieldFile-com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject-int-)
in favor of [PHXRowFieldFile.PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md#PHXRowFieldFile-com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject-com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode-) | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/docfx.json b/2025R2/modelCenter_java_api/docfx.json new file mode 100644 index 0000000000..57a65b0c01 --- /dev/null +++ b/2025R2/modelCenter_java_api/docfx.json @@ -0,0 +1,13 @@ +{ + "build": { + "globalMetadata": { + "title": "ModelCenter", + "summary": "", + "version": "2025 R2", + "product": "ModelCenter", + "programming language": "java", + "product collection": "Connect", + "physics": "Connect" + } + } +} \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/index-all.md b/2025R2/modelCenter_java_api/index-all.md new file mode 100644 index 0000000000..ca189a6026 --- /dev/null +++ b/2025R2/modelCenter_java_api/index-all.md @@ -0,0 +1,2175 @@ +# A +- **absoluteEndRow(IPHXLineStore, Vector, Vector)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **absoluteStartRow(IPHXLineStore, Vector, Vector)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md)
Returns the actual starting row number +- **AbstractFile** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Common implementation for files (not file variables) used in script wrappers. +- **AbstractFile(File, ParseableFile.Mode)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Pre-QuickWrap [PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) constructor did not have a [PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md) argument. +- **AbstractFile(PHXScriptWrapperObject, ParseableFile.Mode)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
+- **AbstractFile(PHXScriptWrapperObject, File, ParseableFile.Mode)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
+- **Accept(IPHXType2.IVisitor``)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Accept a Visitor. +- **Accept(IPHXType2.IVisitor``)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
Accept a Visitor. +- **actionByMode(ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Perform an action consistent with [ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md) +- **ADD_PROXY_CLIENTS_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **addAutoClose(Closeable)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Add the opened file to the file Handlers list +- **addBranch(PHXComponentBranch)** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Adds a sub-branch to this version. +- **addConsoleVariables()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
+- **addEscapes(String)** - Static method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Convenience static for adding escapes to plain strings +- **addEscapes(String, String)** - Static method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
+- **addEscapes()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
+- **addEscapesExtra(String)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
+- **addException(Exception)** - Method in exception [com.phoenix_int.aserver.util.PHXClassNotFoundException](com/phoenix_int/aserver/util/PHXClassNotFoundException.md)
+- **addFileInfo(PHXRowFieldFile, String, ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
+- **addFileToCopy(String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
+- **addGroup(PHXGroup)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
adds a child group to the group +- **addLibrarian(IPHXLibrarian)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
Adds a librarian to our list +- **addLibrarian(String, IPHXLibrarian)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
Creates a librarian mount. +- **addLines(int, int, String)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
+- **addLines(int, String[])** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
+- **addListener(IPHXAnalysisClientListener)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
adds a listener +- **addMethod(String, String, boolean, boolean)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
adds a method name to the object +- **addMethod(String, String, boolean)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
relay function for `addMethod( String name, String fullName, boolean isVisible, boolean downloadInputs = false )` +- **addMethod(String, boolean)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
relay function for `addMethod( String name, String fullName = name, boolean isVisible )` +- **addMethod(String, String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
relay function for addMethod( String name, String fullName, boolean isVisible=true ) +- **addMethod(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
relay function for addMethod( String name, boolean isVisible=true ) +- **addMethod(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Publicizes a method to our clients. +- **addMethod(String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Publicizes a method to our clients. +- **addMethod(String, boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Publicizes a method to our clients. +- **addMethod(String, String, boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Publicizes a method to our clients. +- **addMonitor(PHXFileMonitor)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
PHXFileMonitor is used to monitor changes to a file as it is being created as in the UNIX 'tail -f' command. +- **addMonitorListener(IPHXFileCallback)** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
Adds a listener which gets events based on changes to this monitor +- **addPropertyChangeListener(PropertyChangeListener)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
+- **addProxyClients(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Tells the server to add other hosts as part of the proxy chain +- **addProxyClients(Iterable``)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Add a list of allowed proxy client hosts. +- **addProxyClientsAsync(Iterable``, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Add a list of allowed proxy client hosts. +- **addRunDirChangedListener(IPHXRunDirChangedListener)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Adds a listener which will receive events when the run directory is changed. +- **addTraceListener(IPHXTraceListener)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Adds a listener to trace events +- **addVariable(PHXVariableInfo)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
stores a variable in the group. +- **addVariable(String, String, boolean, Object)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
adds a variable object to the manager +- **addVariable(String, boolean, Object)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
adds a variable object to the manager +- **addVariable(PHXVariableInfo)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
adds a variable information object to the manager +- **addVariable(String, PHXVariableInfo)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
adds a variable information object to the manager +- **addVariable(String, String, boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Adds a variable to this component. +- **addVariable(String, String, boolean, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Add a variable to the wrapper. +- **addVersion(PHXComponentVersion)** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Adds a version to this branch +- **allocateArray(String)** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Deprecated.
Prefer [PHXTypeFactory.allocateVariable2(java.lang.String)](com/phoenix_int/aserver/types/PHXTypeFactory.md#allocateVariable2-java.lang.String-) which can properly differentiate between arrays and non-array types. +- **allocateElement(Class)** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
+- **allocateElement(Class)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
+- **allocateElement(Class)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
+- **allocateElement(Class)** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md)
+- **allocateElement(Class)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Allocates a single element in a default state. +- **allocateElement(Class)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Allocates a single element in a default state. +- **allocateVariable(String)** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Deprecated.
Prefer [PHXTypeFactory.allocateVariable2(java.lang.String)](com/phoenix_int/aserver/types/PHXTypeFactory.md#allocateVariable2-java.lang.String-) which can properly differentiate between arrays and non-array types. +- **allocateVariable2(String)** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Allocate a given variable for the given type string +- **AnalysisServerClient** - Class in [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
ModelCenter Remote Execution client object. +- **AnalysisServerClient()** - Constructor for class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
+- **AnalysisServerException** - Exception in [com.phoenix_int.aserver.client.v2.AnalysisServerException](com/phoenix_int/aserver/client/v2/AnalysisServerException.md)
Exception thrown when a request fails on the server. +- **AnalysisServerException(String)** - Constructor for exception [com.phoenix_int.aserver.client.v2.AnalysisServerException](com/phoenix_int/aserver/client/v2/AnalysisServerException.md)
Constructor. +- **AnalysisServerException(String, Throwable)** - Constructor for exception [com.phoenix_int.aserver.client.v2.AnalysisServerException](com/phoenix_int/aserver/client/v2/AnalysisServerException.md)
Constructor. +- **AnalysisServerResponse** - Class in [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Implementation of PHXResponse along lines of PHXResponse in C++ code. +- **AnalysisServerResponse()** - Constructor for class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
+- **AnalysisServerResponseType** - Enum in [com.phoenix_int.aserver.client.v2.AnalysisServerResponseType](com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md)
Enumeration representing response type. +- **AnalysisServerVersion** - Class in [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md)
Server protocol version. +- **AnalysisServerVersion(int, int, int)** - Constructor for class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md)
Constructor. +- **AnalysisServerWaitCallback** - Class in [com.phoenix_int.aserver.client.v2.AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md)
Callback object which uses a monitor to allow the caller to block until a response is received. +- **AnalysisServerWaitCallback()** - Constructor for class [com.phoenix_int.aserver.client.v2.AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md)
+- **AnalysisVariableValue** - Class in [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Class representing a variable value. +- **AnalysisVariableValue(String, boolean, String, Object, boolean)** - Constructor for class [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Constructor. +- **append(String)** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
Appends a string to this monitor +- **append(String)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a string to this buffer +- **append(char[])** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a char array to this buffer +- **append(char[], int, int)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a char array to this buffer +- **append(byte[])** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a byte array using the default encoding +- **append(byte[], int, int)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a byte array using the default encoding +- **append(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a PHXStringBuffer to this buffer. +- **append(InputStream)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Fully reads the contents of InputStream into this buffer using UTF-8 encoding. +- **append(Reader)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
+- **append(int)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends an integer to this buffer +- **append(long)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a long to this buffer +- **append(float)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a float to this buffer +- **append(char)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Appends a single char to this buffer +- **ARBITRARY_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **arrayToString(double[])** - Static method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
+- **arrayToString(int[])** - Static method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
+- **arrayToString(long[])** - Static method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
+- **arrayToString(String[])** - Static method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Deprecated.
+- **arrayToStringEscaped(String[])** - Static method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Quotes each element of the array using c-style escape sequences, then + builds a comma separated list of the elements with quotes around each element. +- **asChunkDescriptor()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Parse the response as a chunk descriptor. +- **asComponentDescription(boolean)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Parse a component description. +- **asHierarchy()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Parse the response as a variable hierarchy. +- **asList()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Convert the string data to a list of properties. +- **asMethodDescriptors()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Convert the string data to a list of method descriptors. +- **asPropertyDescriptor(StringBuffer, String, String, boolean, boolean)** - Static method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
Stringify the property descriptor data. +- **asPropertyDescriptors()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Parse this response as a sequence of property descriptors. +- **asPropertyDescriptors(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Parse this response as a sequence of property descriptors. +- **assertEquals(IPHXRange)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md)
+- **assertEquals(PHXBookmark)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md)
Test comparison function. +- **assertEquals(IPHXRange)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md)
+- **assertEquals(IPHXRange)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md)
Test comparison function. +- **assertEquals(PHXSection)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md)
Test comparison function. +- **asValueDescriptor()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
converts the property to a machine-readable format +- **asValueDescriptor(StringBuffer, String, String, boolean, boolean, String)** - Static method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
Stringify the value descriptor data. +- **asValueDescriptor2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
converts the property to a readable format. +- **asValueDescriptor3(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
converts the property to a readable format. +- **asValueDescriptors()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Parse the response as a list of value descriptors. +- **asVersion()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Get the response as a server version. +- **asVersionHistory()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Parse the response as a version history. +- **AUTOMATIC** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Deprecated in favor of [Parser.Mode.AUTOMATIC](com/phoenix_int/aserver/util/Parser.Mode.md#AUTOMATIC) + +# B + +- **backup()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Backup the file on disk. +- **backup()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)
Backup the file on disk. +- **backupFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Backup the actual file on disk. +- **backupFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Backup the actual file on disk. +- **backupFile(String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Backup the file on disk. +- **block(long)** - Method in class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md)
Blocks until unblock is invoked or timeout has been reached +- **block()** - Method in class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md)
Blocks until unblock() is invoked. +- **BOOLEAN** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a boolean type +- **BOOLEAN_ARRAY** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a boolean array type +- **BUFFERED** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Deprecated in favor of [Parser.Mode.BUFFERED](com/phoenix_int/aserver/util/Parser.Mode.md#BUFFERED) +- **BufferedRandomAccessFile** - Class in [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md)
Replacement for RandomAccessFile to use buffered I/O as much as possible. +- **BufferedRandomAccessFile(File, String, int)** - Constructor for class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md)
Constructs a BufferedRandomAccessFile + +# C + +- **CAEOutputFile** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md)
This represents a binary output file from a CAE program such as NASTRAN or LSDyna. +- **CAEOutputFile(PHXScriptWrapperObject, File, FileType)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) +- **CAEOutputFile(PHXScriptWrapperObject, File)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) +- **callMethod(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
call a method +- **charAt(long)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Get the character at the specified index +- **checkGroup(String)** - Static method in exception [com.phoenix_int.aserver.PHXInvalidNameException](com/phoenix_int/aserver/PHXInvalidNameException.md)
checks a name to see if it's valid. +- **checkName(String)** - Static method in exception [com.phoenix_int.aserver.PHXInvalidNameException](com/phoenix_int/aserver/PHXInvalidNameException.md)
checks a name to see if it's valid +- **checkRectangular(Object)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Check if the array is rectangular +- **cleanTempDir()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
cleans up the temporary run directory if one has been created. +- **cleanUp()** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated.
Tells this librarian to clean up any resources used. +- **cleanUp()** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
Delete all the temp directories +- **cleanUp()** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
This class has no cleaning up to do +- **cleanUp()** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
Recursively tells kids to clean themselves up +- **cleanUp()** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
Recursively calls cleanUp on all our mount points +- **cleanUp()** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md) +- **clear()** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
Clears the contents of this monitor +- **clear()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
This is for performance only, it allows large temp files and memory to be freed. +- **clearEndingMark()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **clearMarks()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
resets the file to it's whole size by removing the starting and ending marks if they existed +- **clearMarks()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Removes effects of any previous `markAsBeginning()` or `markAsEnd()` calls +- **clearStartingMark()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **close()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
closes the connection to the server +- **close()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Close the connection to the server. +- **close()** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream.MonitorWriter](com/phoenix_int/aserver/monitors/PHXMonitorableStream$MonitorWriter.md) +- **close()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **close()** - Method in interface [com.phoenix_int.aserver.util.IPHXLineStore](com/phoenix_int/aserver/util/IPHXLineStore.md)
close any resources associated with this line store +- **close()** - Method in interface [com.phoenix_int.aserver.util.Parser](com/phoenix_int/aserver/util/Parser.md)
Close the parser +- **close()** - Method in class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md)
closes the file +- **close()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **close()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Close the file and free up resources +- **close()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)
Close the file and free up resources +- **close()** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **close()** - Method in class [com.phoenix_int.util.PHXNewLineAddFilter](com/phoenix_int/util/PHXNewLineAddFilter.md) +- **close()** - Method in class [com.phoenix_int.util.PHXNewLineFilter](com/phoenix_int/util/PHXNewLineFilter.md) +- **closeFile()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
close the PHXRandomAccessFileLineStore +- **cmd** - Variable in class [com.phoenix_int.aserver.PHXRunShare.RunInfo](com/phoenix_int/aserver/PHXRunShare$RunInfo.md) +- **collect** - Variable in class [com.phoenix_int.aserver.types.PHXDataCollector](com/phoenix_int/aserver/types/PHXDataCollector.md) +- **com.phoenix_int.aserver** - package [com.phoenix_int.aserver](com/phoenix_int/aserver/package-summary.md) +- **com.phoenix_int.aserver.client** - package [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/package-summary.md)
Provides a client package for programmatically invoking ModelCenter Remote Execution remotely from the Java language. +- **com.phoenix_int.aserver.client.v2** - package [com.phoenix_int.aserver.client.v2](com/phoenix_int/aserver/client/v2/package-summary.md) +- **com.phoenix_int.aserver.library** - package [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/package-summary.md)
Provides a library of available components and catgories (directories) andfactories for instantiating components. +- **com.phoenix_int.aserver.monitors** - package [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/package-summary.md)
Provides interfaces and classes for adding process and output monitoring of components. +- **com.phoenix_int.aserver.types** - package [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/package-summary.md)
Provides a collection of basic data types that contain meta-information like description and units. +- **com.phoenix_int.aserver.util** - package [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/package-summary.md)
Provides general purpose utility functions. +- **com.phoenix_int.aserver.util.scriptwrapper.api** - package [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md)
Provides utilities which are designed to make writing ScriptWrappers with FileWrapper-like capabilities. +- **com.phoenix_int.pacz.api** - package [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api/package-summary.md)
PACZ (extension .pacz) is a universal component/workflow format for use in ModelCenter Remote Execution and ModelCenter Server. +- **com.phoenix_int.pacz.api.v2** - package [com.phoenix_int.pacz.api.v2](com/phoenix_int/pacz/api/v2/package-summary.md)
PACZ (extension .pacz) is a universal component/workflow format for use in ModelCenter Remote Execution and ModelCenter Server. +- **com.phoenix_int.util** - package [com.phoenix_int.util](com/phoenix_int/util/package-summary.md) +- **compareTo(AnalysisServerVersion)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md)** +- **COMPONENT_DIR** - Static variable in class [com.phoenix_int.pacz.api.Environment](com/phoenix_int/pacz/api/Environment.md)
Deprecated.
Pre-defined component directory environment variable +- **COMPONENT_DIR** - Static variable in class [com.phoenix_int.pacz.api.v2.Environment](com/phoenix_int/pacz/api/v2/Environment.md)
Pre-defined component directory environment variable +- **computeMessage()** - Method in interface [com.phoenix_int.util.PHXInternationalize.InternationalizedMessage](com/phoenix_int/util/PHXInternationalize$InternationalizedMessage.md)
Compute the translation and return the message +- **connect(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the MCRE on the specified host +- **connect(String, int)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the MCRE on the specified host +- **connect(String, int, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the MCRE on the specified host +- **connect(String, int, boolean, int)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the MCRE on the specified host +- **connect(String, int, boolean, int, String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the MCRE on the specified host +- **connect(URI)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to a ModelCenter Remote Execution at a specified URI with no timeout. +- **connect(URI, int)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to a ModelCenter Remote Execution at a specified URI. +- **connect(URI, String, String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to a ModelCenter Remote Execution with optional authentication and no timeout. +- **connect(URI, String, String, int)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to a ModelCenter Remote Execution with optional authentication. +- **connectEmbedded()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to the in-process (embedded) ModelCenter Remote Execution instance. +- **connectEmbedded(String, String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to the in-process (embedded) ModelCenter Remote Execution instance. +- **connectEmbedded(Map``)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to the in-process (embedded) ModelCenter Remote Execution instance. +- **connectEmbedded(Map``, String, String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to the in-process (embedded) ModelCenter Remote Execution instance. +- **connectExternal(String, int, String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the MCRE via external tool +- **connectLocal(String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Makes a virtual connection to the ModelCenter Remote Execution inside of this process. +- **connectLocal(String, String, Map``)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Makes a virtual connection to the MCRE inside of this process. +- **connectProcess(String, String, String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Makes a virtual connection to the MCRE by calling a new java process. +- **connectSsh(String, InputStream, OutputStream, InputStream)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Connect to ModelCenter Remote Execution via arbitrary input and output streams. +- **connectURL(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the MCRE using the specified URL, such as `mcre://hostname`. +- **connectURL(String, int, String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
connects to the ModelCenter Remote Execution using the specified URL, such as `mcre://hostname`. +- **contains(PHXVariableInfo)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
checks to see if a variable exists in this group +- **contains(String)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
Checks to see if a variable exists in this group. +- **copy(PHXSimpleArray)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Clone another PHXSimpleArray's value and metadata. +- **copy()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **correctName(String)** - Static method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **countTokens(int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
counts the number of tokens on a specified row +- **countTokens()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Calculates the number of times that this tokenizer's`nextToken`method can be called before it generates an exception. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md) +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
+- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Create a copy of this instance, including the value and metadata. +- **createCopy()** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **createCopy()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Get a clone of this variable, including its metadata and value. +- **createRefProp(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
adds a property to the variable +- **createRefProp(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
adds a ref prop to the variable. + +# D + +- **dataReady(String)** - Method in interface [com.phoenix_int.aserver.monitors.IPHXFileCallback](com/phoenix_int/aserver/monitors/IPHXFileCallback.md)
Called when data is ready +- **dataTypeOK(Class)** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md) +- **dataTypeOK(Class)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **dataTypeOK(Class)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **dataTypeOK(Class)** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md) +- **dataTypeOK(Class)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) +- **dataTypeOK(Class)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Must override this function and return true if the specified class is acceptable as an array element component type. +- **dataTypeOK(Class)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **DEFAULT_SHELL** - Static variable in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md) +- **defaultExecutableMapping(String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md) +- **defineArrayVar(String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) +- **defineBookmark(String, String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) +- **defineSection(String, String, String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) +- **defineVar(String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) +- **defineVar(String, String, boolean, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) +- **defineVar(String, String, boolean, String, String, String, String, String, String, String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) +- **defineVar(String, String, boolean, String, String, String, String, String, String, String, String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) +- **DEL_AUTO** - Static variable in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
delete the directory only if an error did not occur while running the wrapper. +- **DEL_FALSE** - Static variable in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
do not delete the directory. +- **DEL_TRUE** - Static variable in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
delete the directory. +- **delete()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Delete the file from disk. +- **delete()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)
Delete the file from disk. +- **DELETE_RUN_SHARE_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **deleteAllMembers()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
delete all members for non-strict type object. +- **deleteContents()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Releases the handle to the temporary file. +- **deleteFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Deletes the actual file from disk. +- **deleteFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Deletes the actual file from disk. +- **deleteFile(String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Deletes the given file variable's file +- **deleteMember(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
delete a member for non-strict type object. +- **deleteRunShare(Long)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Handle cleaning up a runShare in a local client +- **deleteRunShare(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Delete a run share. +- **deleteRunShareAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Delete a run share. +- **describe(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
describes an analysis +- **describe(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the description of an analysis. +- **describe(File, String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXFactory](com/phoenix_int/aserver/library/IPHXFactory.md)
Deprecated.
Describes the specified component. +- **describe(String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated.
describes the specified component +- **describe(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
describes the specified component. +- **describe(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
describes the specified component. +- **describe(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
describes the specified component. +- **describe(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
describes the specified component. +- **describe(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
describes the specified component. +- **DESCRIBE_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **describeAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the description history of an analysis. +- **destroy()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **doMonitor()** - Method in class [com.phoenix_int.aserver.monitors.PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md)
Begin monitoring. +- **DOUBLE** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a double type +- **DOUBLE_ARRAY** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a double array type + +# E + +- **elementFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md) +- **elementFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **elementFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **elementFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md) +- **elementFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) +- **elementFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. +- **elementFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **encoding** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **end(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
ends an analysis +- **end(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
End an analysis. +- **end()** - Method in interface [com.phoenix_int.aserver.IPHXComponent](com/phoenix_int/aserver/IPHXComponent.md)
notifies the driver that it has ended. +- **end()** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md) +- **END_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **endAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
End an analysis. +- **endIteration()** - Method in interface [com.phoenix_int.aserver.IPHXDriver](com/phoenix_int/aserver/IPHXDriver.md)
performs the second step for an iteration of a driver. +- **endMonitor()** - Method in class [com.phoenix_int.aserver.monitors.PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md)
Signals this monitor to stop monitoring and return as soon as possible. +- **ensureFileParser(ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Ensure there is a valid parser +- **ensureFileParser(ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Ensure there is a valid parser +- **enumValuesFromString(String)** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md) +- **enumValuesFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
sets the enum values from a comma-separated list of values +- **enumValuesFromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
sets the enum values from a comma-separated list of values +- **Environment** - Class in [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api.md)
Deprecated.
see com.phoenix_int.pacz.api.v2.Environment +- **Environment()** - Constructor for class [com.phoenix_int.pacz.api.Environment](com/phoenix_int/pacz/api/Environment.md)
Deprecated.
Constructor +- **Environment(Map``)** - Constructor for class [com.phoenix_int.pacz.api.Environment](com/phoenix_int/pacz/api/Environment.md)
Deprecated.
Copy constructor +- **Environment** - Class in [com.phoenix_int.pacz.api.v2](com/phoenix_int/pacz/api/v2.md)
Environment variables for component configuration +- **Environment()** - Constructor for class [com.phoenix_int.pacz.api.v2.Environment](com/phoenix_int/pacz/api/v2/Environment.md)
Constructor +- **Environment(Map``)** - Constructor for class [com.phoenix_int.pacz.api.v2.Environment](com/phoenix_int/pacz/api/v2/Environment.md)
Copy constructor +- **equals(Object)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion**](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md) +- **equals(Object)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Compares this to another String or `PHXStringBuffer`. +- **equalsIgnoreCase(Object)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Compares this to another String or `PHXStringBuffer`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **equalsNatural(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Compare this `PHXSimpleType` to another `PHXSimpleType`. +- **evaluateKey(String)** - Method in class [com.phoenix_int.pacz.api.Environment](com/phoenix_int/pacz/api/Environment.md)
Deprecated.
Get the value for the specified environment variable +- **evaluateKey(String)** - Method in class [com.phoenix_int.pacz.api.v2.Environment](com/phoenix_int/pacz/api/v2/Environment.md)
Get the value for the specified environment variable +- **evaluateString(String)** - Method in class [com.phoenix_int.pacz.api.Environment](com/phoenix_int/pacz/api/Environment.md)
Deprecated.
Substitute environment variables in specified string with corresponding environment values +- **evaluateString(String)** - Method in class [com.phoenix_int.pacz.api.v2.Environment](com/phoenix_int/pacz/api/v2/Environment.md)
Substitute environment variables in specified string with corresponding environment values +- **exec(String, String)** - Method in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md)
runs the specified command. +- **exec2(String, String, boolean)** - Method in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md)
runs the specified command. +- **execute(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
exectutes an analysis +- **execute(String, boolean)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Execute an analysis. +- **execute()** - Method in interface [com.phoenix_int.aserver.IPHXAnalysis](com/phoenix_int/aserver/IPHXAnalysis.md)
executes the analysis. +- **EXECUTE_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **executeAsync(String, boolean, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Execute an analysis. +- **exitValue()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md)
+ +# F + +- **FILE** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a file type +- **FILE_ARRAY** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a file array type +- **FILE_SIZE_LIMIT** - Static variable in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.md#FILE_SIZE_LIMIT) +- **FILE_SIZE_LIMIT** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Deprecated in favor of [Parser.Mode.FILE_SIZE_LIMIT](com/phoenix_int/aserver/util/Parser.Mode.md#FILE_SIZE_LIMIT) +- **FileMonitorChangeException()** - Constructor for exception [com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeException](com/phoenix_int/aserver/monitors/PHXFileMonitor.md#FileMonitorChangeException) +- **FileMonitorChangeException(String)** - Constructor for exception [com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeException](com/phoenix_int/aserver/monitors/PHXFileMonitor.md#FileMonitorChangeException) +- **fileName** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **fileTruncated()** - Method in interface [com.phoenix_int.aserver.monitors.IPHXFileCallback](com/phoenix_int/aserver/monitors/IPHXFileCallback.md)
Indicates that the file was truncated back to 0 bytes. +- **finalize()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **finalize()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Clean up during finalization. +- **finalize()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md) +- **finalize()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Although close should be called manually before garbage collection, do so here as a backup. +- **finalize()** - Method in class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md) +- **findBranch(String)** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Finds any sub-branch that is part of any version in this branch by name +- **findVersion(String)** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Finds a sub-version by the specified name +- **FIRST** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **firstWord()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Returns the first word of this string, whitespace delimited. +- **flush()** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream.MonitorWriter](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md#MonitorWriter) +- **flush()** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **forceSetValue(String, String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
sets the value for a variable regardless of whether it's an input or an output +- **fromAPIObject(Map``, FunctionThrows``)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Populate this instance from a string-string map. +- **fromCode(int)** - Static method in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.md) +- **fromCode(int)** - Static method in enum [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md)
Utility function for determining the enum from the legacy integer code +- **fromFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the filename and then loads the contents of the actual file on disk into the temporary file. +- **fromFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Loads the contents of the actual file on disk into the temporary file. +- **fromFile(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
loads the file from disk for an element of an 1D array. +- **fromFile(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
loads the file from disk for an element of an array. +- **fromFile(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Sets the filename and then reads from disk for an element of an 1D array. +- **fromFile(int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Sets the filename and then reads from disk for an element of an array. +- **fromFile(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
load a file into a file member +- **fromFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
load a file into a file member. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Load the value of this object from the specified object. +- **fromObject(Object)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
Load the value of this object from the specified object. +- **fromString(String)** - Static method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **fromString(String)** - Method in interface [com.phoenix_int.aserver.types.IPHXType](com/phoenix_int/aserver/types/IPHXType.md)
Set the value for the variable using a string +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
converts a String representation to the internal value +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
converts a String representation to the internal value +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
converts a String representation to the internal value +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
converts a String representation to the internal value +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
converts a String representation to the internal value +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
converts a String representation to the internal value +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the file temporary file contents to the value of the string. +- **fromString(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
converts a String representation to the internal value for an element of an 1D array +- **fromString(int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
converts a String representation to the internal value for an element of an array +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
converts from a string +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
update object using the XML value +- **fromString(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the value of a single element based on string input for 1-d arrays. +- **fromString(int[], PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the value of a single element based on string input. +- **fromString(int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the value of a single element based on string input. +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
reads in the entire array in string form. +- **fromString(String)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
converts a String representation to the internal value +- **fromString(String)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md) +- **fromString(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **fromString(String)** - Method in class com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **fromString2(PHXStringBuffer)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md)
Configures the type based on a PHXStringBuffer representation of the type +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
converts a PHXStringBuffer representation to the internal value +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
converts a PHXStringBuffer representation to the internal value +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
converts a PHXStringBuffer representation to the internal value +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
converts a PHXStringBuffer representation to the internal value +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
converts a String representation to the internal value +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
converts a PHXStringBuffer representation to the internal value +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the file temporary file contents to the value of the PHXStringBuffer. +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
converts from a PHXStringBuffer +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
update object using the XML value +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
reads in the entire array in string form. +- **fromString2(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
converts a PHXStringBuffer representation to the internal value +- **fromString3(String, ToDoubleFunction``)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
converts a String representation to the internal value using specified converter +- **fromXML(String)** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Reads in an XML description of a branch into this object +- **fromXML(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
update the object from an XML string + +# G + +- **generate()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md)
Generate the input file +- **GENERATE** - Static variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Deprecated in favor of [ParseableFile.Mode.GENERATE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#GENERATE) +- **generate()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Generate the input file +- **generate()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Generate the input file +- **generateFor(Object)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Static method to generate a new instance of one of the sub-classes of `PHXSimpleArray` as appropriate for the type of variable passed in. +- **generateFor(Object, Class)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Static method to generate a new instance of one of the sub-classes of `PHXSimpleArray` as appropriate for the type of variable passed in. +- **GEOMETRY** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a geometry type +- **get(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
get the value of a property +- **get(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Request the value of a property. +- **get2(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
get the value of a property +- **GET_BY_URL_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **GET_HIERARCHY_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **GET_ICON_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **GET_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **getAbsoluteStartRow()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md)
Returns the stored starting row number, assuming it has been stored. +- **getAdditionalConfigValue(String)** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get additional configuration value based on specified value name. +- **getAdditionalConfigValue(String)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get additional configuration value based on specified value name. +- **getAdditionalConfigValues()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get additional configuration values as key-value pair map +- **getAdditionalConfigValues()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get additional configuration values as key-value pair map +- **getAddProxyClientsResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getAppearance()** - Method in class [com.phoenix_int.aserver.types.PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.md) +- **getArray()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the entire contents of the array +- **getArrayElement(int)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets a particular element from a 1-d array +- **getArrayElement(int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets a particular element from the array +- **getASComponent()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get ModelCenter Remote Execution component name +- **getASComponent()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get ModelCenter Remote Execution component name +- **getAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Request the value of a property. +- **getAuthor()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getAuthor()** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Gets the version author +- **getAuthor()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get the author of this component. +- **getAutoChangeDir()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Gets the "AutoChangeDir" flag +- **getAutoDelete()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Gets the auto-delete mode +- **getAutoGrow()** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
retrieves the autoGrow value +- **getAvg()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **getAvg()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **getBaseDirectory()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Gets the base dir which was passed in to the constructor. +- **getBaseName()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
gets the base name of the file +- **getBaseName()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
gets the base name of the files stored in the array +- **getBaseName()** - Method in class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md) +- **getBinaryData()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Get the binary data; only valid if format is Extended or Icon. +- **getBlock()** - Method in class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md) +- **getBlue()** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **getBooleanArrayMemberValue(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of an 1D boolean array element +- **getBooleanArrayMemberValue(String, int[])** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of a boolean array element +- **getBooleanMemberValue(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
gets the value of boolean member +- **getBooleanValue(int)** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Gets the value of an element as a boolean +- **getBooleanValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Gets the value of an element as a boolean +- **getBranch(int)** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Returns the i'th sub-branch +- **getBranches()** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Returns an Iterator over the sub-branches +- **getBranchesAndTags()** - Method in interface [com.phoenix_int.aserver.library.IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md)
Deprecated.
Fetches a list of all branches and tags +- **getBranchesAndTags()** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
Does not support branching and tagging +- **getBranchesAndTags()** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md) +- **getBranchesAndTags()** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md) +- **getBuild()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md)
Get the build. +- **getByUrl(String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
get the value of a property +- **getByUrl(File, String, String, boolean)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get a file by URL. +- **getByUrl(File, String, boolean)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Convenience overload of getByUrl(File, String, String, boolean). +- **getByUrlAsync(File, String, String, boolean, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Fetch the contents of a file by URL. +- **getCanGet()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
determines if the property can be retrieved +- **getCanSet()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
determines if the property can be modified +- **getCG()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getcgX()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getcgY()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getcgZ()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getChecksum()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getChildren(Vector, boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **getClass(String)** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
returns the class for the specified type. +- **getClassURL()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the class type. +- **getCode()** - Method in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.md)
Retrieve the legacy integer code assigned to this access mode +- **getCode()** - Method in enum [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md)
Retrieve the legacy integer code assigned to this mode +- **getCollect()** - Method in class [com.phoenix_int.aserver.types.PHXDataCollector](com/phoenix_int/aserver/types/PHXDataCollector.md) +- **getColumnArray(int, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets an array of tokens for the specified range. +- **getCommand()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Returns the command name of this process +- **getCommandLineArguments()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get command line arguments to be passed to component executable +- **getCommandLineArguments()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get command line arguments to be passed to component executable +- **getComment()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get the comment associated with this component. +- **getComponentHistory(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Gets the component history for a particular component. +- **getComponentHistory(String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXVersionedLibrarian](com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md)
Deprecated.
Gets all version information about a particular component +- **getComponentHistory(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md) +- **getComponentHistory(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md) +- **getComponentHistory(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md) +- **getComponentType(Object)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the component type of an array, even for n-d arrays. +- **getComponentType()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Returns the component type of the array wrapped with this class +- **getConnection()** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.md)
Gets the connection object +- **getConnection()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
gets the connection object +- **getContents()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
retrieves the contents of the file +- **getContents()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Retrieves the contents of the temporary file. +- **getContents(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
retrieves the contents of the file for an element of an 1D array +- **getContents(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
retrieves the contents of the file for an element of an array +- **getCurrentPosition()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md) +- **getData()** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
retrieves the current value for the geometry data +- **getData()** - Method in class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md)
retrieves the data for the image +- **getDate()** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Gets the version date +- **getDecimalSeparator()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets decimal separator character for floating point literals +- **getDefaultValue()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get default value of variable +- **getDelayLoadSetupAllowed()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getDeleteRunShareResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getDelimiters()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **getDelimiters()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getDescribeResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getDescription()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getDescription()** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Gets the version description +- **getDescription()** - Method in interface [com.phoenix_int.aserver.types.IPHXDescription](com/phoenix_int/aserver/types/IPHXDescription.md)
Get the variable description +- **getDescription()** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
retrieves the description of the variable +- **getDescription()** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
retrieves a description of the ref prop +- **getDescription()** - Method in class [com.phoenix_int.aserver.types.PHXReference**](com/phoenix_int/aserver/types/PHXReference.md)
retrieves a description of the ref prop +- **getDescription()** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
retrieves a description of the ref prop +- **getDescription()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType**](com/phoenix_int/aserver/types/PHXSimpleType.md)
Deprecated.
Get component description +- **getDescription()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get component description +- **getDescription()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get variable description +- **getDescription()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get component description +- **getDescription()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Get variable description +- **getDictionary()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md) +- **getDictionary()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Gets context information for the incoming connection that is running this wrapper. +- **getDimensions(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the dimensions of an array. +- **getDimensions(Object)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the array of dimensions of the array +- **getDimensions()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **getDimensionsAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the dimensions of an array. +- **getDirectory()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Returns the current directory being used by the runshare system. +- **getDirectory()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Returns the directory where this component was loaded from +- **getDoubleArrayMemberValue(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of an 1D double array element +- **getDoubleArrayMemberValue(String, int[])** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of a double array element +- **getDoubleMemberValue(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
gets the value of a double member +- **getDoubleValue(int)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Gets an element as a double +- **getDoubleValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Gets an element as a double +- **getDownloadInputs()** - Method in class [com.phoenix_int.aserver.PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md)
retrieves whether the invocation should trigger a redownloading of input values +- **getDownloadInputs()** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **getDriver()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getElapsedTime()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
returns the wall clock time for this process, if available +- **getEncoding()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Get the encoding of the contents. +- **getEncoding()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **getEnd()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getEndCol()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getEndMark()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getEndOccurrence()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getEndOffset()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getEndParent()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getEndResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getEndRow()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getEnumAliases()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
An interface function for the enumeration array +- **getEnumAliases()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
An interface function for the enumeration array +- **getEnumAliases()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
An interface function for the enumeration array +- **getEnumAliases()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
An interface function for the enumeration array +- **getEnumAliases()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
An interface function for the enumeration array +- **getEnumAliases()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
An interface function for the enumeration array +- **getEnumAliases()** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
An interface function for the enumeration array +- **getEnumAliases()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get names/aliases for the enumerated type +- **getEnumAliasesStr()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
An interface function for the enumeration array +- **getEnumAliasesStr()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
An interface function for the enumeration array +- **getEnumAliasesStr()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
An interface function for the enumeration array +- **getEnumAliasesStr()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
An interface function for the enumeration array +- **getEnumAliasesStr()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
An interface function for the enumeration array +- **getEnumAliasesStr()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
An interface function for the enumeration array +- **getEnumAliasesStr()** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
An interface function for the enumeration array +- **getEnumTokens(String)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md) +- **getEnumValues()** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
lists enum values +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
An interface function for the enumeration array +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
An interface function for the enumeration array +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Interface function to pass out the enumeration array +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Interface function to pass out the enumeration array +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
An interface function for the enumeration array +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
lists enum values +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
lists enum values +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
lists enum values +- **getEnumValues()** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
An interface function for the enumeration array +- **getEnumValues()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get values for the enumerated type +- **getEnumValuesStr()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Interface function to pass out the enumeration array as a comma separated string +- **getEnumValuesStr()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Interface function to pass out the enumeration array as a comma separated string +- **getEnumValuesStr()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Interface function to pass out the enumeration array as a comma separated string +- **getEnumValuesStr()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Interface function to pass out the enumeration array as a comma separated string +- **getEnumValuesStr()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Interface function to pass out the enumeration array as a comma separated string +- **getEnumValuesStr()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Interface function to pass out the enumeration array as a comma separated string +- **getEnumValuesStr()** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
Interface function to pass out the enumeration array as a comma separated string +- **getEnvironment()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get component environment +- **getEnvironment()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get component environment +- **getErrorMessage()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Get the server error; only valid if response type is ServerError or ConnectionError. +- **getErrorStream()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **getEventType()** - Method in enum [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md) +- **getException()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClientExceptionEvent](com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md)
retrieves the Exception object +- **getExceptions()** - Method in exception [com.phoenix_int.aserver.util.PHXClassNotFoundException](com/phoenix_int/aserver/util/PHXClassNotFoundException.md) +- **getExecutable()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get name of component executable +- **getExecutable()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get name of component executable +- **getExecuteResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getFile(File, String, boolean)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get a file by property name. +- **getFileAsync(File, String, boolean, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Fetch the contents of a file by property name. +- **getFileExtension()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Returns the extension of the file that this object represents +- **getFileExtension(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Returns the extension of the file for an element of an 1D array +- **getFileExtension(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Returns the extension of the file for an element of an array +- **getFileFor(File, String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXFactory](com/phoenix_int/aserver/library/IPHXFactory.md)
Deprecated.
Returns a File object which points to the file on disk which contains the implementation of this component +- **getFileName(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
return name of the data source file +- **getFileName()** - Method in class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md)
retrieves the file name +- **getFileName()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
retrieves the name of the file that is being parsed +- **getFirst()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Returns the first element of the array, or throws ArrayIndexOutOfBounds + if there are no elements. +- **getFormat()** - Method in interface [com.phoenix_int.aserver.types.IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)
Get the format string for the variable +- **getFormat()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Get the format string for the variable +- **getFormat()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Get the format string for the variable +- **getFormat()** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
retrieves the format for the geometry data +- **getFormat()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Get the format string for the variable +- **getFormat()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Get the format string for the variable +- **getFormat()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Get the format string for the variable +- **getFormat()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get variable format string +- **getFullName()** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **getFullName()** - Method in class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md)
returns the full file name. +- **getFullNameCoded()** - Method in class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md)
returns the full file name in coded form, i.e. +- **getGetByUrlResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getGetComponentHistoryResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getGetHierarchyResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getGetIconResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getGetResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getGetResponse2(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getGreen()** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **getGroup(String)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves a child group. +- **getGroup(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a group. +- **getGroup2(String)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves a child group. +- **getGroup2(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a group. +- **getGroups()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves the Enumeration of subgroups in the group. +- **getGroups2()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves all the subgroups in the group +- **getHasCG()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getHasChanged()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
retrieves the hasChanged flag +- **getHasColor()** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **getHasFormat()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated in favor of [PHXInteger.hasFormat()](com/phoenix_int/aserver/types/PHXInteger.md#hasFormat--) +- **getHasFormat()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Deprecated in favor of [PHXLong.hasFormat()](com/phoenix_int/aserver/types/PHXLong.md#hasFormat--) +- **getHasIcon()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getHasLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
retrieves the hasLowerBound flag +- **getHasLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
retrieves the hasLowerBound flag +- **getHasLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
retrieves the hasLowerBound flag +- **getHasLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
retrieves the hasLowerBound flag +- **getHasLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
retrieves the hasLowerBound flag +- **getHasMass()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getHasRotation()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getHasSurfaceArea()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getHasTranslation()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getHasUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
retrieves the hasUpperBound flag +- **getHasUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
retrieves the hasUpperBound flag +- **getHasUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
retrieves the hasUpperBound flag +- **getHasUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
retrieves the hasUpperBound flag +- **getHasUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
retrieves the hasUpperBound flag +- **getHasVersionInfo()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getHasVolume()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getHelpUri()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get URI of help to use for component +- **getHelpUri()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get URI of help to use for component +- **getHelpURL()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getHierarchy(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrievethe hierarchy for the component +- **getHierarchy(String, PHXHierarchyFileMode)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the variable hierarchy of a running instance. +- **getHierarchyAsync(String, PHXHierarchyFileMode, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the variable hierarchy of a running instance. +- **getHost()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Get the host which sent the message. +- **getHostName()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves the host name of the server +- **getHostname()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Returns the currently-connected host, or null if none. +- **getIcon(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves an icon for an analysis +- **getIcon(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Retrieve an icon. +- **getIcon()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getIconAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Retrieve an icon. +- **getIconFileName()** - Method in class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md)
Gets the file name of the icon. +- **getIconURI()** - Method in class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md)
Gets the URI of the icon. +- **getIconUri()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get URI of icon to use for component +- **getIconUri()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get URI of icon to use for component +- **getID()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Get the unique identifier of the message. +- **getID()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Get the ID set on this file when the contents were set. +- **getIgnoreErrors()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Gets the "IgnoreErrors" flag +- **getInput()** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
retrieves an indicator of whether the ref prop is an input or an output. +- **getInput()** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
retrieves an indicator of whether the ref prop is an input or an output. +- **getInput()** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
retrieves an indicator of whether the ref prop is an input or an output. +- **getInputs()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get component inputs +- **getInputs()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get component inputs +- **getInputStream()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **getInputStream()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Returns an InputStream which can be read sequentially and contains the contents of the string. +- **getInstanceFiles()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get component instance files +- **getInstanceFiles()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get component instance files +- **getIntArrayMemberValue(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of an 1D integer array element +- **getIntArrayMemberValue(String, int[])** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of an integer array element +- **getInternalObject()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get internal Java object that represent the data +- **getIntMemberValue(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
gets the value of an integer member +- **getInvalidAssociation()** - Method in exception [com.phoenix_int.aserver.library.PHXNoSuchAssociationException](com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md)
retrieves the name that was invalid +- **getInvalidCategory()** - Method in exception [com.phoenix_int.aserver.library.PHXNoSuchCategoryException](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md)
retrieves the category name that was invalid +- **getInvalidIcon()** - Method in exception [com.phoenix_int.aserver.library.PHXNoSuchIconException](com/phoenix_int/aserver/library/PHXNoSuchIconException.md)
retrieves the name that was invalid +- **getInvalidID()** - Method in exception [com.phoenix_int.aserver.client.PHXNoSuchResponseException](com/phoenix_int/aserver/client/PHXNoSuchResponseException.md)
retrieves the id that didn't have a response +- **getInvalidID()** - Method in exception [com.phoenix_int.aserver.client.PHXResponseTypeMismatchException](com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md)
retrieves the id that didn't have a response +- **getInvalidObject()** - Method in exception [com.phoenix_int.aserver.PHXNoSuchObjectException](com/phoenix_int/aserver/PHXNoSuchObjectException.md)
retrieves the object name that was invalid +- **getInvokeResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getIsBinary()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Tells whether or not the the file is binary. +- **getIsBinary()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Tells whether or not the array contains binary files or not. +- **getIsBinary(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
return true if the file member contains a binary file +- **getJobID()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **getJobListener()** - Method in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md) +- **getJobNode()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **getKeywords()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getLength()** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
retrieves the number of references in the array +- **getLength()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the length of the first dimension of the array +- **getLength(int)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the length of a dimension of the array +- **getLine(int)** - Method in interface [com.phoenix_int.aserver.util.IPHXLineStore](com/phoenix_int/aserver/util/IPHXLineStore.md)
retrieves the specified line +- **getLineNumber()** - Method in class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md)
returns the line number of the last line read. +- **getLineStore()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Gets the underlying line store object for this parser +- **getListArrayValuesResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **getListCategoriesResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getListClassesResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getListMethodsResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getListPropertiesResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getListResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getListValuesResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **getLockResize()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **getLongValue(int)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Gets the value of an element as a long +- **getLongValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Gets the value of an element as a long +- **getLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
retrieves the current lower bound value +- **getLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
retrieves the current lower bound value +- **getLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
retrieves the current lower bound value +- **getLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
retrieves the current lower bound value +- **getLowerBound()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
retrieves the current lower bound value +- **getLowerBound()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get lower bound of variable; may be null +- **getMajor()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md)
Get the major version. +- **getMass()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getMassProperties()** - Method in class [com.phoenix_int.aserver.types.PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.md) +- **getMatrixArray(int, int, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets an array of tokens for the specified range. +- **getMatrixArray(int, int, int, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets an array of tokens for the specified range. +- **getMatrixArray2d(int, int, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets an array of tokens for the specified range. +- **getMax()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **getMax()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **getMemberDescription(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get description of the member +- **getMemberDimensions(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get dimensions and size of an array member +- **getMemberEnumAliases(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get enum aliases of the member +- **getMemberEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
return enum values of the member +- **getMemberLength(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get length of an array member +- **getMemberLength(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get length of an 1D array member +- **getMemberList(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get a list of child members. +- **getMemberLowerBound(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get lowerBound of a member +- **getMemberNumDimensions(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get number of dimensions of an array member +- **getMemberProperty(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get value of a property of the member +- **getMemberType(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
return type of the member +- **getMemberUnits(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get units of the member +- **getMemberUpperBound(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
return upperBound of the member +- **getMemberValueAsString(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
gets the value of a member as a string +- **getMemUsage()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Gets the memory usage of this process, if available +- **getMetaData()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get additional variable meta data +- **getMetaData()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Get additional variable meta data +- **getMethodDescriptor(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
find the Method Descriptor associated with a given name +- **getMethodDescriptors()** - Method in interface [com.phoenix_int.aserver.IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.md)
function for retrieving the methods of an object +- **getMethodDescriptors()** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a set of method descriptors for this object +- **getMethodList()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get a list of methods +- **getMimeType()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **getMimeType()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
get mime type of the files in the array.
Currently all elements of an array should have the same mime type. +- **getMin()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **getMin()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **getMinor()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md)
Get the minor version. +- **getMode()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Gets the runshare mode +- **getMonitor(String)** - Method in interface [com.phoenix_int.aserver.IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.md)
Gets a specified monitor. +- **getMonitor(String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Returns any available monitors by name. +- **getName()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Get the variable name. +- **getName()** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Gets the name of this branch +- **getName()** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Gets the version name +- **getName()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves the name of the group +- **getName()** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **getName()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
retrieves the property name +- **getName()** - Method in class [com.phoenix_int.aserver.PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md) +- **getName()** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
retrieves the name of the variable +- **getName()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
retrieves the name of the file +- **getName()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
retrieves the name of the file +- **getName(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
retrieves the name of the file for an element of an 1D array +- **getName(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
retrieves the name of the file for an element of an array +- **getName()** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
retrieves the name of the variable +- **getName()** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
retrieves the name of the variable +- **getName()** - Method in class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md) +- **getName()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **getName()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getName()** - Method in interface [com.phoenix_int.pacz.api.IInstanceFile](com/phoenix_int/pacz/api/IInstanceFile.md)
Deprecated.
Get name of instance file +- **getName()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get variable name +- **getName()** - Method in interface [com.phoenix_int.pacz.api.v2.IInstanceFile](com/phoenix_int/pacz/api/v2/IInstanceFile.md)
Get name of instance file +- **getNameCoded()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
retrieves the name of the file in coded form (without `$variables` replaced) +- **getNameCoded()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
retrieves the name of the file in coded form (without `$variables` replaced) +- **getNameCoded(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
retrieves the name of the file in coded form (without `$variables` replaced) for an element of an 1D array +- **getNameCoded(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
retrieves the name of the file in coded form (without `$variables` replaced) for an element of an array +- **getNamePart(String)** - Static method in class [com.phoenix_int.aserver.util.PHXNameDivider](com/phoenix_int/aserver/util/PHXNameDivider.md)
retrieves the name part from a full name +- **getNames()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
get file names of the elements as an array +- **getNamesCoded()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
get coded file names of the elements as an array +- **getNamesCodedString()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
get coded file names of the elements as a comma separated string +- **getNamesString()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
get file names as a comma separated list +- **getnDIndex(long, int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **getNumBranches()** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Gets the number of sub-branches +- **getNumDimensions(Object)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **getNumDimensions()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the number of dimensions of the array +- **getNumDimensions(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getNumDimensions()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getNumGroups()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves the number of subgroups in the group. +- **getNumLines()** - Method in interface [com.phoenix_int.aserver.util.IPHXLineStore](com/phoenix_int/aserver/util/IPHXLineStore.md)
gets the total number of lines +- **getNumVariables()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves the number of variables in the group. +- **getNumVersions()** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Returns how many versions there are in this branch +- **getOrientation()** - Method in class [com.phoenix_int.aserver.types.PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.md) +- **getOutputs()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get component outputs +- **getOutputs()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get component outputs +- **getOutputStream()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **getPageName()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md) +- **getPageName()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **getPageName()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getParent()** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Retrieves the parent version +- **getParent()** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Gets our parent branch +- **getParent()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getParentProcessID()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Gets the parent process ID of this process +- **getParser()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Get the XPath parser +- **getPath()** - Method in interface [com.phoenix_int.pacz.api.IInstanceFile](com/phoenix_int/pacz/api/IInstanceFile.md)
Deprecated.
Get path of instance file +- **getPath()** - Method in interface [com.phoenix_int.pacz.api.v2.IInstanceFile](com/phoenix_int/pacz/api/v2/IInstanceFile.md)
Get path of instance file +- **getPathPart(String)** - Static method in class [com.phoenix_int.aserver.util.PHXNameDivider](com/phoenix_int/aserver/util/PHXNameDivider.md)
retrieves the path part from a full name +- **getPercentCPU()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Gets the percentage of the CPU usage, if available +- **getPollDelay()** - Method in class [com.phoenix_int.aserver.monitors.PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md) +- **getProcess()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md)
Returns the java Process instance for this PHXProcess +- **getProcesses(int)** - Static method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Lists the specified process' children. +- **getProcesses()** - Static method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
lists all processes on the system +- **getProcessID()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md)
Returns the platform dependent process ID associated with this process. +- **getProcessID()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Gets the platform dependeng process ID number +- **getProperties()** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
retrieves the properties of the variable +- **getProperties()** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
get-set function for AServer +- **getProperties()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get additional component properties +- **getProperties()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get additional component properties +- **getPropertyDescriptors(String)** - Method in interface [com.phoenix_int.aserver.IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.md)
function for retrieving the properties of an object +- **getPropertyDescriptors(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a set of property descriptors for the variables managed by this object or one of its subobjects +- **getQueues(String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXlibrarian.md)
Deprecated.
gets the available run queues +- **getQueues(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
method for getting Queues from CenterLink, MCRE just returns blank string +- **getQueues(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
method for getting Queues from CenterLink, MCRE just returns blank string +- **getQueues(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
get the queues for the specified component. +- **getQueues(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
gets queues for the specified component. +- **getQueues(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
method for getting Queues from CenterLink, MCRE just returns blank string +- **getRange()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **getReader()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Returns a Reader which can be read sequentially and contains the contents of the string. +- **getRealFile(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Get the file on disk, possibly relative to the current run-share directory +- **getRed()** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **getRedirectURL()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getReference()** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
retrieves the current reference string. +- **getReference()** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
retrieves the current reference string. +- **getReference(int)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **getRefPropValueBoolean(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **getRefPropValueBoolean(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **getRefPropValueDouble(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
gets a value for a ref prop +- **getRefPropValueDouble(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
gets a value for a ref prop +- **getRefPropValueLong(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **getRefPropValueLong(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **getRefPropValueString(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **getRefPropValueString(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **getRemainder()** - Method in class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md)
returns the rest of the file as a string +- **getRemainder()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the remainder of the string (stuff not yet returned via `nextToken()`) +- **getRemainder2()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the remainder of the string (stuff not yet returned via `nextToken()`) +- **getReplacement(String)** - Method in interface [com.phoenix_int.aserver.util.IPHXStringReplacer](com/phoenix_int/aserver/util/IPHXStringReplacer.md)
replaces the specified string with some other value. +- **getRequiredFeatures()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get list of features required for component to execute +- **getRequiredFeatures()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get list of features required for component to execute +- **getRequirements()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md)
Get the comma separated list of unquoted requirements. +- **getResponse()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClientEvent](com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md)
retrieves the response +- **getResponse()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md)
Get the response, or null if it has not been received. +- **getResponseAsPHXStringBuffer(String, int, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a low-level response from the server in String format. +- **getResponseAsText(String, int, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a low-level response from the server in String format. +- **getResponseType()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Get the type of response. +- **getReturnString()** - Method in class [com.phoenix_int.aserver.PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md)
retrieves the return string for the custom method +- **getRootGroup()** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves the root group +- **getRotX()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getRotY()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getRotZ()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getRowArray(int, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets an array of tokens for the specified range. +- **getRowColString()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getRunDirectory()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Returns the current "run" directory, which is the same as getDirectory() unless run sharing is being used. +- **getRunFolderPreference()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get run folder preference for component +- **getRunFolderPreference()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get run folder preference for component +- **getRunShare()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Returns the PHXRunShareContext object used for process control and monitoring with this component +- **getRunShare2()** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.md)
Return the run share object +- **getScratchDirectory()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Request for the server's scratch directory. +- **getScratchDirectoryAsync(IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Request for the server's scratch directory. +- **getSelf()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **getSetByUrlResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getSetDictionaryResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getSetHierarchyResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getSetResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getShell()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Gets the shell used to execute commands. +- **getShell()** - Method in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md)
returns the shell used to run programs +- **getSource()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **getStart()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getStart(boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getStart()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **getStartCol()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getStartMark()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getStartOccurrence()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getStartOffset()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getStartResponse(String, boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
retrieves a response from the server +- **getStartRow()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **getString()** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
Gets the current contents of the stream +- **getStringArrayMemberValue(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of an 1D String array element +- **getStringArrayMemberValue(String, int[])** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get the value of a string array element +- **getStringData()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Get the string data; only valid if format is Normal or Extended. +- **getStringMemberValue(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
gets the value of string member +- **getStringValue(int)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
Gets a particular element as a String +- **getStringValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
Gets a particular element as a String +- **getSurfaceArea()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getSystemProperty(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Request for the server's system property. +- **getSystemPropertyAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Request for the server's system property. +- **getTemporaryFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Get the current temporary file; if _needRead is true this will load the contents from the actual file into the temporary. +- **getTemporaryFileHandle()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Get an additional reference to the temporary file containing the current value, or null if there is no temp file currently. +- **getTempScriptFileName()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **getTime()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Returns the amount of CPU time this process has used, in ???, if available. +- **getTimeStamp()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getTitle()** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
retrieves a title of the ref prop. +- **getTitle()** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
retrieves a title of the ref prop. +- **getTitle()** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
retrieves a title of the ref prop. +- **getToken(String, int, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets the token relative to a search string. +- **getToken(String, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets the token relative to a search string. +- **getToken(int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets the token at the specified row and field. +- **getToken(int, int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets the token at the specified row and column. +- **getToken(int, int, int, String)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
gets an array of tokens at the specified row and between start and end fields (all inclusive). Indexing starts at 1. +- **getTransX()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getTransY()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getTransZ()** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **getType()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Get the type of the variable. +- **getType()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
retrieves the type of the property as a string +- **getType()** - Method in class [com.phoenix_int.aserver.PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md) +- **getType()** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
retrieves the current type of the variable +- **getType()** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
retrieves the current type of the variable +- **getType()** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
retrieves the current type of the variable +- **getType()** - Method in class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md)
retrieves the type for the image +- **getType()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get variable data type +- **getType()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Get variable data type +- **getTypeClass()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
retrieves the type of the property as a Class object. +- **getUnits()** - Method in interface [com.phoenix_int.aserver.types.IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md)
Get the units string for the variable +- **getUnits()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
Get the units string for the variable +- **getUnits()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get variable units +- **getUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
retrieves the current upper bound value +- **getUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
retrieves the current upper bound value +- **getUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
retrieves the current upper bound value +- **getUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
retrieves the current upper bound value +- **getUpperBound()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
retrieves the current upper bound value +- **getUpperBound()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Get upper bound of variable; may be null +- **getUri()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the currently-connected URI, or null if none. +- **getUrl()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Get the URL of the variable, or null if none. +- **getURL()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Tells whether the file is meant to be transferred by proxy +- **getURLs()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
get URLs of the elements as an array +- **getURLsString()** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
get URLs of the elements as a comma separated string +- **getValue()** - Method in class [com.phoenix_int.aserver.client.PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.md) +- **getValue()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Get the value of the variable (null if URL). +- **getValue(String)** - Method in interface [com.phoenix_int.aserver.IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.md)
function for retrieving a specified value +- **getValue()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **getValue(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves the value for the appropriate variable +- **getValue()** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
retrieves the current value of the variable +- **getValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Gets the value of an element as a PHXBoolean object +- **getValue()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
retrieves the current value of the variable +- **getValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
gets an element as a PHXDouble object +- **getValue()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
retrieves the current value of the variable +- **getValue()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
retrieves the current value of the variable +- **getValue(int)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Gets the value of an element as a PHXLong object +- **getValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Gets the value of an element as a PHXLong object +- **getValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md)
Gets the value of an element as an object of the appropriate subtype.
Must be overridden in subclasses +- **getValue(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
a utility function to return the internal `PHXRawFile` that represents the array element for the 1D array. +- **getValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
a utility function to return the internal `PHXRawFile` that represents the array element for the array. +- **getValue()** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
retrieves the current value of the variable +- **getValue()** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
retrieves the current value of the variable +- **getValue(int)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets an element as PHXSimpleType object of the appropriate subtype +- **getValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the value of an element as an object of the appropriate subtype Must be overridden in subclasses +- **getValue()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
retrieves the current value of the variable +- **getValue(int[])** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
Gets a particular element as a PHXString +- **getValue2(String)** - Method in interface [com.phoenix_int.aserver.IPHXSelfManager2](com/phoenix_int/aserver/IPHXSelfManager2.md)
function for retrieving a specified value +- **getValue2()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **getValue2(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves the value for the appropriate variable +- **getValue3()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **getValues(int)** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
gets the value at an index +- **getValues()** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
retrieves the current value of the variable +- **getValueStr()** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
retrieves the string value of this variable as passed into the last call to `fromString()`. +- **getValueStr()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
retrieves the string value of this variable as passed into the last call to `fromString()`. +- **getValueStr()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
retrieves the string value of this variable as passed into the last call to `fromString()`. +- **getValueStr()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
retrieves the string value of this variable as passed into the last call to `fromString()`. +- **getValueStream()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Deprecated.
using toString2().getInputStream() is prefered. +- **getValueStreamLen()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Gets the length of a stream to the temporary file contents. +- **getVariable()** - Method in class [com.phoenix_int.aserver.PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md) +- **getVariable(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Returns a reference to the named variable. +- **getVariableClass(String)** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Returns the class associated with the type string. +- **getVariableFullName(Object)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
gets the name of a variable +- **getVariableInfo(String)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves a variable from the group. +- **getVariableInfo(Object)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
gets the information about a variable +- **getVariableInfo(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a variable information object from the manager +- **getVariableInfo(String, String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a variable information object from the manager +- **getVariableInfo2(String)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves a variable from the group. +- **getVariableInfo2(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a variable information object from the manager +- **getVariableInfo2(String, String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
retrieves a variable information object from the manager +- **getVariableName()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Get variable name +- **getVariables()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves the Enumeration of variables in the group. +- **getVariables2()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
retrieves all of the variables in the group. +- **getVarType(String)** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Given the class name, determine the corresponding type. +- **getVersion()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the MCRE version. +- **getVersion(int)** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Gets the i'th version +- **getVersion()** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **getVersion()** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Get component version +- **getVersion()** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Get component version +- **getVersionHistory(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the version history of an analysis. +- **getVersionHistoryAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Get the version history of an analysis. +- **getVersions()** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Returns an Iterator over the sub-versions +- **getVolume()** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **getWrapperID()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Returns the wrapper ID being used for locking. +- **getWriter()** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
Gets a java.io.Writer which when written to appends onto this monitor + +# H + +- **halt()** - Method in interface [com.phoenix_int.aserver.IPHXHaltableComponent](com/phoenix_int/aserver/IPHXHaltableComponent.md)
notifies the component to stop doing whatever it is currently doing. +- **halt()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
halts any running process +- **handleLogin(InputStream, OutputStream, String, String)** - Static method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **hasChanged()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated. checks to see if the file has changed since the last time `getContents()` was called +- **hasChanged()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Checks to see if the actual file has changed since the last time `getContents()` was called. +- **hasChanged(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
checks to see if the file has changed since the last time `getContents()` was called for an element of an 1D array +- **hasChanged(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
checks to see if the file has changed since the last time `getContents()` was called for an element of an array +- **hasFormat()** - Method in interface [com.phoenix_int.aserver.types.IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)
Whether or not the variable has a format +- **hasFormat()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Whether or not the variable has a format +- **hasFormat()** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Whether or not the variable has a format +- **hasFormat()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated. Whether or not the variable has a format +- **hasFormat()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Whether or not the variable has a format +- **hasFormat()** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
+- **hashCode()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md) +- **hasMember(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
check if a member exists +- **hasMemberLowerBound(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
check if a member has lower bound defined +- **hasMemberUpperBound(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
check if a member has lower bound defined +- **hasMoreElements()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the same value as the`hasMoreTokens`method. +- **hasMoreTokens()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Tests if there are more tokens available from this tokenizer's string. +- **hasText()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Does this response have actual string data (i.e. +- **HISTORY_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. + +# I + +- **IAnalysisServerCallback** - Interface in [com.phoenix_int.aserver.client.v2](com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md)
Callback for ModelCenter Remote Execution events. +- **IComponentConfig** - Interface in [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
see [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md) +- **IComponentConfig** - Interface in [com.phoenix_int.pacz.api.v2](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Configuration for PACZ file +- **IInstanceFile** - Interface in [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api/IInstanceFile.md)
Deprecated.
see [com.phoenix_int.pacz.api.v2.IInstanceFile](com/phoenix_int/pacz/api/v2/IInstanceFile.md) +- **IInstanceFile** - Interface in [com.phoenix_int.pacz.api.v2](com/phoenix_int/pacz/api/v2/IInstanceFile.md)
Instance file within a component +- **incrementIndex(int[], int[])** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Utility function for incrementing an nD index on the array +- **indexOf(char)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Searches for a given character and returns the index to that character, or -1 if not found +- **indexOf(char, int)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md) +- **indexOf(char, long)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Searches for a given character and returns the index to that character, or -1 if not found +- **indexOf(String, int)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md) +- **indexOf(String, long)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md) +- **initialize(PHXConnection, IPHXFactory, PHXAServerArgs, Node)** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated.
Tells this librarian to configure itself based on the XML node passed in. +- **initialize(PHXConnection, IPHXFactory, PHXAServerArgs, Node)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
There are 2 options for this class. +- **initialize(PHXConnection, IPHXFactory, PHXAServerArgs, Node)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
There is only 1 option for this class, "analysesPath" which must be a single directory that exists on the local system. +- **initialize(PHXConnection, IPHXFactory, PHXAServerArgs, Node)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
The XML initialization information for this class is simply a list of `` tags which contain `` and `` tags inside. +- **initialize(PHXConnection, IPHXFactory, PHXAServerArgs, Node)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
The XML initialization information for this class is simply a list of `` tags which contain ``, ``, and `` tags inside. +- **initialize(PHXConnection, IPHXFactory, PHXAServerArgs, Node)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
There are 2 options for this class. +- **initialize(String, boolean, Object)** - Method in class [com.phoenix_int.aserver.PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md)
initializes the variable +- **initialize(PHXDataObjectClass)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
initialize object variable with the specified class +- **initializeIterations()** - Method in interface [com.phoenix_int.aserver.IPHXDriver](com/phoenix_int/aserver/IPHXDriver.md)
initializes the driver to a starting state. +- **InputFile** - Interface in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md)
Interface for input files (not file variables) used in script-wrappers +- **insertVersion(PHXComponentVersion, int)** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Inserts a version to this branch at a particular location +- **instantiate(File, String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXFactory](com/phoenix_int/aserver/library/IPHXFactory.md)
Deprecated.
It is preferred to use`IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)`as this method can lead to resource leaks. +- **instantiate(String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated. +- **instantiate(String, String, String, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated. +- **instantiate(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
creates an instance of the specified component. +- **instantiate(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
creates an instance of the specified component. +- **instantiate(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
creates an instance of the specified component. +- **instantiate(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
creates an instance of the specified component. +- **instantiate(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
creates an instance of the specified component. +- **instantiate(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)** +- **instantiate(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
creates an instance of the specified component. +- **instantiate(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)** +- **instantiate(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
creates an instance of the specified component. +- **instantiate(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
creates an instance of the specified component. +- **instantiateManaged(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String, String, String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
Creates an instance of the specified component. +- **instantiateManaged(String, String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
Creates an instance of the specified component. +- **invoke(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
invokes a method +- **invoke(String, String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Invoke a method on a component instance. +- **invoke(String)** - Method in interface [com.phoenix_int.aserver.IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.md)
invokes the named method +- **invoke(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
Invokes a named method. +- **invoke2(String)** - Method in interface [com.phoenix_int.aserver.IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.md)
invokes the named method +- **invoke2(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
Invokes a named method. +- **INVOKE_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **invokeAsync(String, String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Invoke a method on a component instance. +- **IPHXAlwaysWriteable** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXAlwaysWriteable.md)
This is a specialized interface for ModelCenter Remote Execution. +- **IPHXAnalysis** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXAnalysis.md)
This is the interface that analyses managed by ModelCenter Remote Execution must implement. +- **IPHXAnalysisClientListener** - Interface in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md)
This interface is used by the PHXAnalysisClient class. +- **IPHXComponent** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXComponent.md)
This is a common base interface for things served on ModelCenter Remote Execution. +- **IPHXDescription** - Interface in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/IPHXDescription.md)
Interface for types with descriptions +- **IPHXDriver** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXDriver.md)
this is the interface that drivers managed by ModelCenter Remote Execution must implement. +- **IPHXFactory** - Interface in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/IPHXFactory.md)
Deprecated.
It is preferred to use`IPHXFactory2`, as this class has methods that can leak resources +- **IPHXFileCallback** - Interface in [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/IPHXFileCallback.md)
Callback interface to signal data available on a file being monitored. +- **IPHXFormat** - Interface in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/IPHXFormat.md)
Interface for variables that support formats +- **IPHXHaltableComponent** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXHaltableComponent.md)
This is a specialized interface for ModelCenter Remote Execution. +- **IPHXLibrarian** - Interface in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated.
It is preferred to use`IPHXLibrarian2`as this class uses methods that can leak resources. +- **IPHXLineStore** - Interface in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/IPHXLineStore.md)
This is the interface for holding a set of lines. +- **IPHXMonitorable** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXMonitorable.md)
this is the interface that analyses which provide information about running processes should implement +- **IPHXRange** - Interface in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md) +- **IPHXRangeChangeListener** - Interface in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md) +- **IPHXRefPropInfo** - Interface in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
This interface provides information about a reference property:**name**: String**type**: String**enumValues**: String[]**description**: String**title**: String**input**: boolean where `type` may be any of the following: "long", "double", "boolean", "string" +- **IPHXRunQueue** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXRunQueue.md) +- **IPHXSelfManager** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXSelfManager.md)
This interface is for components that determine their properties at runtime. +- **IPHXSelfManager2** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXSelfManager2.md)
This interface extends IPHXSelfManager and provides new get and set functions which provide better performance than + the original. +- **IPHXSelfManager3** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXSelfManager3.md)
This interface extends IPHXSelfManager2 and provides new invoke that enables getting more information back from invoked methods. +- **IPHXSetupFromFile** - Interface in [com.phoenix_int.aserver](com/phoenix_int/aserver/IPHXSetupFromFile.md)
This interface is used by association-based analysis objects. +- **IPHXStringReplacer** - Interface in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/IPHXStringReplacer.md)
This is the interface for a replacing strings, used by the `PHXStringReplacer` class +- **IPHXType** - Interface in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/IPHXType.md)
The interface for all Phoenix types. +- **IPHXType2** - Interface in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/IPHXType2.md)
The interface for Phoenix types which use `PHXStringBuffer` instead of String for performance. +- **IPHXType2.IVisitor``** - Interface in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/IPHXType2.md)
The interface of a visitor into an IPHXType2. +- **IPHXUnits** - Interface in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/IPHXUnits.md)
Interface for PHX variables that support units +- **IPHXVersionedLibrarian** - Interface in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md)
Deprecated.
It is preferred to use `IPHXVersionedLibrarian3` as this class has methods that can leak resources +- **IPHXVersionedLibrarian2** - Interface in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md)
Deprecated.
It is preferred to use `IPHXVersionedLibrarian3` as this class supports methods that can cause file leaks. +- **IRuntimeVariable** - Interface in [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
see [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) +- **IRuntimeVariable** - Interface in [com.phoenix_int.pacz.api.v2](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Component variable interface +- **isArray()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **isArray()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Whether or not variable is an array type +- **isArray()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Whether or not variable is an array type +- **isBinary()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Is this a response with binary data? +- **isBinary()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Get whether this is binary data. +- **isColArray()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **isConnected()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
determines if the client is currently connected to a server +- **isConnected()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Is the server connected? +- **isEnum()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Whether or not variable is an enumerated type +- **isEnum()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Whether or not variable is an enumerated type +- **isError()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Does the response represent an error? +- **isHorizontallyResizable()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **isInput()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md)
Get whether this is an input. +- **isInput()** - Method in class [com.phoenix_int.aserver.PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md) +- **isNonStrictType()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
check whether a class is a non-strict type +- **isNumeric()** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Whether or not variable is a numeric type +- **isNumeric()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Whether or not variable is a numeric type +- **isResponseReady(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
indicates whether a response is ready +- **isRowArray()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **isSuccess()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Is the response a successful response? +- **isText()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md)
Does the response have text content? +- **iterator()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Returns an iterator that loops over the array in the standard PHX order, rightmost index varies fastest. + +# L + +- **LAST** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **length()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Returns the actual length of the string held by this buffer object. +- **length()** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **list()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
lists the running objects +- **LIST_ARRAY_VALUES_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **LIST_CATEGORIES_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **LIST_CLASSES_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **LIST_METHODS_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **LIST_PROPERTIES_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **LIST_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **LIST_VALUES_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **LIST_VALUES_URL_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **listAnalyses(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the analyses on the server. +- **listAnalysesAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the analyses on the server. +- **listArrayValues(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **listCategories(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
lists the categories within a category +- **listClasses(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
lists the classes within a category +- **listComponents(File, String)** - Method in interface [com.phoenix_int.aserver.library.IPHXFactory](com/phoenix_int/aserver/library/IPHXFactory.md)
Deprecated.
List out all of the identifiers (historically "class" names) for a given directory as a collection of strings. +- **listComponents(String)** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated.
lists components within a specified directory +- **listComponents(String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
returns the components in a specific directory +- **listComponents(String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
returns the components in a specific directory +- **listComponents(String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
returns the components in a specific directory +- **listComponents(String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
returns the components in a specific directory +- **listComponents(String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
returns the components in a specific directory +- **listDirectories(String)** - Method in interface [com.phoenix_int.aserver.library.IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md)
Deprecated.
lists any available sub-directories from a particular directory +- **listDirectories(String)** - Method in class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
Lists available sub-directories for the specified path +- **listDirectories(String)** - Method in class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
Lists available sub-directories for the specified path +- **listDirectories(String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
Returns sub-directories from a specified directory +- **listDirectories(String)** - Method in class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md) +- **listDirectories(String)** - Method in class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md) +- **listFolders(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the sub-folders of a folder on the server. +- **listFoldersAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the sub-folders of a folder on the server. +- **listInstances()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List running instances on the server. +- **listInstancesAsync(IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List running instances on the server. +- **listMethods(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
lists the methods of an analysis +- **listMethods(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the methods of an analysis. +- **listMethodsAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the methods of an analysis. +- **listMonitorableFiles()** - Method in interface [com.phoenix_int.aserver.IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.md)
Lists all items that may be monitored for output as a component is running. +- **listMonitorableFiles()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Lists available "monitors". +- **listProcesses()** - Method in interface [com.phoenix_int.aserver.IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.md)
Lists all the running processes associated with a component +- **listProcesses()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Lists any running processes +- **listProcesses()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md)
This function lists all the processes and sub-processes of this PHXProcess. +- **listProperties(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
lists the properties of an analysis +- **listProperties(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the properties of an analysis. +- **listPropertiesAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the properties of an analysis. +- **listValues(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **listValues(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the values of an analysis. +- **listValuesAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
List the values of an analysis. +- **loadSetup(String)** - Method in interface [com.phoenix_int.aserver.IPHXSetupFromFile](com/phoenix_int/aserver/IPHXSetupFromFile.md)
sets up the object from a file +- **lock()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Causes the run-share mode to be implemented. +- **lockDimensions()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Tells this array that the number of dimensions cannot be changed from what they are right now. +- **LONG** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a long type +- **LONG_ARRAY** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a long array type + +# M + +- **main(String[])** - Static method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
+- **main(String[])** - Static method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md) +- **main(String[])** - Static method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **main(String[])** - Static method in class [com.phoenix_int.aserver.util.PHXNameDivider](com/phoenix_int/aserver/util/PHXNameDivider.md) +- **main(String[])** - Static method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md) +- **main(String[])** - Static method in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md) +- **main(String[])** - Static method in class [com.phoenix_int.aserver.util.PHXStringReplacer](com/phoenix_int/aserver/util/PHXStringReplacer.md) +- **main(String[])** - Static method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md) +- **makeGroup(String)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
creates a child group. +- **makeGroup(String)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
creates a group. +- **markAsBeginning(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Searches for the specified string and makes the row where the string was found act as row 1 for all subsequent calls until another `markAsBeginning` or `clearMarks` call. +- **markAsBeginning(String, int, int, boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Searches for the specified string and makes the row where the string was found act as row 1 for all subsequent calls until another `markAsBeginning` or `clearMarks` call. +- **markAsBeginning(int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Makes the specified row act as row 1 for all subsequent calls until another `markAsBeginning` or `clearMarks` call. +- **markAsEnd(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Searches for the specified string, starting from the end of the file and working towards the beginning, and makes the row where the string was found act as row -1 (end of file) for all subsequent calls until another `markAsEnd` or `clearMarks` call. +- **markAsEnd(String, int, int, boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Searches for the specified string and makes the row where the string was found act as row -1 (end of file) for all subsequent calls until another `markAsEnd` or `clearMarks` call. +- **markAsEnd(int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Makes the specified row act as row -1 (end of file) for all subsequent calls until another `markAsBeginning` or `clearMarks` call. +- **markAsRead()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
call this function after you manually get the contents of the file. +- **markAsRead()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Call this function after you manually get the contents of the actual file. +- **markAsRead(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
set markAsRead flag for an element for an 1D array call this function after you manually get the contents of the file. +- **markAsRead(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
set markAsRead flag for an element for an array call this function after you manually get the contents of the file. +- **markBeginning(int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the starting point from which to start counting rows and fields. +- **markBeginning(String, boolean)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
same as markBeginning with an occurrence value of 1 +- **markBeginning(String)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
same as markBeginning where the pattern is a regex and ocurence value is 1 +- **markBeginning(String, boolean, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the starting point from which to start counting rows and fields. +- **markBeginning(String, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the starting point from which to start counting rows and fields. +- **markBeginningFromEnd(String, boolean)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the starting point from which to start counting rows. +- **markBeginningOffset(int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the starting point from which to start counting rows and fields. +- **markEnd(int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the ending point of the file. +- **markEnd(String, boolean)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
same as markEnd with an occurrence value of 1 +- **markEnd(String, boolean, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the ending point from which to start counting rows and fields. +- **markEnd(String, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the ending point from which to start counting rows and fields. +- **markEndFromEnd(String, boolean)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the starting point from which to start counting rows and fields. +- **markEndOffset(int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
marks the ending point from which to start counting rows and fields. +- **matchFound(int, Pattern, String, MatchResult)** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **mode** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **MODE_ERROR** - Static variable in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
When a user tries to run a component that is already running, this option generates an error message and instructs the user to try again later. +- **MODE_NONE** - Static variable in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
This option performs no run sharing. +- **MODE_SHARE** - Static variable in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
When two or more users attempt to run a component simultaneously, the FileWrapper creates separate directories that hold unique input and output files for every user. +- **MODE_WAIT** - Static variable in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
When the component is running, this option ensures that no one else will be able to run it. + +# N + +- **NAME_SEPARATOR** - Static variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **NAME_SEPARATOR** - Static variable in class com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **newIndex()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Produces a new index based zeroed out, but with the proper dimensions +- **newLineStore(File)** - Method in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser/Mode.md) +- **newLineStore(File, PHXFileUtils.Encoding)** - Method in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser/Mode.md) +- **newLineStore(File, PHXFileUtils.Encoding, IProgressListener)** - Method in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser/Mode.md)
Create a new line store consistent with the file-access mode +- **newParser(File, Parser.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Generate a new parser for the given file and mode +- **newParser(File, Parser.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) +- **newParser(File, Parser.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Generate a new parser for the given file and mode +- **newParser(File, Parser.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Generate a new parser for the given file and mode +- **newParser(File)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Allow a sub-class to form a parser using custom options/features, such as handling DTD and entities +- **nextElement()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the same value as the `nextToken` method, except that its declared return value is `Object` rather than `String`. +- **nextLine()** - Method in class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md)
extracts the next non-comment line from the data file +- **nextToken()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the next token from this string tokenizer. +- **nextToken(String)** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the next token in this string tokenizer's string. +- **nextToken2()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the next token from this string tokenizer. +- **nextToken2(boolean)** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the next token from this string tokenizer. +- **nextToken2(String)** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Returns the next token in this string tokenizer's string. + +# O + +- **OBJECT** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for an object type +- **onException(PHXAnalysisClientExceptionEvent)** - Method in interface [com.phoenix_int.aserver.client.IPHXAnalysisClientListener](com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md)
called each time an exception occurs while reading from the connection to ModelCenter Remote Execution. +- **onRangesChanged(Object, Vector``, Vector``)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRangeChangeListener](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md) +- **onResponse(PHXAnalysisClientEvent)** - Method in interface [com.phoenix_int.aserver.client.IPHXAnalysisClientListener](com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md)
called each time a new response is received from ModelCenter Remote Execution. +- **OutputFile** - Interface in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api.md)
Deprecated in favor of [OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md) +- **OutputFile2** - Interface in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api.md)
Interface for output files (not file variables) used in script-wrappers +- **owner** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **owner** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md)
+ + +# P + +- **parse(Object)** - Static method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
a utility function to convert a string to a boolean value +- **parse()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) +- **parse()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md)
Deprecated.
Parse the output file +- **parse()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)
Parse the output file +- **PARSE** - Static variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Deprecated in favor of [ParseableFile.Mode.PARSE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#PARSE) +- **parse()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Parse the output file +- **parse()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Parse the output file +- **ParseableFile** - Interface in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)
Interface for files (not file variables) used in script wrappers +- **ParseableFile.Mode** - Enum in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md)
File mode. Moved to type-safe enum from legacy integer constants +- **parseFile(String, String, boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Read the given file variable from the specified file +- **parseIndex(String)** - Static method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Takes a string of the form "anything[n, n2, n3]" or "n, n2, n3" and returns an int[] of the index values. +- **Parser** - Interface in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/Parser.md)
Interface to define the methods of a parser. +- **parser** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **Parser.Mode** - Enum in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/Parser.Mode.md)
File-access mode. Moved to type-safe enum from legacy integer constants +- **PHXAnalysisClient** - Class in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Use[AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md) instead. +- **PHXAnalysisClient()** - Constructor for class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **PHXAnalysisClient(String)** - Constructor for class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
creates a client to the ModelCenter Remote Execution and connects + it to the specified host +- **PHXAnalysisClient(String, int)** - Constructor for class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
creates a client to the MCRE and connects + it to the specified host +- **PHXAnalysisClient(String, int, int)** - Constructor for class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
creates a client to the MCRE and connects + it to the specified host +- **PHXAnalysisClient(String, int, String, String)** - Constructor for class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
creates a client to the MCRE and connects + it to the specified host +- **PHXAnalysisClientEvent** - Class in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md)
this class is an event for the PHXAnalysisClient class. +- **PHXAnalysisClientExceptionEvent** - Class in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md)
this class is an event for the PHXAnalysisClient class. +- **PHXAppearance** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXAppearance.md)
This is a utility class for holding appearance properties. +- **PHXAppearance(boolean)** - Constructor for class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **PHXBlocker** - Class in [com.phoenix_int.util](com/phoenix_int/util/PHXBlocker.md)
Class to simplify wait and notify calls. +- **PHXBlocker()** - Constructor for class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md) +- **PHXBookmark** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **PHXBookmark(String, PHXRowFieldRange)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md)
Constructor +- **PHXBookmarkNotFoundException** - Exception in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md) +- **PHXBookmarkNotFoundException(String)** - Constructor for exception [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmarkNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md) +- **PHXBoolean** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXBoolean.md)
The Phoenix type for booleans. +- **PHXBoolean()** - Constructor for class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
initializes value to false +- **PHXBoolean(boolean)** - Constructor for class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
Initializes the value to the specified value. +- **PHXBoolean(PHXBoolean)** - Constructor for class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
Clone another PHXBoolean's value and metadata. +- **PHXBooleanArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Class wraps an array of PHXBoolean variables + for the ScriptWrapper utility. +- **PHXBooleanArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md) +- **PHXBooleanArray(Object)** - Constructor for class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md) +- **PHXBooleanArray(PHXBooleanArray)** - Constructor for class [com.phoenix_int.aserver.types.PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md)
Clone another PHXBooleanArray's value and metadata. +- **PHXCAERange** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **PHXCAERange()** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **PHXCAERange(String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **PHXCAERange(String, String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **PHXClassNotFoundException** - Exception in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXClassNotFoundException.md)
Simple wrapper for ClassNotFoundException which can contain additional + logging info. +- **PHXClassNotFoundException()** - Constructor for exception [com.phoenix_int.aserver.util.PHXClassNotFoundException](com/phoenix_int/aserver/util/PHXClassNotFoundException.md)
Creates a new instance of PHXClassNotFoundException +- **PHXClassNotFoundException(String)** - Constructor for exception [com.phoenix_int.aserver.util.PHXClassNotFoundException](com/phoenix_int/aserver/util/PHXClassNotFoundException.md) +- **PHXComponentBranch** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXComponentBranch.md)
This class represents a branch on a revision history tree for a version controlled component. +- **PHXComponentBranch()** - Constructor for class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Constructs an empty branch +- **PHXComponentBranch(String)** - Constructor for class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Constructs an empty named branch +- **PHXComponentBranch(Element)** - Constructor for class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Constructs a branch based on an XML branch node +- **PHXComponentDescription** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXComponentDescription.md)
A class for holding description information about an component class. +- **PHXComponentDescription()** - Constructor for class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **PHXComponentVersion** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXComponentVersion.md)
This class represents a version on a revision history tree for a version controlled component. +- **PHXComponentVersion(String)** - Constructor for class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Constructs a version with a given name +- **PHXComponentVersion(String, String, String, Date)** - Constructor for class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Constructs a version with the specified meta data +- **PHXComponentVersion(Element)** - Constructor for class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Constructs a version based on information In an XML Element +- **PHXCVSLibrarian** - Class in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXCVSLibrarian.md)
Implementation of IPHXLibrarian which loads files out of CVS. +- **PHXCVSLibrarian()** - Constructor for class [com.phoenix_int.aserver.library.PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md) +- **PHXDataCollector** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXDataCollector.md)
A class for Driver Components to tell ModelCenter what to do with the + DataCollector while the component is running. +- **PHXDataCollector()** - Constructor for class [com.phoenix_int.aserver.types.PHXDataCollector](com/phoenix_int/aserver/types/PHXDataCollector.md) +- **PHXDFTException** - Exception in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXDFTException.md) +- **PHXDFTException(String)** - Constructor for exception [com.phoenix_int.aserver.PHXDFTException](com/phoenix_int/aserver/PHXDFTException.md) +- **PHXDirectoryLibrarian** - Class in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md)
This librarian provides a window into a directory on disk that contains wrapper and component files. +- **PHXDirectoryLibrarian()** - Constructor for class [com.phoenix_int.aserver.library.PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md) +- **PHXDouble** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXDouble.md)
The Phoenix type for doubles. +- **PHXDouble()** - Constructor for class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
initializes value to zero without upper or lower bounds +- **PHXDouble(double)** - Constructor for class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Initializes value to specified value without upper or lower bounds. +- **PHXDouble(PHXDouble)** - Constructor for class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Clone another PHXDouble's value and metadata. +- **PHXDoubleArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Class wraps an array of PHXDouble variables + for the ScriptWrapper utility. +- **PHXDoubleArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **PHXDoubleArray(Object)** - Constructor for class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **PHXDoubleArray(PHXDoubleArray)** - Constructor for class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Clone another PHXDoubleArray's value and metadata. +- **PHXFile** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated. +- **PHXFile()** - Constructor for class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated. +- **PHXFile(String)** - Constructor for class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated. +- **PHXFile(String, String)** - Constructor for class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated. +- **PHXFile(PHXFile)** - Constructor for class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
Clone another PHXFile's value and metadata. +- **PHXFileLoader** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXFileLoader.md)
This is a utility class for loading data files. +- **PHXFileLoader(String)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md) +- **PHXFileLoader(File)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md) +- **PHXFileLoader(StringReader)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md) +- **PHXFileLoader(InputStream)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md) +- **PHXFileMonitor** - Class in [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/PHXFileMonitor.md)
This class monitors a File for data by polling. +- **PHXFileMonitor(String, IPHXFileCallback)** - Constructor for class [com.phoenix_int.aserver.monitors.PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md)
Create a monitor +- **PHXFileMonitor(PHXRawFile, IPHXFileCallback)** - Constructor for class [com.phoenix_int.aserver.monitors.PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md) +- **PHXFileMonitor.FileMonitorChangeException** - Exception in [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md) +- **PHXFileName** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXFileName.md)
this is a utility class for easily managing file names. +- **PHXFileName()** - Constructor for class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md) +- **PHXFileName(String, String)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md) +- **PHXFileParser** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXFileParser.md)
This is a utility class for loading data files and extracting data. +- **PHXFileParser(String)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **PHXFileParser(String, PHXFileUtils.Encoding)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **PHXFileParser(File, Parser.Mode)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **PHXFileParser(File, Parser.Mode, PHXFileUtils.Encoding)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **PHXFileParser(String, Parser.Mode)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **PHXFileParser(String, Parser.Mode, PHXFileUtils.Encoding)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **PHXFileParser(String, int)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Deprecated in favor of [PHXFileParser.PHXFileParser(String, Parser.Mode)](com/phoenix_int/aserver/util/PHXFileParser.md#PHXFileParser-java.lang.String-com.phoenix_int.aserver.util.Parser.Mode-) +- **PHXFileParser(IPHXLineStore, String)** - Constructor for class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **PHXGeometry** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXGeometry.md)
The Phoenix type for geometry. +- **PHXGeometry()** - Constructor for class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md) +- **PHXGeometry(PHXGeometry)** - Constructor for class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
Clone another PHXGeometry's value and metadata. +- **PHXGeomInfo** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXGeomInfo.md)
this is a utility class that mirrors the structures in ModelCenter. +- **PHXGeomInfo()** - Constructor for class [com.phoenix_int.aserver.types.PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.md) +- **PHXGeomInfo(boolean, boolean, boolean, boolean, boolean, boolean, boolean)** - Constructor for class [com.phoenix_int.aserver.types.PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.md) +- **PHXGetByUrlException** - Exception in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXGetByUrlException.md)
An exception that is thrown when encountering an error getting a file's contents via url +- **PHXGetByUrlException(String)** - Constructor for exception [com.phoenix_int.aserver.util.PHXGetByUrlException](com/phoenix_int/aserver/util/PHXGetByUrlException.md)
Constructor. +- **PHXGetByUrlException(String, Throwable)** - Constructor for exception [com.phoenix_int.aserver.util.PHXGetByUrlException](com/phoenix_int/aserver/util/PHXGetByUrlException.md)
Constructor. +- **PHXGroup** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXGroup.md)
A utility class for holding sub-variables. +- **PHXGroup(String)** - Constructor for class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md) +- **PHXIcon** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXIcon.md)
This class provides utility functions for loading and creating an icon file +- **PHXIcon()** - Constructor for class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md)
creates an icon with values set to "unknown" +- **PHXIcon(String)** - Constructor for class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md) +- **PHXIcon(byte[], String)** - Constructor for class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md) +- **PHXInteger** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated. +- **PHXInteger()** - Constructor for class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated. +- **PHXInteger(PHXInteger)** - Constructor for class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Clone another PHXInteger's value and metadata. +- **PHXInternationalize** - Class in [com.phoenix_int.util](com/phoenix_int/util/PHXInternationalize.md)
Helper class to do internationalization. +- **PHXInternationalize(Class)** - Constructor for class [com.phoenix_int.util.PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md) +- **PHXInternationalize(Object)** - Constructor for class [com.phoenix_int.util.PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md)
Creates a new instance of PHXInternationalize +- **PHXInternationalize.InternationalizedMessage** - Interface in [com.phoenix_int.util](com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md)
Interface for a lazily computed translation message. +- **PHXInvalidNameException** - Exception in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXInvalidNameException.md)
An exception that is thrown when trying to create a new object using an invalid name +- **PHXInvalidNameException(String)** - Constructor for exception [com.phoenix_int.aserver.PHXInvalidNameException](com/phoenix_int/aserver/PHXInvalidNameException.md) +- **PHXInvalidTypeException** - Exception in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXInvalidTypeException.md)
An exception that is thrown when trying to use a bad type +- **PHXInvalidTypeException(String)** - Constructor for exception [com.phoenix_int.aserver.types.PHXInvalidTypeException](com/phoenix_int/aserver/types/PHXInvalidTypeException.md)
Create an invalid type exception +- **PHXInvalidTypeException(String, Throwable)** - Constructor for exception [com.phoenix_int.aserver.types.PHXInvalidTypeException](com/phoenix_int/aserver/types/PHXInvalidTypeException.md)
Create an invalid type exception with a cause +- **PHXInvokeReturn** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXInvokeReturn.md)
A utility class for holding reutrn information from an invoked function. +- **PHXInvokeReturn()** - Constructor for class [com.phoenix_int.aserver.PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md) +- **PHXLibrarianCombiner** - Class in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md)
This class combines several sub-librarians, adding dir lists and component lists together. +- **PHXLibrarianCombiner()** - Constructor for class [com.phoenix_int.aserver.library.PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md) +- **PHXLibrarianMounter** - Class in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXLibrarianMounter.md)
This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be "mounted" very similarly to the UNIX concept of mounting filesystems. +- **PHXLibrarianMounter()** - Constructor for class [com.phoenix_int.aserver.library.PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md) +- **PHXLong** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXLong.md)
The Phoenix type for longs. +- **PHXLong()** - Constructor for class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Initializes value to 0. +- **PHXLong(long)** - Constructor for class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Initializes value to the specified value +- **PHXLong(PHXLong)** - Constructor for class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Clone another PHXLong's value and metadata. +- **PHXLongArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXLongArray.md)
Class wraps an array of PHXLong variables for the ScriptWrapper utility. +- **PHXLongArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **PHXLongArray(Object)** - Constructor for class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **PHXLongArray(PHXLongArray)** - Constructor for class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Clone another PHXLongArray's value and metadata. +- **PHXMassProperties** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXMassProperties.md)
This is a utility class for holding mass property information. +- **PHXMassProperties(boolean, boolean, boolean, boolean)** - Constructor for class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **PHXMethodDescriptor** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXMethodDescriptor.md)
A utility class used by PHXSelfManager to indicate which methods it can invoke. +- **PHXMethodDescriptor()** - Constructor for class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **PHXMethodDescriptor(String)** - Constructor for class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **PHXMethodDescriptor(String, String)** - Constructor for class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **PHXMethodDescriptor(String, String, boolean)** - Constructor for class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **PHXMonitorableStream** - Class in [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
This class represents a stream of data which may be monitored by a client which supports progress monitors. +- **PHXMonitorableStream()** - Constructor for class [com.phoenix_int.aserver.monitors.PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
Default Constructor +- **PHXMonitorableStream.MonitorWriter** - Class in [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md) +- **PHXNameAlreadyInUseException** - Exception in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXNameAlreadyInUseException.md)
An exception that is thrown when trying to create a new object with a name that already exists. +- **PHXNameAlreadyInUseException(String)** - Constructor for exception [com.phoenix_int.aserver.PHXNameAlreadyInUseException](com/phoenix_int/aserver/PHXNameAlreadyInUseException.md) +- **PHXNameDivider** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXNameDivider.md)
this is a utility class for breaking down names into smaller parts. +- **PHXNameDivider()** - Constructor for class [com.phoenix_int.aserver.util.PHXNameDivider](com/phoenix_int/aserver/util/PHXNameDivider.md) +- **PHXNewLineAddFilter** - Class in [com.phoenix_int.util](com/phoenix_int/util/PHXNewLineAddFilter.md)
Implementation of a FilterReader that basically does the opposite of the `PHXNewLineFilter`, adding in the platform dependent newlines from java style newlines '\n'. +- **PHXNewLineAddFilter(Reader)** - Constructor for class [com.phoenix_int.util.PHXNewLineAddFilter](com/phoenix_int/util/PHXNewLineAddFilter.md)
Creates a new instance of PHXNewLineFilter +- **PHXNewLineFilter** - Class in [com.phoenix_int.util](com/phoenix_int/util/PHXNewLineFilter.md)
Implementation of a FilterReader that processes out newlines into Java style newlines '\n' with the same logic as `BufferedReader.readLine()` +- **PHXNewLineFilter(Reader)** - Constructor for class [com.phoenix_int.util.PHXNewLineFilter](com/phoenix_int/util/PHXNewLineFilter.md)
Creates a new instance of PHXNewLineFilter +- **PHXNoSuchAssociationException** - Exception in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md)
An exception that is thrown when an invalid association is specified. +- **PHXNoSuchAssociationException(String)** - Constructor for exception [com.phoenix_int.aserver.library.PHXNoSuchAssociationException](com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md) +- **PHXNoSuchCategoryException** - Exception in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md)
An exception that is thrown when an invalid class category is specified. +- **PHXNoSuchCategoryException(String)** - Constructor for exception [com.phoenix_int.aserver.library.PHXNoSuchCategoryException](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md) +- **PHXNoSuchCategoryException(String, String)** - Constructor for exception [com.phoenix_int.aserver.library.PHXNoSuchCategoryException](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md)
Constructor for this exception containing both a specific message and the category which could not be found. +- **PHXNoSuchCategoryException(String, String, Exception)** - Constructor for exception [com.phoenix_int.aserver.library.PHXNoSuchCategoryException](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md)
Constructor which takes a message, a category, and an inner exception. +- **PHXNoSuchIconException** - Exception in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXNoSuchIconException.md)
An exception that is thrown when an invalid icon is specified. +- **PHXNoSuchIconException(String)** - Constructor for exception [com.phoenix_int.aserver.library.PHXNoSuchIconException](com/phoenix_int/aserver/library/PHXNoSuchIconException.md) +- **PHXNoSuchObjectException** - Exception in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXNoSuchObjectException.md)
An exception that is thrown when an object cannot be found +- **PHXNoSuchObjectException(int, String)** - Constructor for exception [com.phoenix_int.aserver.PHXNoSuchObjectException](com/phoenix_int/aserver/PHXNoSuchObjectException.md) +- **PHXNoSuchObjectException(String)** - Constructor for exception [com.phoenix_int.aserver.PHXNoSuchObjectException](com/phoenix_int/aserver/PHXNoSuchObjectException.md) +- **PHXNoSuchReplacementException** - Exception in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md)
An exception that is thrown when a replacement string cannot be found +- **PHXNoSuchReplacementException()** - Constructor for exception [com.phoenix_int.aserver.util.PHXNoSuchReplacementException](com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md) +- **PHXNoSuchResponseException** - Exception in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/PHXNoSuchResponseException.md)
An exception that is thrown when an invalid response is specified. +- **PHXNoSuchTokenException** - Exception in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXNoSuchTokenException.md)
An exception that is thrown when an object cannot be found +- **PHXNoSuchTokenException()** - Constructor for exception [com.phoenix_int.aserver.util.PHXNoSuchTokenException](com/phoenix_int/aserver/util/PHXNoSuchTokenException.md) +- **PHXNoSuchTokenException(String)** - Constructor for exception [com.phoenix_int.aserver.util.PHXNoSuchTokenException](com/phoenix_int/aserver/util/PHXNoSuchTokenException.md) +- **PHXNoSuchTokenException(String, Throwable)** - Constructor for exception [com.phoenix_int.aserver.util.PHXNoSuchTokenException](com/phoenix_int/aserver/util/PHXNoSuchTokenException.md) +- **PHXNoSuchTokenException(Throwable)** - Constructor for exception [com.phoenix_int.aserver.util.PHXNoSuchTokenException](com/phoenix_int/aserver/util/PHXNoSuchTokenException.md) +- **PHXNoSuchWriteableObjectException** - Exception in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md)
An exception that the `PHXObjectManager` throws when it can't find an object. +- **PHXNoSuchWriteableObjectException(String)** - Constructor for exception [com.phoenix_int.aserver.PHXNoSuchWriteableObjectException](com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md) +- **PHXNumberFormatException** - Exception in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXNumberFormatException.md)
Like a `NumberFormatException` except that it isn't a runtime exception and must be caught +- **PHXNumberFormatException(String)** - Constructor for exception [com.phoenix_int.aserver.types.PHXNumberFormatException](com/phoenix_int/aserver/types/PHXNumberFormatException.md) +- **PHXObjectArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXObjectArray.md)
Placeholder for an array of any random Java Object. +- **PHXObjectArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md) +- **PHXObjectArray(Object)** - Constructor for class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md) +- **PHXObjectArray(PHXObjectArray)** - Constructor for class [com.phoenix_int.aserver.types.PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md)
Clone another `PHXObjectArray`'s value and metadata. +- **PHXOrientation** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXOrientation.md)
This is a utility class for holding orientation information. +- **PHXOrientation(boolean, boolean)** - Constructor for class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **PHXProcess** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXProcess.md)
This is a utility class that extends `java.lang.Process` with a system dependent process ID. +- **PHXProcess(Process, boolean, String, String, IPHXProcessJobInfoListener, String)** - Constructor for class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md)
Constructs a `PHXProcess` out of a process and optionally reads the PID of the sub-process. +- **PHXProcess(Process, boolean, String, String, IPHXProcessJobInfoListener)** - Constructor for class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **PHXProcess(Process)** - Constructor for class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md)
Constructs a PHXProcess out of a regular process but does not provide extended functionality because the process ID will not be known. +- **PHXProcessInfo** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXProcessInfo.md)
This class represents information about a running process on the system. +- **PHXProcessInfo()** - Constructor for class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Constructs an empty process +- **PHXPropertyDescriptor** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
A utility class used by PHXSelfManager to indicate which properties it manages. +- **PHXPropertyDescriptor()** - Constructor for class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
creates a property descriptor with all values set to "unknown" +- **PHXPropertyDescriptor(PropertyDescriptor)** - Constructor for class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **PHXPropertyDescriptor(String, String, boolean, boolean)** - Constructor for class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **PHXPropertyDescriptor(String, Object, boolean, boolean)** - Constructor for class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **PHXPropertyDescriptor(PropertyDescriptor, Object)** - Constructor for class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) +- **PHXPropertyValue** - Class in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/PHXPropertyValue.md) +- **PHXPropertyValue()** - Constructor for class [com.phoenix_int.aserver.client.PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.md) +- **PHXPropertyValue(PHXPropertyValue)** - Constructor for class [com.phoenix_int.aserver.client.PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.md) +- **PHXPropertyValue(PHXPropertyDescriptor, String)** - Constructor for class [com.phoenix_int.aserver.client.PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.md) +- **PHXRawFile** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXRawFile.md)
The Phoenix type for Files. +- **PHXRawFile()** - Constructor for class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **PHXRawFile(String)** - Constructor for class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **PHXRawFile(String, String)** - Constructor for class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **PHXRawFile(PHXRawFile)** - Constructor for class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Clone another `PHXRawFile`'s value and metadata. +- **PHXRawFileArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Wraps an array of `PHXRawFile` variables for the ScriptWrapper utility. +- **PHXRawFileArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) +- **PHXRawFileArray(Object)** - Constructor for class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) +- **PHXRawFileArray(PHXRawFileArray)** - Constructor for class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Clone another PHXRawFileArray's value and metadata. +- **PHXRefArrayProperty** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
This is a class for holding properties of a reference object **type**: String **enumValues**: String[] **description**: String **title**: String **input**: boolean
where type may be any of the following: "long", "double", "boolean", "string" +- **PHXReference** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXReference.md)
The Phoenix type for references. +- **PHXReference()** - Constructor for class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
constructor +- **PHXReferenceArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXReferenceArray.md)
The Phoenix type for references. +- **PHXReferenceArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
constructor +- **PHXRefProperty** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXRefProperty.md)
This is a class for holding properties of a reference object **type**: String **enumValues**: String[] **description**: String **title**: String **input**: boolean
where type may be any of the following: "long", "double", "boolean", "string" +- **PHXRefProperty(String, String)** - Constructor for class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
constructor +- **PHXResponseTypeMismatchException** - Exception in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md)
An exception that is thrown when an invalid response is specified. +- **PHXRowFieldFile** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Class implements the parsing capabilities of the `RowField` type files from the fileWrapper facility. +- **PHXRowFieldFile(PHXScriptWrapperObject)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Defaults to [ParseableFile.Mode.GENERATE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#GENERATE) +- **PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) +- **PHXRowFieldFile(PHXScriptWrapperObject, int)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Deprecated in favor of [PHXRowFieldFile.PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md#PHXRowFieldFile-com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject-com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode-) +- **PHXRowFieldFile(String, int)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Legacy (pre-QW) constructor. +- **PHXRowFieldRange** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange()** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, String, String, String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, int)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, int, int)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, String, int)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, String, String, int)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, String, String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRowFieldRange(String, String, String, String, String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **PHXRunShare** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXRunShare.md)
This class handles runshare capabilities for any component which needs it. +- **PHXRunShare(String, String)** - Constructor for class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md) +- **PHXRunShare.RunInfo** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXRunShare.RunInfo.md)
Data structure used to hold info about a currently running command +- **PHXRunShareContext** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md)
This class handles runshare capabilities for any component which needs it. +- **PHXRunShareContext(String, String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRunShareContext](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md) +- **PHXRuntime** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXRuntime.md)
This is a utility class for running processes. +- **PHXRuntime()** - Constructor for class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md) +- **PHXScriptObject** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXScriptObject.md)
The PHX type for object variables. +- **PHXScriptObject()** - Constructor for class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
Creates a new instance of `PHXScriptObject` +- **PHXScriptWrapperAPIException** - Exception in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md)
Represents a problem with transferring data in a `PHXRowFieldFile` object. +- **PHXScriptWrapperAPIException(String)** - Constructor for exception [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperAPIException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md)
Creates a new instance of `PHXScriptWrapperAPIException` +- **PHXScriptWrapperObject** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
This object is passed to Script Wrapper scripts and provides the "wrapper" global object which provides runtime services for the wrapper. +- **PHXScriptWrapperObject(PHXScriptWrapper)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Constructs a wrapper object from a ScriptWrapper instance. +- **PHXSection** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **PHXSection(String, PHXBookmark, PHXBookmark, String)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md)
Creates a new instance of `PHXSection` +- **PHXSectionNotFoundException** - Exception in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md) +- **PHXSectionNotFoundException(String)** - Constructor for exception [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSectionNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md) +- **PHXServerSideException** - Exception in [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/PHXServerSideException.md)
An exception that is thrown when an error is returned from the server. +- **PHXServerSideException(String)** - Constructor for exception [com.phoenix_int.aserver.client.PHXServerSideException](com/phoenix_int/aserver/client/PHXServerSideException.md)
Constructor +- **PHXSimpleArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXSimpleArray.md)
This class enables components to create resizeable arrays where the number of dimensions is variable as well as the size of each dimension. +- **PHXSimpleArray(Object)** - Constructor for class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Constructs a PHXSimpleArray that wraps a particular ModelCenter Remote Execution style variable. +- **PHXSimpleArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Default Constructor +- **PHXSimpleSelfManager** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
This is a class that implements most of the functionality of a self-managing components. +- **PHXSimpleSelfManager()** - Constructor for class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md) +- **PHXSimpleSelfManager2** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXSimpleSelfManager2.md)
This is a class that implements most of the functionality of a self-managing components. +- **PHXSimpleSelfManager2()** - Constructor for class [com.phoenix_int.aserver.PHXSimpleSelfManager2](com/phoenix_int/aserver/PHXSimpleSelfManager2.md) +- **PHXSimpleSelfManager3** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXSimpleSelfManager3.md)
This is a class that implements most of the functionality of a self-managing components. +- **PHXSimpleSelfManager3()** - Constructor for class [com.phoenix_int.aserver.PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.md) +- **PHXSimpleType** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXSimpleType.md)
A base class for most Phoenix data types. +- **PHXSimpleType()** - Constructor for class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md) +- **PHXString** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXString.md)
The Phoenix type for Strings. +- **PHXString()** - Constructor for class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md) +- **PHXString(String)** - Constructor for class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md) +- **PHXString(PHXString)** - Constructor for class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Clone another PHXString's value and metadata. +- **PHXStringArray** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXStringArray.md)
Class wraps an array of PHXString variables for the ScriptWrapper utility. +- **PHXStringArray()** - Constructor for class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **PHXStringArray(Object)** - Constructor for class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **PHXStringArray(PHXStringArray)** - Constructor for class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **PHXStringBuffer** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Class that behaves like a `java.lang.StringBuffer` but has logic for cacheing out to disk if the size grows over a limit (currently 512K). +- **PHXStringBuffer()** - Constructor for class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Creates a new, empty string buffer +- **PHXStringBuffer(long)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Creates a new, empty string buffer which has an internal buffer of the size specified. +- **PHXStringBuffer(String)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Creates a new string buffer which contains the specified string. +- **PHXStringReplacer** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXStringReplacer.md)
This is a utility class for replacing fields within a string. +- **PHXStringReplacer(IPHXStringReplacer)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringReplacer](com/phoenix_int/aserver/util/PHXStringReplacer.md) +- **PHXStringTokenizer** - Class in [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
This is a more sophisticated version of the Java `StringTokenizer`. +- **PHXStringTokenizer(String, String)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXStringTokenizer(String, String, boolean)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXStringTokenizer(PHXStringBuffer, String)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXStringTokenizer(PHXStringBuffer, String, boolean)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXStringTokenizer(String)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXStringTokenizer(String, boolean)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXStringTokenizer(PHXStringBuffer)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXStringTokenizer(PHXStringBuffer, boolean)** - Constructor for class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Constructs a string tokenizer for the specified string. +- **PHXTypeFactory** - Class in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXTypeFactory.md)
A class for creating variables +- **PHXTypeFactory()** - Constructor for class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md) +- **PHXTypeMismatchException** - Exception in [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/PHXTypeMismatchException.md)
An exception thrown when trying to set a value using an incompatible type, or when trying to compare two values of incompatible types +- **PHXTypeMismatchException(String, String, String)** - Constructor for exception [com.phoenix_int.aserver.types.PHXTypeMismatchException](com/phoenix_int/aserver/types/PHXTypeMismatchException.md)
Create an exception for attempting to set a value using an incompatible type +- **PHXTypeMismatchException(String, String)** - Constructor for exception [com.phoenix_int.aserver.types.PHXTypeMismatchException](com/phoenix_int/aserver/types/PHXTypeMismatchException.md)
Create an exception for attempting to compare two values of incompatible types +- **PHXTypeMismatchException(String, String, Throwable)** - Constructor for exception [com.phoenix_int.aserver.types.PHXTypeMismatchException](com/phoenix_int/aserver/types/PHXTypeMismatchException.md)
Create an exception for attempting to compare two values of incompatible types +- **PHXUserDirLibrarian** - Class in [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md)
This librarian provides "user" directories by looking in a user path or by reading `/etc/passwd`. +- **PHXUserDirLibrarian()** - Constructor for class [com.phoenix_int.aserver.library.PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md) +- **PHXVariableInfo** - Class in [com.phoenix_int.aserver](com/phoenix_int/aserver/PHXVariableInfo.md)
this is a utility class for holding parsing information about a variable +- **PHXVariableInfo()** - Constructor for class [com.phoenix_int.aserver.PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md)
creates an unitialized object. +- **PHXVariableInfo(String, boolean, Object)** - Constructor for class [com.phoenix_int.aserver.PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md) +- **PHXVersionException** - Exception in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md) +- **PHXVersionException(int, int, int, int)** - Constructor for exception [com.phoenix_int.aserver.util.scriptwrapper.api.PHXVersionException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md)
Creates a new instance of `PHXVersionException` +- **ProcessHaltedException** - Exception in [com.phoenix_int.aserver](com/phoenix_int/aserver/ProcessHaltedException.md)
Exception indicating that the request cannot be handled because the associated process was halted. + +# Q + +- **quit(boolean)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Force quit current analysis, and shut down ModelCenter Remote Execution. + +# R + +- **RANDOM_ACCESS** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Deprecated in favor of [Parser.Mode.RANDOM](com/phoenix_int/aserver/util/Parser.Mode.md#RANDOM) +- **RANGE_SEPARATOR** - Static variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md)
+- **rcsid** - Static variable in class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md)
+- **read()** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md)
+- **read(byte[])** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md)
+- **read(byte[], int, int)** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md)
+- **read(char[], int, int)** - Method in class [com.phoenix_int.util.PHXNewLineAddFilter](com/phoenix_int/util/PHXNewLineAddFilter.md)
+- **read(char[], int, int)** - Method in class [com.phoenix_int.util.PHXNewLineFilter](com/phoenix_int/util/PHXNewLineFilter.md)
+- **READ_TEMPLATE** - Static variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Deprecated in favor of [ParseableFile.Mode.READ_TEMPLATE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#READ_TEMPLATE) +- **readDouble(int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Reads a value out of the input file. +- **readFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the filename and then loads the contents of the actual file on disk into the temporary file. +- **readFile(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Loads the contents of the actual file on disk into the temporary file. +- **readFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Loads the contents of the actual file on disk into the temporary file. +- **readFile(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
loads the file from disk for an element of an 1D array. +- **readFile(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
loads the file from disk for an element of an array. +- **readLong(int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Reads a value out of the input file. +- **readNextLine()** - Method in class [com.phoenix_int.aserver.util.PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md)
extracts the next line from the data file +- **readTemplate()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Read the template. +- **readTemplate()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)
Read the template. +- **readValue(int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Reads a value out of the input file. +- **REFERENCE** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a reference type +- **REFERENCE_ARRAY** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for a reference array type +- **removeAllGroups()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
remove all groups from the group +- **removeAllVariables()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
removes all variables from the group +- **removeAutoClose(Closeable)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Remove the file from the file Handlers list +- **removeEscapes(String)** - Static method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
+- **removeEscapes()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
+- **removeGroup(String)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
remove a child group. +- **removeLines(int, int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
+- **removeListener(IPHXAnalysisClientListener)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.removes a listener +- **removeMonitor(PHXFileMonitor)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Removes a file monitor from our list +- **removeMonitorListener(IPHXFileCallback)** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md)
Removes a listener from this monitor +- **removePropertyChangeListener(PropertyChangeListener)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
+- **removeRunDirChangedListener(IPHXRunDirChangedListener)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Removes a listener for run directory changed events. +- **removeTraceListener(IPHXTraceListener)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Removes a listener from trace events +- **removeVariable(PHXVariableInfo)** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
removes a variable +- **removeVariable(PHXVariableInfo)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md)
removes a variable. +- **removeVariable(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Dynamically removes a variable from this component +- **replace(String)** - Method in class [com.phoenix_int.aserver.util.PHXStringReplacer](com/phoenix_int/aserver/util/PHXStringReplacer.md)
replaces all names starting with "$" with values looked up from the replacer object. +- **requireAnalysisServerVersion(int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Verifies we're running a compatible version of ModelCenter Remote Execution +- **reset()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Reset the`ProcessStruct`back to initial state for possible use in another run request. +- **resetDelimiters()** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
resets the delimiters to whitespace +- **resize(int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Resize the nD array to the new size specified. +- **RESIZE_DISALLOW** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Don't allow the length of an array to change +- **RESIZE_ROWS** - Static variable in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
Allow a square matrix to change sizes by adding or deleting rows. +- **responseReceived(AnalysisServerResponse)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md)
Callback when a response is received. +- **responseReceived(AnalysisServerResponse)** - Method in interface [com.phoenix_int.aserver.client.v2.IAnalysisServerCallback](com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md)
Callback when a response is received. +- **run(String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Runs a command. +- **run(String, boolean, boolean, String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Runs a command. +- **run(String, boolean, String, String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Runs a command. +- **run2(String, boolean, String, String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Runs a command. + +# S + +- **seek(long)** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **sendAddProxyClientsRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Tells the server to add other hosts as part of the proxy chain +- **sendArbitraryRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends an arbitrary request to the server +- **sendArbitraryRequest(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends an arbitrary request to the server +- **sendDeleteRunShareRequest(Long)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Sends a request to delete a runShare +- **sendDescribeRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to describe an analysis +- **sendEndRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to end an analysis +- **sendExecuteRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to execute an analysis +- **sendGetByUrlRequest(String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to get the value of a property +- **sendGetComponentHistoryRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to get the version history of a component +- **sendGetHierarchyRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to retrieve a hierarchy for a component +- **sendGetHierarchyRequest(String, PHXHierarchyFileMode)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to retrieve a hierarchy for a component +- **sendGetIconRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to retrieve an icon +- **sendGetRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to get the value of a property +- **sendInvokeRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to invoke a method +- **sendListArrayValuesRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **sendListCategoriesRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to list the categories +- **sendListClassesRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to list the classes +- **sendListMethodsRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to list the methods of an analysis +- **sendListPropertiesRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to list the properties of an analysis +- **sendListRequest()** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to list the running objects +- **sendListValuesRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **sendListValuesURLRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **sendSetByUrlRequest(String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to get the value of a property +- **sendSetDictionaryRequest(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to set a dictionary +- **sendSetHierarchyRequest(String, PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Sends a request to set a hierarchy for a component +- **sendSetRequest(String, Object)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to set the value of a property +- **sendStartRequest(String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
sends a request to start an analysis +- **set(String, Object)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
set the value of a property +- **set(String, Object)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the value of a property. +- **set(String, File)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set a file variable on the server. +- **set(String, File, String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set a file variable on the server. +- **SET_BY_URL_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **SET_DICTIONARY_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **SET_HIERARCHY_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **SET_REQUEST** - Static variable in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated. +- **setAbsoluteStartRow(int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md)
Sets the stored starting row number. +- **setAdditionalConfigValue(String, Object)** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Set additional configuration value key-value pair in map. +- **setAdditionalConfigValue(String, Object)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set additional configuration value key-value pair in map. +- **setArray(Object)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the entire array. +- **setArrayElement(int, Object)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets a particular element of a 1-d array +- **setArrayElement(int[], Object)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets a particular element of the array +- **setAsync(String, Object, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the value of a property. +- **setAsync(String, File, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set a file variable on the server. +- **setAsync(String, File, String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set a file variable on the server. +- **setAuthor(String)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setAuthor(String)** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Sets the version author +- **setAuthor(String)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set the author of this component. +- **setAutoChangeDir(boolean)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Sets the "AutoChangeDir" flag. +- **setAutoDelete(int)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Sets the auto-delete mode for runshare mode MODE_SHARE. +- **setAutoGrow(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
sets the autoGrow value. +- **setBaseName(String)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
sets the base name of the file +- **setBaseName(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
sets the base name of the file +- **setBaseName(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
sets the base name of files for this array +- **setBaseName(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
set base name for the data source file +- **setBaseName(String)** - Method in class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md)
sets the base name for the file. +- **setBinary(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Make a given file variable binary +- **setBlock(boolean)** - Method in class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md)
Call `setBlock()` before `block()` and before there is any remote chance that any other thread will call `unblock()`. +- **setBlue(double)** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **setBooleanArrayMemberValue(String, int, boolean)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of an 1D boolean array member +- **setBooleanArrayMemberValue(String, int[], boolean)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a boolean array member +- **setBooleanMemberValue(String, boolean)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a boolean member +- **setByUrl(String, String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
set the value of a variable +- **setByUrl(String, String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the URL of a file property. +- **setByUrlAsync(String, String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the URL associated with a property +- **setCanGet(boolean)** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
sets whether the property can be retrieved +- **setCanSet(boolean)** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
sets whether the property can be modified +- **setCG(double, double, double)** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **setcgX(double)** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **setcgY(double)** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **setcgZ(double)** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **setChecksum(long)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setColor(double, double, double)** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **setComment(String)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set a comment to be associated with this component. +- **setConnection(PHXConnection)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.md)
Sets the connection object +- **setConnection(PHXConnection)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
sets the connection object +- **setContents(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the contents of the temporary file. +- **setContents(PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the contents of the temporary file. +- **setContents(File)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the contents of the temporary file to an existing file. +- **setContents(File, UUID, String, Charset)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the contents of the temporary file to an existing file. +- **setContents(ManagedFileHandle, UUID, String, Charset)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the contents of the temporary file to an existing ManagedFileHandle. +- **setContents(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
sets the contents of the file for an array element for an 1D array. +- **setContents(int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
sets the contents of the file for an array element for an array. +- **setData(String)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
sets the value for the variable +- **setDate(Date)** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Sets the version date +- **setDecimalSeparator(char)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
sets decimal separator character for floating point literals +- **setDecimalSeparator(char)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Set decimal separator for floating point value literals. +- **setDefaultValue(Object)** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Set default value of variable +- **setDelayLoadSetupAllowed(boolean)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setDeleteDFT(boolean)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Set whether the analysis client should auto-delete Direct File Transfer run shares or not +- **setDelimiters(String)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
sets the current delimiter set +- **setDelimiters(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Sets the delimiters which should be used for parsing lines into fields. +- **setDelimiters(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setDelimiters(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **setDescription(String)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setDescription(String)** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Sets the version description +- **setDescription(String)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
sets the description for the variable. +- **setDescription(String)** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
sets a description of the ref prop +- **setDescription(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **setDescription(String)** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
sets a description of the ref prop +- **setDescription(String)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md) +- **setDescription(String)** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Set component description +- **setDescription(String)** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Set variable description +- **setDescription(String)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set component description +- **setDescription(String)** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Set variable description +- **setDictionary(String)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Tries to set the dictionary by sending a set dictionary request. +- **setDictionary(String)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set dictionary on Server. +- **setDictionary(Map)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md) +- **setDictionaryAsync(String, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set dictionary on Server. +- **setDimensions(String, int[])** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the dimensions of an array. +- **setDimensions(int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the dimensions of the array. +- **setDimensionsAsync(String, int[], IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the dimensions of an array. +- **setDirectTransfer(boolean)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Set whether or not this runShare is involved in direct transfer of files +- **setDoubleArrayMemberValue(String, int, double)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a 1D double array member +- **setDoubleArrayMemberValue(String, int[], double)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a double array member +- **setDoubleMemberValue(String, double)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a double member +- **setDownloadInputs(boolean)** - Method in class [com.phoenix_int.aserver.PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md)
set whether input values should be redownloaded after the invocation +- **setDriver(boolean)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setEncoding(PHXFileUtils.Encoding)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **setEncoding(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **setEnd(PHXBookmark)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **setEndingCol(int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setEndingMark(String, int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setEndingRow(int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setEndParent(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setEnumAliases(String)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
takes a comma seperated string of values and fills the enumeration aliases list with values. +- **setEnumAliases(String[])** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Sets the enumeration aliases list +- **setEnumAliases(String)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
takes a comma seperated string of values and fills the enumeration aliases list with values. +- **setEnumAliases(String[])** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Sets the enumeration aliases list +- **setEnumAliases(String)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.takes a comma seperated string of values and fills the enumeration aliases list with values. +- **setEnumAliases(String[])** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.Sets the enumeration aliases list +- **setEnumAliases(String)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
takes a comma seperated string of values and fills the enumeration aliases list with values. +- **setEnumAliases(String[])** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Sets the enumeration aliases list +- **setEnumAliases(String)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
takes a comma seperated string of values and fills the enumeration aliases list with values. +- **setEnumAliases(String[])** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Takes an array of values and fills the enumeration aliases list with values. +- **setEnums(String[], Object[])** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Set the names/aliases and corresponding values for the enumerated type +- **setEnumValues(String[])** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
sets the enum values +- **setEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
takes a comma seperated string of values and fills the enumeration List with values. +- **setEnumValues(double[])** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Sets the enumeration list of valid values. +- **setEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
takes a comma seperated string of values and fills the enumeration List with values. +- **setEnumValues(double[])** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Sets the enumeration list of valid values. +- **setEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.sets the possible values a variable may be +- **setEnumValues(int[])** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.Sets the enumeration list of valid values. +- **setEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
sets the possible values a variable may be +- **setEnumValues(long[])** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
sets the possible values a variable may be +- **setEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
takes a comma seperated string of values and fills the enumeration List with values. +- **setEnumValues(long[])** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
sets the possible values a variable may be +- **setEnumValues(String[])** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
sets the enum values +- **setEnumValues(String[])** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
sets the enum values +- **setEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
sets the enum values +- **setEnumValues(String[])** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
sets the enum values +- **setEnumValues(String)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
takes a comma seperated string of values and fills the enumeration List with values. +- **setEnumValues(String[])** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md)
sets the enum values +- **setFileExtension(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the extension of the file that this object represents. +- **setFileExtension(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Sets the extension of the file for an element of an 1D array +- **setFileExtension(int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Sets the extension of the file for an element of an array +- **setFileExtension(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
set file extesion of the data source file +- **setFileName(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
set name of the data source file +- **setFilesToCopy(String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Sets the files which need to be copied when runshare mode is MODE_SHARE. +- **setFileToGenerate(String)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md)
Set the file to be generated +- **setFileToGenerate(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Set the file to be generated +- **setFileToGenerate(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Set the file to be generated +- **setFileToGenerateOrParse(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Set the file to generate or to parse, depending on the mode +- **setFileToGenerateOrParse(String)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)
Set the file to generate or to parse, depending on the mode +- **setFileToParse(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md)
Set the file to parse +- **setFileToParse(String)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md)
Deprecated.Set the file to be parsed +- **setFileToParse(String)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)
Sets the file that will be parsed. +- **setFileToParse(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Set the file to be parsed +- **setFileToParse(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Set the file to be parsed +- **setFirst(Object)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the first element of the array, or throws `ArrayIndexOutOfBounds` if there are no elements. +- **setFormat(String)** - Method in interface [com.phoenix_int.aserver.types.IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)
Set the format string for the variable +- **setFormat(String)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Set the format string for the variable +- **setFormat(String)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
Set the format string for the variable +- **setFormat(String)** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
sets the format for the variable. +- **setFormat(String)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
Set the format string for the variable +- **setFormat(String)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Set the format string for the variable +- **setFormat(String)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
Set the format string for the variable +- **setFormat(String)** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.Set variable format string +- **setFullName(String)** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **setGreen(double)** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **setHasChanged(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
sets the hasChanged flag +- **setHasIcon(boolean)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setHasLowerBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
sets the `hasLowerBound` flag +- **setHasLowerBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
sets the `hasLowerBound` flag +- **setHasLowerBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.sets the `hasLowerBound` flag +- **setHasLowerBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
sets the `hasLowerBound` flag +- **setHasLowerBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
sets the `hasLowerBound` flag +- **setHasUpperBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
sets the `hasUpperBound` flag +- **setHasUpperBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
sets the `hasUpperBound` flag +- **setHasUpperBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.sets the `hasUpperBound` flag +- **setHasUpperBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
sets the `hasUpperBound` flag +- **setHasUpperBound(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
sets the `hasUpperBound` flag +- **setHasVersionInfo(int)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setHelpURL(String)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setHierarchy(String, PHXStringBuffer)** - Method in class [com.phoenix_int.aserver.client.PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md)
Deprecated.
Sends a request to set a hierarchy for a component +- **setHierarchy(String, Iterable``)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the variable hierarchy of a running instance. +- **setHierarchy(String, File, String, boolean)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the variable hierarchy of a running instance. +- **setHierarchyAsync(String, Iterable``, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the variable hierarchy of a running instance. +- **setHierarchyAsync(String, File, String, boolean, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set the variable hierarchy of a running instance. +- **setIcon(PHXIcon)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setIconFile(String)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setIconUri(URI)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set component icon URI +- **setIgnoreConversionErrors(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
indicates whether the object should accept bad values in the `fromString()` method without throwning an exception. +- **setIgnoreConversionErrors(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
indicates whether the object should accept bad values in the `fromString()` method without throwning an exception. +- **setIgnoreConversionErrors(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
indicates whether the object should accept bad values in the` fromString()` method without throwning an exception. +- **setIgnoreConversionErrors(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
indicates whether the object should accept bad values in the `fromString()` method without throwning an exception. +- **setIgnoreErrors(boolean)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Sets the +- **setInput(boolean)** - Method in interface [com.phoenix_int.aserver.types.IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)
sets an indicator for the ref prop +- **setInput(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md)
sets an indicator for the ref prop +- **setInput(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md)
sets an indicator for the ref prop +- **setInputs(List``)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set component inputs +- **setInstanceFiles(List``)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set component instance files +- **setIntArrayMemberValue(String, int, int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of an 1D integer array member +- **setIntArrayMemberValue(String, int[], int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of an integer array member +- **setIntMemberValue(String, int)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of an integer member +- **setIsBinary(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Forces this file to be binary or not. +- **setIsBinary(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Forces elements of this array to be binary or not. +- **setIsBinary(String, boolean)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
set binary flag for a file member +- **setJobListener(IPHXProcessJobInfoListener)** - Method in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md) +- **setKeywords(String)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setLength(int)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
sets the number of references +- **setLength(int)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the length of the first dimension of the array. +- **setLength(int, int)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets the length of a dimensions of the array. +- **setLockResize(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Tells this array that it cannot be resized. +- **setLowerBound(double)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
sets the lower bound. +- **setLowerBound(String)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md) +- **setLowerBound(double)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md)
sets the lower bound. +- **setLowerBound(int)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.
sets the lower bound. +- **setLowerBound(String)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated. +- **setLowerBound(long)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
sets the lower bound. +- **setLowerBound(String)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md) +- **setLowerBound(long)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md)
sets the lower bound. +- **setLowerBound(Number)** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Set lower bound of variable; may be null +- **setMass(double)** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **setMatrixArray(int, int, int, int, String[])** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
sets an array of tokens for the specified range. +- **setMatrixArray(int, int, int, int, String[], int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
sets an array of tokens for the specified range. +- **setMatrixArray(int, int, int, int, int, String[])** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
sets an array of tokens for the specified range. +- **setMatrixArray(int, int, int, int, int, String[], int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
sets an array of tokens for the specified range. +- **setMatrixArray2d(int, int, int, int, String[][], int)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
sets an array of tokens for the specified range. +- **setMetaData(PHXRawFile)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **setMetaData(String, String)** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Set meta data property; will create a new entry it does not exist +- **setMetaData(String, String)** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Set meta data property; will create a new entry it does not exist +- **setMimeType(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **setMimeType(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
Set mime type for the array. Currently all elements of an array should have the same mime type. +- **setMode(int)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Sets the runshare mode. +- **setName(String)** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Changes the branch name +- **setName(String)** - Method in class [com.phoenix_int.aserver.PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md)
Sets the version name +- **setName(String)** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) +- **setName(String)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
sets the name of the file +- **setName(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
sets the name of the file +- **setName(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
sets the name of the file for an element of an 1D array +- **setName(int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
sets the name of the file for an element of an array +- **setName(String)** - Method in class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md)
sets the name for the file +- **setName(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **setName(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **setName(String)** - Method in interface [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md)
Deprecated.
Set variable name +- **setNeedWrite(boolean)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **setOutputs(List``)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set component outputs +- **setPageName(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) +- **setPageName(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setParent(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setPollDelay(long)** - Method in class [com.phoenix_int.aserver.monitors.PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md)
Poll Delay is how long to sleep in milliseconds between polling the file for more data. +- **setProperties(PHXRefProperty[])** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **setProperties(PHXRefArrayProperty[])** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **setQuoteChar(char)** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
Sets the character to be used to indicate the start and end of strings. +- **setRange(PHXRowFieldRange)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) +- **setRed(double)** - Method in class [com.phoenix_int.aserver.types.PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) +- **setRedirectURL(String)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **setReference(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
sets the value for the reference string. +- **setReference(String[])** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
sets the value for the reference string. +- **setReference(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **setRefPropValue(String, double)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
sets a value for a ref prop +- **setRefPropValue(String, long)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **setRefPropValue(String, boolean)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **setRefPropValue(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md) +- **setRefPropValue(String, int, double)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md)
sets a value for a ref prop +- **setRefPropValue(String, int, long)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **setRefPropValue(String, int, boolean)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **setRefPropValue(String, int, String)** - Method in class [com.phoenix_int.aserver.types.PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) +- **setRequiredFeatures(List``)** - Method in interface [com.phoenix_int.pacz.api.IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md)
Deprecated.
Set list features required for component to execute +- **setRequiredFeatures(List``)** - Method in interface [com.phoenix_int.pacz.api.v2.IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md)
Set list features required for component to execute +- **setRequirements(String)** - Method in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md)
Set the requirements via comma separated list. +- **setReturnString(String)** - Method in class [com.phoenix_int.aserver.PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md)
sets the return string for the custom method +- **setRotX(double)** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **setRotY(double)** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **setRotZ(double)** - Method in class [com.phoenix_int.aserver.types.PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) +- **setRunDirectory(String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md) +- **setRunQueue(String, String)** - Method in interface [com.phoenix_int.aserver.IPHXRunQueue](com/phoenix_int/aserver/IPHXRunQueue.md)
sets the run queue for a component +- **setRunReplacer(PHXRunReplacer)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Sets the run replacer object which is used to transform $VAR type specifications before running commands +- **setRunShare2(PHXRunShare)** - Method in class [com.phoenix_int.aserver.PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.md)
Sets the run share object +- **setServerProperties(Map``)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set server properties. +- **setServerPropertiesAsync(Map``, IAnalysisServerCallback)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md)
Set server properties. +- **setShell(String)** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Sets the shell used to execute commands. +- **setShell(String)** - Method in class [com.phoenix_int.aserver.util.PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md)
sets the shell to use when running commands (applies to UNIX only) +- **setStart(PHXBookmark)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) +- **setStartingCol(int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setStartingMark(String, int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setStartingRow(int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) +- **setStringArrayMemberValue(String, int, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a 1D string array member +- **setStringArrayMemberValue(String, int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a string array member +- **setStringMemberValue(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
sets the value of a string member +- **setStringReplacer(PHXStringReplacer)** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.
specifies a `PHXStringReplacer` object for use in forming the full file name. +- **setStringReplacer(PHXStringReplacer)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
specifies a `PHXStringReplacer` object for use in forming the full file name. +- **setStringReplacer(PHXStringReplacer)** - Method in class [com.phoenix_int.aserver.util.PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md)
sets the string replacer for the forming the real file name +- **setSurfaceArea(double)** - Method in class [com.phoenix_int.aserver.types.PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) +- **setTempEmbedded(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
This method applies only to ModelCenter and has no function in ModelCenter Remote Execution +- **setTempEmbedded(String)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)
This method applies only to ModelCenter and has no function in ModelCenter Remote Execution + +# T + +- **templateFileName** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
+- **timeout()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Cleans up a run that has timed out +- **toAPIObject(FunctionThrows``** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Convert this instance to a string-string map appropriate for serialization. +- **toFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the filename and then writes from the temp file to the actual file. +- **toFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Writes from the temp file to the actual file. +- **toFile(int, String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
sets the filename and then writes the file to disk for an element of an 1D array. +- **toFile(int[], String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
sets the filename and then writes the file to disk for an element of an array. +- **toFile(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
writes the file to disk for an element of an 1D array +- **toFile(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
writes the file to disk for an element of an array +- **toFile(String, String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
write a file member to a file +- **toFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
write a file member to a file file name must have been specified +- **toImage()** - Method in class [com.phoenix_int.aserver.util.PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md)
converts the icon to an Image +- **toPHXSimpleType(Object, Class`** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Converts the given type to the associated PHXSimpleType. +- **toPHXSimpleType()** - Method in interface [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md)
Get the PHXSimpleType version of variable +- **toString()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md)
+- **toString()** - Method in class [com.phoenix_int.aserver.PHXGroup](com/phoenix_int/aserver/PHXGroup.md)
Converts this to a string +- **toString()** - Method in class [com.phoenix_int.aserver.PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md)
handle converting this class to a string in XML format +- **toString()** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md)
+- **toString()** - Method in class [com.phoenix_int.aserver.PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md)
converts the property to a readable format +- **toString()** - Method in interface [com.phoenix_int.aserver.types.IPHXType](com/phoenix_int/aserver/types/IPHXType.md)
Gets the value for the variable +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
converts the variable to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
converts the variable to a string +- **toString(int)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Converts the value to a string with the best possible formatting, e.g. +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.converts the variable to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
converts the variable to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.converts the variable to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
converts the variable to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
converts the variable to a string +- **toString(int)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
converts an element of the 1D array to a string +- **toString(int[])** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md)
converts an element of the array to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
converts to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get XML representation of the object variable +- **toString(int)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Converts a single element of a 1-d array to a string +- **toString(String)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Converts a single element to a string +- **toString(int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Converts a single element to a string +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Returns the string form of this array. +- **toString()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
converts the variable to a string +- **toString()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Converts this process infor into a one-line readable string +- **toString()** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Returns a string representation of this object. +- **toString()** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md)
+- **toString(boolean)** - Method in interface [com.phoenix_int.aserver.util.scriptwrapper.api.IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md)
+- **toString()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md)
+- **toString(boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md)
+- **toString()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md)
+- **toString(boolean)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md)
+- **toString()** - Method in enum [com.phoenix_int.pacz.api.RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.md)
Deprecated.Get value of enumeration +- **toString()** - Method in enum [com.phoenix_int.pacz.api.v2.RunFolderPreference](com/phoenix_int/pacz/api/v2/RunFolderPreference.md)
Get value of enumeration +- **toString()** - Method in enum [com.phoenix_int.pacz.api.VariableDataType](com/phoenix_int/pacz/api/VariableDataType.md)
Deprecated.Get value of enumeration +- **toString2()** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md)
+- **toString2()** - Method in interface [com.phoenix_int.aserver.types.IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md)
Gets a PHXStringBuffer representation of the type +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md)
converts the variable to a PHXStringBuffer +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
converts the variable to a PHXStringBuffer +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.md)
Deprecated.converts the variable to a string +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md)
converts the variable to a PHXStringBuffer +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated.converts the variable to a PHXStringBuffer +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
converts the variable to a PHXStringBuffer +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Gets a PHXStringBuffer representation of the contents of the temporary file. +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
converts to a PHXStringBuffer +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
converts the variable to a PHXStringBuffer +- **toString2(String)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Converts a single element to a string +- **toString2(int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Converts a single element to a string +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Returns the string form of this array. +- **toString2()** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
converts the variable to a PHXStringBuffer +- **toString3()** - Method in class [com.phoenix_int.aserver.PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md)
+- **toXML()** - Method in class [com.phoenix_int.aserver.PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md)
Converts this branch into an XML String +- **toXML()** - Method in class [com.phoenix_int.aserver.types.PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md)
get XML representation of the object +- **toXML()** - Method in class [com.phoenix_int.aserver.util.PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md)
Converts this process information into a usable XML description +- **tr(String)** - Method in class [com.phoenix_int.util.PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md)
+- **tr(String, Object...)** - Method in class [com.phoenix_int.util.PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md)
+- **trace(String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Prints a string to the trace window +- **transferArray(PHXSimpleArray, int, int, int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular array. +- **transferArray(PHXSimpleArray, int, int, int, int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular array. +- **transferArray(PHXSimpleArray, int, int, int, int, boolean, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular array. +- **transferArray(PHXSimpleArray, int, int, int, int, boolean, String, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular array. +- **transferArray(PHXSimpleArray, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Transfer an array of values, either from the file to the variable, or vice-versa, depending on [ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md) +- **transferKeyVar(PHXSimpleType, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular variable. +- **transferKeyVar(PHXSimpleType, String, int, int, int, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular variable. +- **transferVar(PHXSimpleType, int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular variable. +- **transferVar(String, PHXSimpleType, int, int)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
+- **transferVar(PHXSimpleType, int, int, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Transfers the data for a particular variable. +- **transferVar(String, PHXSimpleType, int, int, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
+- **transferVar(IPHXType, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Transfer a value, either from the file to the variable, or vice-versa, depending on [ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md) +- **transferVars(ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md)
Transfer values for variables that have been defined using methods from the concrete implementation, i.e. +- **transferVars(ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md)
+- **transferVars(ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Note that if wrapper is null, variable collection should be empty, and there should be no harm in calling this method +- **transferVars(ParseableFile.Mode)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Transfer values for variables that have been defined using methods from the concrete implementation, i.e. +- **trLazy(String)** - Method in class [com.phoenix_int.util.PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md)
Return a lazily instantiated translation message that can be computed only if needed. +- **trLazy(String, Object...)** - Method in class [com.phoenix_int.util.PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md)
Return a lazily instantiated translation message that can be computed only if needed. + +# U + +- **unblock()** - Method in class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md) +- **unblockAll()** - Method in class [com.phoenix_int.util.PHXBlocker](com/phoenix_int/util/PHXBlocker.md)
Same as unblock except designed for multiple waiters. +- **UNKNOWN** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for an unknown type +- **UNKNOWN_ARRAY** - Static variable in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
Type identifier for an unknown array type +- **unlock()** - Method in class [com.phoenix_int.aserver.PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md)
Unlocks the runshare mechanisms. +- **unmanageTempFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Ensure that the file containing the current contents is not deleted when the last handle to it is released. +- **updateConsoleVariables()** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md) + +# V + +- **validElement(int[], int[])** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Is the given index valid? +- **valueOf(String)** - Static method in enum [com.phoenix_int.aserver.client.v2.AnalysisServerResponseType](com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md)
Returns the enum constant of this type with the specified name. +- **valueOf(String)** - Static method in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.md)
Returns the enum constant of this type with the specified name. +- **valueOf(String)** - Static method in enum [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md)
Returns the enum constant of this type with the specified name. +- **valueOf(String)** - Static method in enum [com.phoenix_int.pacz.api.RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.md)
Deprecated. Returns the enum constant of this type with the specified name. +- **valueOf(String)** - Static method in enum [com.phoenix_int.pacz.api.v2.RunFolderPreference](com/phoenix_int/pacz/api/v2/RunFolderPreference.md)
Returns the enum constant of this type with the specified name. +- **valueOf(String)** - Static method in enum [com.phoenix_int.pacz.api.VariableDataType](com/phoenix_int/pacz/api/VariableDataType.md)
Deprecated. Returns the enum constant of this type with the specified name. +- **values()** - Static method in enum [com.phoenix_int.aserver.client.v2.AnalysisServerResponseType](com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md)
Returns an array containing the constants of this enum type, in the order they are declared. +- **values()** - Static method in enum [com.phoenix_int.aserver.util.Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.md)
Returns an array containing the constants of this enum type, in the order they are declared. +- **values()** - Static method in enum [com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md)
Returns an array containing the constants of this enum type, in the order they are declared. +- **values()** - Static method in enum [com.phoenix_int.pacz.api.RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.md)
Deprecated. Returns an array containing the constants of this enum type, in the order they are declared. +- **values()** - Static method in enum [com.phoenix_int.pacz.api.v2.RunFolderPreference](com/phoenix_int/pacz/api/v2/RunFolderPreference.md)
Returns an array containing the constants of this enum type, in the order they are declared. +- **values()** - Static method in enum [com.phoenix_int.pacz.api.VariableDataType](com/phoenix_int/pacz/api/VariableDataType.md)
Deprecated. Returns an array containing the constants of this enum type, in the order they are declared. +- **VariableDataType** - Enum in [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api/VariableDataType.md)
Deprecated. IRuntimeVariables are now using the canonical PHX type identifiers which are literal strings (see com.phoenix_int.pacz.api.v2) +- **VI_AVAILABLE** - Static variable in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **VI_UNAVAILABLE** - Static variable in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **VI_UNKNOWN** - Static variable in class [com.phoenix_int.aserver.PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) +- **visit(PHXBoolean)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXBoolean. +- **visit(PHXLong)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXLong. +- **visit(PHXDouble)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXDouble. +- **visit(PHXString)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXString. +- **visit(PHXRawFile)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXRawFile. +- **visit(PHXGeometry)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXGeometry. +- **visit(PHXBooleanArray)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXBooleanArray. +- **visit(PHXLongArray)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXLongArray. +- **visit(PHXDoubleArray)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXDoubleArray. +- **visit(PHXStringArray)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXStringArray. +- **visit(PHXRawFileArray)** - Method in interface [com.phoenix_int.aserver.types.IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)
Visit a PHXRawFileArray. + +# W + +- **waitFor()** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **waitForMonitorDeath()** - Method in class [com.phoenix_int.aserver.monitors.PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md) +- **waitForResponse()** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md)
Wait until the response has been received, if it has not already. +- **waitForResponse(int)** - Method in class [com.phoenix_int.aserver.client.v2.AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md)
Wait until the response has been received, if it has not already. +- **wasLastTokenQuoted()** - Method in class [com.phoenix_int.aserver.util.PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md)
indicates whether the last token retrieved was a quoted string +- **wrapErrorStream(IPHXStreamRegExListener)** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **wrapInputStream(IPHXStreamRegExListener)** - Method in class [com.phoenix_int.aserver.util.PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) +- **wrapper** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) +- **write(char[], int, int)** - Method in class [com.phoenix_int.aserver.monitors.PHXMonitorableStream.MonitorWriter](com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md) +- **write(byte[])** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **write(byte[], int, int)** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **writeFile(String)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Sets the filename and then writes from the temp file to the actual file. +- **writeFile()** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md)
Writes from the temp file to the actual file. +- **writeFile(String, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md)
Write the given file variable out to the specified file +- **writeTo(OutputStreamWriter)** - Method in interface [com.phoenix_int.aserver.util.Parser](com/phoenix_int/aserver/util/Parser.md)
Write any changes to the output stream +- **writeTo(String)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **writeTo(String, PHXFileUtils.Encoding)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **writeTo(OutputStream)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) +- **writeTo(OutputStreamWriter)** - Method in class [com.phoenix_int.aserver.util.PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md)
writes out the data to a file +- **writeTo(OutputStream)** - Method in class [com.phoenix_int.aserver.util.PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md)
Writes this string buffer out to an output stream efficiently does utf-8 conversion before writing +- **writeValue(int, int, String)** - Method in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md)
Writes a token out to the output file. + +# X + +- **XPathFile** - Class in [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Represents an XML file (not a file variable) used in a script wrapper, with access to the XML node values via XPath statements +- **XPathFile(PHXScriptWrapperObject, ParseableFile.Mode)** - Constructor for class [com.phoenix_int.aserver.util.scriptwrapper.api.XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md)
Construct a new XPathFile + +# _ + +- **_actualPos** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_buffer** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_bufStart** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_copyMetadataFromOther(PHXDouble)** - Method in class [com.phoenix_int.aserver.types.PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md)
Clone another PHXDouble's metadata. +- **_copyMetadataFromOther(PHXInteger)** - Method in class [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md)
Deprecated. Clone another PHXInteger's metadata. +- **_copyMetadataFromOther(PHXLong)** - Method in class [com.phoenix_int.aserver.types.PHXLong](com/phoenix_int/aserver/types/PHXLong.md)
Clone another PHXLong's metadata. +- **_copyMetadataFromOther(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md)
Copy common metadata on PHXSimpleType from another object to this one. +- **_copyMetadataFromOther(PHXString)** - Method in class [com.phoenix_int.aserver.types.PHXString](com/phoenix_int/aserver/types/PHXString.md)
Clone another PHXString's metadata. +- **_data** - Variable in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **_fileLen** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_filePos** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_getMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **_getMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **_getMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) +- **_getMetaData()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Gets the meta data off of the first element of the array and sets it into our meta data info. +- **_getMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. +- **_getMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **_getProperty(String)** - Method in class [com.phoenix_int.aserver.types.PHXReference](com/phoenix_int/aserver/types/PHXReference.md)
retrieves a named property +- **_lockDims** - Variable in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **_lockResize** - Variable in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md) +- **_prop** - Variable in class [com.phoenix_int.aserver.client.PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.md) +- **_readBuf()** - Method in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_readOffset** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_setContentFromOther(PHXRawFile)** - Method in class [com.phoenix_int.aserver.types.PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) +- **_setMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **_setMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **_setMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) +- **_setMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Sets a simple type's meta data based on the meta data in this object. +- **_setMetaData()** - Method in class [com.phoenix_int.aserver.types.PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)
Call this function to set the meta data from this object into every element of the array. +- **_setMetaData(PHXSimpleType)** - Method in class [com.phoenix_int.aserver.types.PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) +- **_sort(PHXDoubleArray, boolean)** - Method in class [com.phoenix_int.aserver.types.PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) +- **_sort(PHXLongArray, boolean)** - Method in class [com.phoenix_int.aserver.types.PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) +- **_verifyIsArrayType(String)** - Static method in class [com.phoenix_int.aserver.types.PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md)
utility function for verifying that a type string is an array type - it is in the form "XXXX[#]" +- **_wrapped** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) +- **_writeOffset** - Variable in class [com.phoenix_int.util.BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md)
diff --git a/2025R2/modelCenter_java_api/index.md b/2025R2/modelCenter_java_api/index.md new file mode 100644 index 0000000000..39c397a88e --- /dev/null +++ b/2025R2/modelCenter_java_api/index.md @@ -0,0 +1,87 @@ +This document contains the ModelCenter Java API. + +## How This API Document Is Organized +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows. + +### Overview + +The [Overview](overview-summary.html) page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages. + +### Package + +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories: + +- Interfaces (italic) +- Classes +- Enums +- Exceptions +- Errors +- Annotation Types + +### Class/Interface + +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions: + +- **class/interface description** + - Class inheritance diagram + - Direct Subclasses + - All Known Subinterfaces + - All Known Implementing Classes + - Class/interface declaration + - Class/interface description +- **summary tables** + - Nested Class Summary + - Field Summary + - Constructor Summary + - Method Summary +- **detailed member descriptions** + - Field Detail + - Constructor Detail + - Method Detail + +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer. + +### Annotation Type + +Each annotation type has its own separate page with the following sections: + +- Annotation Type declaration +- Annotation Type description +- Required Element Summary +- Optional Element Summary +- Element Detail + +### Enum + +Each enum has its own separate page with the following sections: + +- Enum declaration +- Enum description +- Enum Constant Summary +- Enum Constant Detail + +### Tree (Class Hierarchy) + +There is a [Class Hierarchy](overview-tree.html) page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with `java.lang.Object`. The interfaces do not inherit from `java.lang.Object`. + +### Deprecated API + +The [Deprecated API](deprecated-list.html) page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations. + +### Index + +The [Index](index-all.html) contains an alphabetic list of all classes, interfaces, constructors, methods, and fields. + +### All Classes + +The [All Classes](allclasses-noframe.html) link shows all classes and interfaces except non-static nested types. + +### Serialized Form + +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. + +### Constant Field Values + +The [Constant Field Values](constant-values.html) page lists the static final fields and their values. + +This help file applies to API documentation generated using the standard doclet. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/overview-summary.md b/2025R2/modelCenter_java_api/overview-summary.md new file mode 100644 index 0000000000..0e8c6f2fa6 --- /dev/null +++ b/2025R2/modelCenter_java_api/overview-summary.md @@ -0,0 +1,22 @@ +# Overview Summary + +| Package | Description | +| --- | --- | +| [com.phoenix_int.aserver](com/phoenix_int/aserver/package-summary.html) | | +| [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/package-summary.html) | Provides a client package for programmatically invoking the Analysis Server +remotely from the Java language. | +| [com.phoenix_int.aserver.client.v2](com/phoenix_int/aserver/client/v2/package-summary.html) | | +| [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/package-summary.html) | Provides a library of available components and catgories (directories) and +factories for instantiating components. | +| [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/package-summary.html) | Provides interfaces and classes for adding process and output monitoring +of components. | +| [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/package-summary.html) | Provides a collection of basic data types that contain meta-information +like description and units. | +| [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/package-summary.html) | Provides general purpose utility functions. | +| [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.html) | Provides utilities which are designed to make writing ScriptWrappers +with FileWrapper-like capabilities. | +| [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api/package-summary.html) | PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products Analysis + Server and ModelCenter Server. | +| [com.phoenix_int.pacz.api.v2](com/phoenix_int/pacz/api/v2/package-summary.html) | PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products Analysis + Server and ModelCenter Server. | +| [com.phoenix_int.util](com/phoenix_int/util/package-summary.html) | | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/overview-tree.md b/2025R2/modelCenter_java_api/overview-tree.md new file mode 100644 index 0000000000..de670fa8a1 --- /dev/null +++ b/2025R2/modelCenter_java_api/overview-tree.md @@ -0,0 +1,201 @@ +# Hierarchy For All Packages +## Package Hierarchies +- [com.phoenix_int.aserver](com/phoenix_int/aserver/package-tree.html) +- [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/package-tree.html) +- [com.phoenix_int.aserver.client.v2](com/phoenix_int/aserver/client/v2/package-tree.html) +- [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/package-tree.html) +- [com.phoenix_int.aserver.monitors](com/phoenix_int/aserver/monitors/package-tree.html) +- [com.phoenix_int.aserver.types](com/phoenix_int/aserver/types/package-tree.html) +- [com.phoenix_int.aserver.util](com/phoenix_int/aserver/util/package-tree.html) +- [com.phoenix_int.aserver.util.scriptwrapper.api](com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.html) +- [com.phoenix_int.pacz.api](com/phoenix_int/pacz/api/package-tree.html) +- [com.phoenix_int.pacz.api.v2](com/phoenix_int/pacz/api/v2/package-tree.html) +- [com.phoenix_int.util](com/phoenix_int/util/package-tree.html) + +## Class Hierarchy + +- java.lang.Object +- com.phoenix_int.aserver.util.scriptwrapper.api.[AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.html) (implements java.io.Closeable, com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html)) +- com.phoenix_int.aserver.util.scriptwrapper.api.[CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) +- com.phoenix_int.aserver.util.scriptwrapper.api.[XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) +- java.util.AbstractMap`` (implements java.util.Map``) +- java.util.HashMap`` (implements java.lang.Cloneable, java.util.Map``, java.io.Serializable) +- com.phoenix_int.pacz.api.[Environment](com/phoenix_int/pacz/api/Environment.html) +- com.phoenix_int.pacz.api.v2.[Environment](com/phoenix_int/pacz/api/v2/Environment.html) +- com.phoenix_int.aserver.client.v2.[AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.html) (implements java.lang.AutoCloseable) +- com.phoenix_int.aserver.client.v2.[AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.html) +- com.phoenix_int.aserver.client.v2.[AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.html) (implements java.lang.Comparable``) +- com.phoenix_int.aserver.client.v2.[AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.html) (implements com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html)) +- com.phoenix_int.aserver.client.v2.[AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.html) +- com.phoenix_int.util.[BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.html) +- java.util.EventObject (implements java.io.Serializable) +- com.phoenix_int.aserver.client.[PHXAnalysisClientEvent](com/phoenix_int/aserver/client/PHXAnalysisClientEvent.html) +- com.phoenix_int.aserver.client.[PHXAnalysisClientExceptionEvent](com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.html) +- com.phoenix_int.aserver.client.[PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.html) +- com.phoenix_int.aserver.types.[PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.html) +- com.phoenix_int.util.[PHXBlocker](com/phoenix_int/util/PHXBlocker.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.html) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html)) +- com.phoenix_int.aserver.[PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.html) +- com.phoenix_int.aserver.[PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.html) +- com.phoenix_int.aserver.[PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.html) +- com.phoenix_int.aserver.library.[PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.html) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) +- com.phoenix_int.aserver.types.[PHXDataCollector](com/phoenix_int/aserver/types/PHXDataCollector.html) +- com.phoenix_int.aserver.library.[PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.html) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) +- com.phoenix_int.aserver.util.[PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.html) +- com.phoenix_int.aserver.monitors.[PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.html) +- com.phoenix_int.aserver.util.[PHXFileName](com/phoenix_int/aserver/util/PHXFileName.html) +- com.phoenix_int.aserver.util.[PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.html) (implements com.phoenix_int.aserver.util.[Parser](com/phoenix_int/aserver/util/Parser.html)) +- com.phoenix_int.aserver.types.[PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.html) +- com.phoenix_int.aserver.[PHXGroup](com/phoenix_int/aserver/PHXGroup.html) +- com.phoenix_int.aserver.util.[PHXIcon](com/phoenix_int/aserver/util/PHXIcon.html) +- com.phoenix_int.util.[PHXInternationalize](com/phoenix_int/util/PHXInternationalize.html) +- com.phoenix_int.aserver.[PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.html) +- com.phoenix_int.aserver.library.[PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.html) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) +- com.phoenix_int.aserver.library.[PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.html) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) +- com.phoenix_int.aserver.types.[PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.html) +- com.phoenix_int.aserver.[PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.html) +- com.phoenix_int.aserver.monitors.[PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.html) +- com.phoenix_int.aserver.util.[PHXNameDivider](com/phoenix_int/aserver/util/PHXNameDivider.html) +- com.phoenix_int.aserver.types.[PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.html) +- com.phoenix_int.aserver.util.[PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.html) +- com.phoenix_int.aserver.[PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.html) +- com.phoenix_int.aserver.client.[PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.html) +- com.phoenix_int.aserver.types.[PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.html) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.html)) +- com.phoenix_int.aserver.types.[PHXReference](com/phoenix_int/aserver/types/PHXReference.html) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.html), com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html)) +- com.phoenix_int.aserver.types.[PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.html) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.html)) +- com.phoenix_int.aserver.types.[PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.html) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.html)) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.html) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html)) +- com.phoenix_int.aserver.[PHXRunShare](com/phoenix_int/aserver/PHXRunShare.html) (implements com.phoenix_int.aserver.[IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.html), com.phoenix_int.aserver.trace.IPHXTraceGenerator) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRunShareContext](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.html) +- com.phoenix_int.aserver.[PHXRunShare.RunInfo](com/phoenix_int/aserver/PHXRunShare.RunInfo.html) +- com.phoenix_int.aserver.util.[PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.html) (implements java.lang.Cloneable) +- com.phoenix_int.aserver.[PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.html) (implements com.phoenix_int.aserver.[IPHXComponent](com/phoenix_int/aserver/IPHXComponent.html), com.phoenix_int.aserver.[IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.html)) +- com.phoenix_int.aserver.[PHXSimpleSelfManager2](com/phoenix_int/aserver/PHXSimpleSelfManager2.html) (implements com.phoenix_int.aserver.[IPHXSelfManager2](com/phoenix_int/aserver/IPHXSelfManager2.html)) +- com.phoenix_int.aserver.[PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.html) (implements com.phoenix_int.aserver.IPHXConnector, com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.html)) +- com.phoenix_int.aserver.types.[PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.html) (implements com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.html)) +- com.phoenix_int.aserver.types.[PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.html) +- com.phoenix_int.aserver.types.[PHXDouble](com/phoenix_int/aserver/types/PHXDouble.html) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXFile](com/phoenix_int/aserver/types/PHXFile.html) +- com.phoenix_int.aserver.types.[PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.html) +- com.phoenix_int.aserver.types.[PHXInteger](com/phoenix_int/aserver/types/PHXInteger.html) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXLong](com/phoenix_int/aserver/types/PHXLong.html) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.html) (implements java.lang.AutoCloseable, com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html)) +- com.phoenix_int.aserver.types.[PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.html) +- com.phoenix_int.aserver.types.[PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.html)`` (implements com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html), java.lang.Iterable``) +- com.phoenix_int.aserver.types.[PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.html) +- com.phoenix_int.aserver.types.[PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.html) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.html) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.html)) +- com.phoenix_int.aserver.types.[PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.html) +- com.phoenix_int.aserver.types.[PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.html) +- com.phoenix_int.aserver.types.[PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.html) +- com.phoenix_int.aserver.types.[PHXString](com/phoenix_int/aserver/types/PHXString.html) +- com.phoenix_int.aserver.util.[PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.html) (implements java.io.Serializable) +- com.phoenix_int.aserver.util.[PHXStringReplacer](com/phoenix_int/aserver/util/PHXStringReplacer.html) +- com.phoenix_int.aserver.util.[PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.html) (implements java.util.Enumeration``) +- com.phoenix_int.aserver.types.[PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.html) +- com.phoenix_int.aserver.library.[PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.html) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) +- com.phoenix_int.aserver.[PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.html) +- java.lang.Process +- com.phoenix_int.aserver.util.[PHXProcess](com/phoenix_int/aserver/util/PHXProcess.html) (implements com.phoenix_int.aserver.util.IPHXStreamRegExListener) +- java.io.Reader (implements java.io.Closeable, java.lang.Readable) +- com.phoenix_int.util.[PHXNewLineAddFilter](com/phoenix_int/util/PHXNewLineAddFilter.html) +- com.phoenix_int.util.[PHXNewLineFilter](com/phoenix_int/util/PHXNewLineFilter.html) +- java.lang.Throwable (implements java.io.Serializable) +- java.lang.Exception +- com.phoenix_int.aserver.client.v2.[AnalysisServerException](com/phoenix_int/aserver/client/v2/AnalysisServerException.html) +- java.io.IOException +- com.phoenix_int.aserver.monitors.[PHXFileMonitor.FileMonitorChangeException](com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.html) +- com.phoenix_int.aserver.[ProcessHaltedException](com/phoenix_int/aserver/ProcessHaltedException.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmarkNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.html) +- com.phoenix_int.aserver.[PHXDFTException](com/phoenix_int/aserver/PHXDFTException.html) +- com.phoenix_int.aserver.util.[PHXGetByUrlException](com/phoenix_int/aserver/util/PHXGetByUrlException.html) +- com.phoenix_int.aserver.[PHXInvalidNameException](com/phoenix_int/aserver/PHXInvalidNameException.html) +- com.phoenix_int.aserver.types.[PHXInvalidTypeException](com/phoenix_int/aserver/types/PHXInvalidTypeException.html) +- com.phoenix_int.aserver.[PHXNameAlreadyInUseException](com/phoenix_int/aserver/PHXNameAlreadyInUseException.html) +- com.phoenix_int.aserver.library.[PHXNoSuchAssociationException](com/phoenix_int/aserver/library/PHXNoSuchAssociationException.html) +- com.phoenix_int.aserver.library.[PHXNoSuchCategoryException](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.html) +- com.phoenix_int.aserver.library.[PHXNoSuchIconException](com/phoenix_int/aserver/library/PHXNoSuchIconException.html) +- com.phoenix_int.aserver.[PHXNoSuchObjectException](com/phoenix_int/aserver/PHXNoSuchObjectException.html) +- com.phoenix_int.aserver.[PHXNoSuchWriteableObjectException](com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.html) +- com.phoenix_int.aserver.util.[PHXNoSuchReplacementException](com/phoenix_int/aserver/util/PHXNoSuchReplacementException.html) +- com.phoenix_int.aserver.client.[PHXNoSuchResponseException](com/phoenix_int/aserver/client/PHXNoSuchResponseException.html) +- com.phoenix_int.aserver.util.[PHXNoSuchTokenException](com/phoenix_int/aserver/util/PHXNoSuchTokenException.html) +- com.phoenix_int.aserver.types.[PHXNumberFormatException](com/phoenix_int/aserver/types/PHXNumberFormatException.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperAPIException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSectionNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.html) +- com.phoenix_int.aserver.client.[PHXServerSideException](com/phoenix_int/aserver/client/PHXServerSideException.html) +- com.phoenix_int.aserver.types.[PHXTypeMismatchException](com/phoenix_int/aserver/types/PHXTypeMismatchException.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXVersionException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.html) +- java.lang.ReflectiveOperationException +- java.lang.ClassNotFoundException +- com.phoenix_int.aserver.util.[PHXClassNotFoundException](com/phoenix_int/aserver/util/PHXClassNotFoundException.html) +- java.lang.RuntimeException +- com.phoenix_int.aserver.client.[PHXResponseTypeMismatchException](com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.html) +- java.io.Writer (implements java.lang.Appendable, java.io.Closeable, java.io.Flushable) +- com.phoenix_int.aserver.monitors.[PHXMonitorableStream.MonitorWriter](com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.html) + +## Interface Hierarchy + +- java.util.EventListener +- com.phoenix_int.aserver.client.[IPHXAnalysisClientListener](com/phoenix_int/aserver/client/IPHXAnalysisClientListener.html) +- com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html) +- com.phoenix_int.pacz.api.[IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.html) +- com.phoenix_int.pacz.api.v2.[IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.html) +- com.phoenix_int.pacz.api.[IInstanceFile](com/phoenix_int/pacz/api/IInstanceFile.html) +- com.phoenix_int.pacz.api.v2.[IInstanceFile](com/phoenix_int/pacz/api/v2/IInstanceFile.html) +- com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.html) +- com.phoenix_int.aserver.[IPHXComponent](com/phoenix_int/aserver/IPHXComponent.html) +- com.phoenix_int.aserver.[IPHXAnalysis](com/phoenix_int/aserver/IPHXAnalysis.html) +- com.phoenix_int.aserver.[IPHXDriver](com/phoenix_int/aserver/IPHXDriver.html) +- com.phoenix_int.aserver.types.[IPHXDescription](com/phoenix_int/aserver/types/IPHXDescription.html) +- com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.html) +- com.phoenix_int.aserver.library.[IPHXFactory](com/phoenix_int/aserver/library/IPHXFactory.html) +- com.phoenix_int.aserver.monitors.[IPHXFileCallback](com/phoenix_int/aserver/monitors/IPHXFileCallback.html) +- com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.html) +- com.phoenix_int.aserver.[IPHXHaltableComponent](com/phoenix_int/aserver/IPHXHaltableComponent.html) +- com.phoenix_int.aserver.library.[IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.html) +- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian](com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html) +- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) +- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) +- com.phoenix_int.aserver.util.[IPHXLineStore](com/phoenix_int/aserver/util/IPHXLineStore.html) +- com.phoenix_int.aserver.[IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRangeChangeListener](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.html) +- com.phoenix_int.aserver.[IPHXRunQueue](com/phoenix_int/aserver/IPHXRunQueue.html) +- com.phoenix_int.aserver.[IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.html) +- com.phoenix_int.aserver.[IPHXSelfManager2](com/phoenix_int/aserver/IPHXSelfManager2.html) +- com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.html) +- com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.html) +- com.phoenix_int.aserver.[IPHXSetupFromFile](com/phoenix_int/aserver/IPHXSetupFromFile.html) +- com.phoenix_int.aserver.util.[IPHXStringReplacer](com/phoenix_int/aserver/util/IPHXStringReplacer.html) +- com.phoenix_int.aserver.types.[IPHXType](com/phoenix_int/aserver/types/IPHXType.html) +- com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html) +- com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) (also extends com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.html), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) +- com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.html), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) +- com.phoenix_int.aserver.types.[IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.html)`` +- com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.html) +- com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) +- com.phoenix_int.pacz.api.[IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.html) +- com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata +- com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.html)) +- com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) +- com.phoenix_int.aserver.util.[Parser](com/phoenix_int/aserver/util/Parser.html) +- com.phoenix_int.util.[PHXInternationalize.InternationalizedMessage](com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.html) + +## Enum Hierarchy + +- java.lang.Object +- java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) +- com.phoenix_int.aserver.client.v2.[AnalysisServerResponseType](com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.html) +- com.phoenix_int.aserver.util.[Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html) +- com.phoenix_int.pacz.api.[RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.html) +- com.phoenix_int.pacz.api.[VariableDataType](com/phoenix_int/pacz/api/VariableDataType.html) +- com.phoenix_int.pacz.api.v2.[RunFolderPreference](com/phoenix_int/pacz/api/v2/RunFolderPreference.html) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/serialized-form.md b/2025R2/modelCenter_java_api/serialized-form.md new file mode 100644 index 0000000000..b49d529751 --- /dev/null +++ b/2025R2/modelCenter_java_api/serialized-form.md @@ -0,0 +1,286 @@ +# Serialized Form +## Package com.phoenix_int.aserver + +### Class com.phoenix_int.aserver.PHXCannotSetRunDirectoryException extends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.PHXDFTExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.PHXInvalidNameExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.PHXLockException extends java.io.IOException implements Serializable +### Class com.phoenix_int.aserver.PHXNameAlreadyInUseExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.PHXNoSuchObjectExceptionextends java.lang.Exception implements Serializable +#### Serialized Fields +##### _invalidObject +```java +java.lang.String _invalidObject +``` +### Class com.phoenix_int.aserver.PHXNoSuchWriteableObjectExceptionextendsPHXNoSuchObjectExceptionimplements Serializable +### Class com.phoenix_int.aserver.ProcessHaltedExceptionextends java.io.IOException implements Serializable +## Package com.phoenix_int.aserver.client + +### Class com.phoenix_int.aserver.client.PHXAnalysisClientEventextends java.util.EventObject implements Serializable + +#### Serialized Fields + +##### _response + +```java +com.phoenix_int.aserver.client.PHXResponse _response +``` +### Class com.phoenix_int.aserver.client.PHXAnalysisClientExceptionEventextends java.util.EventObject implements Serializable + +#### Serialized Fields + +##### _exception + +```java +java.lang.Exception _exception +``` +### Class com.phoenix_int.aserver.client.PHXNoSuchResponseExceptionextends java.lang.Exception implements Serializable + +#### Serialized Fields + +##### _invalidID + +```java +java.lang.String _invalidID +``` +### Class com.phoenix_int.aserver.client.PHXResponseTypeMismatchExceptionextends java.lang.RuntimeException implements Serializable + +#### Serialized Fields + +##### _invalidID + +```java +java.lang.String _invalidID +``` +### Class com.phoenix_int.aserver.client.PHXServerSideExceptionextends java.lang.Exception implements Serializable +## Package com.phoenix_int.aserver.client.v2 + +### Class com.phoenix_int.aserver.client.v2.AnalysisServerExceptionextends java.lang.Exception implements Serializable + +## Package com.phoenix_int.aserver.library + +### Class com.phoenix_int.aserver.library.PHXNoSuchAssociationExceptionextends java.lang.Exception implements Serializable + +#### Serialized Fields + +##### _invalidAssociation + +```java +java.lang.String _invalidAssociation +``` +### Class com.phoenix_int.aserver.library.PHXNoSuchCategoryExceptionextends java.lang.Exception implements Serializable + +#### Serialized Fields + +##### _invalidCategory + +```java +java.lang.String _invalidCategory +``` +### Class com.phoenix_int.aserver.library.PHXNoSuchIconExceptionextends java.lang.Exception implements Serializable + +#### Serialized Fields + +##### _invalidIcon + +```java +java.lang.String _invalidIcon +``` +## Package com.phoenix_int.aserver.monitors + +### Class com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeExceptionextends java.io.IOException implements Serializable +## Package com.phoenix_int.aserver.types + +### Class com.phoenix_int.aserver.types.PHXInvalidTypeExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.types.PHXNumberFormatExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.types.PHXTypeMismatchExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.types.VariableValueInvalidException extends java.lang.Exception implements Serializable +## Package com.phoenix_int.aserver.util + +### Class com.phoenix_int.aserver.util.PHXClassNotFoundExceptionextends java.lang.ClassNotFoundException implements Serializable + +#### Serialized Fields + +##### innerException + +```java +java.util.ArrayList innerException +``` +### Class com.phoenix_int.aserver.util.PHXExecutableKeywords extends java.util.Properties implements Serializable +### Class com.phoenix_int.aserver.util.PHXFileFormatException extends java.io.IOException implements Serializable + +#### Serialized Fields + +##### _line + +```java +java.lang.String _line +``` +##### _lineNum + +```java +int _lineNum +``` +##### _filename + +```java +java.lang.String _filename +``` +##### _wrapped + +```java +java.lang.Exception _wrapped +``` +### Class com.phoenix_int.aserver.util.PHXFrame extends java.awt.Frame implements Serializable +### Class com.phoenix_int.aserver.util.PHXGetByUrlExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.PHXInternalException extends java.lang.RuntimeException implements Serializable + +#### Serialized Fields + +##### _location + +```java +java.lang.String _location +``` +### Class com.phoenix_int.aserver.util.PHXInvalidFormatException extends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.PHXMessageBox extends java.awt.Dialog implements Serializable +### Class com.phoenix_int.aserver.util.PHXNoSuchBookmarkException extends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.PHXNoSuchReplacementExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.PHXNoSuchTokenExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.PHXNumberExpectedException extends com.phoenix_int.aserver.util.PHXFileFormatException implements Serializable +### Class com.phoenix_int.aserver.util.PHXPrompt extends com.phoenix_int.aserver.util.PHXFrame implements Serializable + +#### Serialized Fields + +##### _loop + +```java +boolean _loop +``` +### Class com.phoenix_int.aserver.util.PHXStringBufferextends java.lang.Object implements Serializable + +#### Serialized Fields + +##### _data + +```java +com.phoenix_int.aserver.util.IPHXStringBufferContainer _data +``` +##### _cha + +```java +char[] _cha +``` +### Class com.phoenix_int.aserver.util.PHXSyntaxErrorException extends com.phoenix_int.aserver.util.PHXFileFormatException implements Serializable +### Class com.phoenix_int.aserver.util.PHXTimeoutException extends java.util.concurrent.TimeoutException implements Serializable +### Class com.phoenix_int.aserver.util.PHXValueMissingException extends com.phoenix_int.aserver.util.PHXFileFormatException implements Serializable +## Package com.phoenix_int.aserver.util.scriptwrapper.api + +### Class com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmarkNotFoundExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException extendsPHXNoSuchTokenExceptionimplements Serializable +### Class com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperAPIExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.scriptwrapper.api.PHXSectionNotFoundExceptionextends java.lang.Exception implements Serializable +### Class com.phoenix_int.aserver.util.scriptwrapper.api.PHXVersionExceptionextends java.lang.Exception implements Serializable +## Package com.phoenix_int.pacz.api + +### Class com.phoenix_int.pacz.api.Environmentextends java.util.HashMap implements Serializable +## Package com.phoenix_int.pacz.api.v2 + +### Class com.phoenix_int.pacz.api.v2.Environmentextends java.util.HashMap implements Serializable +## Package com.phoenix_int.util + +### Class com.phoenix_int.util.ConnectTimeoutException extends java.net.ConnectException implements Serializable +### Class com.phoenix_int.util.PHXAlarmEvent extends java.util.EventObject implements Serializable + +#### Serialized Fields + +##### _eventTime + +```java +double _eventTime +``` +##### _actualTime + +```java +double _actualTime +``` +### Class com.phoenix_int.util.PHXDate extends java.lang.Object implements Serializable + +#### Serialized Fields + +##### _cal + +```java +java.util.GregorianCalendar _cal +``` +### Class com.phoenix_int.util.PHXException extends java.lang.Exception implements Serializable + +#### Serialized Fields + +##### _originalException + +```java +java.lang.Throwable _originalException +``` +### Class com.phoenix_int.util.PHXNull extends java.lang.Object implements Serializable +### Class com.phoenix_int.util.PHXReaderEvent extends java.util.EventObject implements Serializable + +#### Serialized Fields + +##### _line + +```java +java.lang.String _line +``` +##### _exception + +```java +java.io.IOException _exception +``` +### Class com.phoenix_int.util.PHXStringEncrypter.PHXEncryptionException extends java.lang.Exception implements Serializable +### Class com.phoenix_int.util.PHXThreadFinishEvent extends java.util.EventObject implements Serializable + +**serialVersionUID:** +: -991727830103190432L + +### Serialization Methods + +##### readObject + +```java +private void readObject(java.io.ObjectInputStream in) + throws java.io.IOException, + java.lang.ClassNotFoundException +``` + +**Throws:** +: `java.io.IOException` +: `java.lang.ClassNotFoundException` +##### writeObject + +```java +private void writeObject(java.io.ObjectOutputStream out) + throws java.io.IOException +``` + +**Throws:** +: `java.io.IOException` +#### Serialized Fields + +##### _success + +```java +boolean _success +``` +##### _results + +```java +java.lang.Object _results +``` +##### _exception + +```java +java.lang.Exception _exception +``` +### Class com.phoenix_int.util.PHXXMLException extends java.lang.Exception implements Serializable +### Class com.phoenix_int.util.TimeException extends java.lang.Exception implements Serializable \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/toc.yaml b/2025R2/modelCenter_java_api/toc.yaml new file mode 100644 index 0000000000..39dd4bdf3a --- /dev/null +++ b/2025R2/modelCenter_java_api/toc.yaml @@ -0,0 +1,404 @@ + - name: ModelCenter Java API + href: index.md + - name: Overview Summary + href: overview-summary.md + - name: Overview Tree + href: overview-tree.md + - name: Deprecated List + href: deprecated-list.md + - name: Index + href: index-all.md + - name: Serialized Form + href: serialized-form.md + - name: Constant Values + href: constant-values.md + - name: com/phoenix_int/aserver + items: + - name: IPHXAlwaysWriteable + href: com/phoenix_int/aserver/IPHXAlwaysWriteable.md + - name: IPHXAnalysis + href: com/phoenix_int/aserver/IPHXAnalysis.md + - name: IPHXComponent + href: com/phoenix_int/aserver/IPHXComponent.md + - name: IPHXDriver + href: com/phoenix_int/aserver/IPHXDriver.md + - name: IPHXHaltableComponent + href: com/phoenix_int/aserver/IPHXHaltableComponent.md + - name: IPHXMonitorable + href: com/phoenix_int/aserver/IPHXMonitorable.md + - name: IPHXRunQueue + href: com/phoenix_int/aserver/IPHXRunQueue.md + - name: IPHXSelfManager + href: com/phoenix_int/aserver/IPHXSelfManager.md + - name: IPHXSelfManager2 + href: com/phoenix_int/aserver/IPHXSelfManager2.md + - name: IPHXSelfManager3 + href: com/phoenix_int/aserver/IPHXSelfManager3.md + - name: IPHXSetupFromFile + href: com/phoenix_int/aserver/IPHXSetupFromFile.md + - name: PHXComponentBranch + href: com/phoenix_int/aserver/PHXComponentBranch.md + - name: PHXComponentDescription + href: com/phoenix_int/aserver/PHXComponentDescription.md + - name: PHXComponentVersion + href: com/phoenix_int/aserver/PHXComponentVersion.md + - name: PHXDFTException + href: com/phoenix_int/aserver/PHXDFTException.md + - name: PHXGroup + href: com/phoenix_int/aserver/PHXGroup.md + - name: PHXInvalidNameException + href: com/phoenix_int/aserver/PHXInvalidNameException.md + - name: PHXInvokeReturn + href: com/phoenix_int/aserver/PHXInvokeReturn.md + - name: PHXMethodDescriptor + href: com/phoenix_int/aserver/PHXMethodDescriptor.md + - name: PHXNameAlreadyInUseException + href: com/phoenix_int/aserver/PHXNameAlreadyInUseException.md + - name: PHXNoSuchObjectException + href: com/phoenix_int/aserver/PHXNoSuchObjectException.md + - name: PHXNoSuchWriteableObjectException + href: com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md + - name: PHXPropertyDescriptor + href: com/phoenix_int/aserver/PHXPropertyDescriptor.md + - name: PHXRunShare + href: com/phoenix_int/aserver/PHXRunShare.md + - name: PHXRunShare.RunInfo + href: com/phoenix_int/aserver/PHXRunShare.RunInfo.md + - name: PHXSimpleSelfManager + href: com/phoenix_int/aserver/PHXSimpleSelfManager.md + - name: PHXSimpleSelfManager2 + href: com/phoenix_int/aserver/PHXSimpleSelfManager2.md + - name: PHXSimpleSelfManager3 + href: com/phoenix_int/aserver/PHXSimpleSelfManager3.md + - name: PHXVariableInfo + href: com/phoenix_int/aserver/PHXVariableInfo.md + - name: ProcessHaltedException + href: com/phoenix_int/aserver/ProcessHaltedException.md + - name: package-summary + href: com/phoenix_int/aserver/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/package-tree.md + - name: client + items: + - name: IPHXAnalysisClientListener + href: com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md + - name: package-summary + href: com/phoenix_int/aserver/client/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/client/package-tree.md + - name: PHXAnalysisClient + href: com/phoenix_int/aserver/client/PHXAnalysisClient.md + - name: PHXAnalysisClientEvent + href: com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md + - name: PHXAnalysisClientExceptionEvent + href: com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md + - name: PHXNoSuchResponseException + href: com/phoenix_int/aserver/client/PHXNoSuchResponseException.md + - name: PHXPropertyValue + href: com/phoenix_int/aserver/client/PHXPropertyValue.md + - name: PHXResponseTypeMismatchException + href: com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md + - name: PHXServerSideException + href: com/phoenix_int/aserver/client/PHXServerSideException.md + - name: v2 + items: + - name: AnalysisServerClient + href: com/phoenix_int/aserver/client/v2/AnalysisServerClient.md + - name: AnalysisServerException + href: com/phoenix_int/aserver/client/v2/AnalysisServerException.md + - name: AnalysisServerResponse + href: com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md + - name: AnalysisServerResponseType + href: com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md + - name: AnalysisServerVersion + href: com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md + - name: AnalysisServerWaitCallback + href: com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md + - name: AnalysisVariableValue + href: com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md + - name: IAnalysisServerCallback + href: com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md + - name: package-summary + href: com/phoenix_int/aserver/client/v2/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/client/v2/package-tree.md + - name: library + items: + - name: IPHXFactory + href: com/phoenix_int/aserver/library/IPHXFactory.md + - name: IPHXLibrarian + href: com/phoenix_int/aserver/library/IPHXLibrarian.md + - name: IPHXVersionedLibrarian + href: com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md + - name: IPHXVersionedLibrarian2 + href: com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md + - name: package-summary + href: com/phoenix_int/aserver/library/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/library/package-tree.md + - name: PHXCVSLibrarian + href: com/phoenix_int/aserver/library/PHXCVSLibrarian.md + - name: PHXDirectoryLibrarian + href: com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md + - name: PHXLibrarianCombiner + href: com/phoenix_int/aserver/library/PHXLibrarianCombiner.md + - name: PHXLibrarianMounter + href: com/phoenix_int/aserver/library/PHXLibrarianMounter.md + - name: PHXNoSuchAssociationException + href: com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md + - name: PHXNoSuchCategoryException + href: com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md + - name: PHXNoSuchIconException + href: com/phoenix_int/aserver/library/PHXNoSuchIconException.md + - name: PHXUserDirLibrarian + href: com/phoenix_int/aserver/library/PHXUserDirLibrarian.md + - name: monitors + items: + - name: IPHXFileCallback + href: com/phoenix_int/aserver/monitors/IPHXFileCallback.md + - name: package-frame + href: com/phoenix_int/aserver/monitors/package-frame.md + - name: package-summary + href: com/phoenix_int/aserver/monitors/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/monitors/package-tree.md + - name: PHXFileMonitor.FileMonitorChangeException + href: com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md + - name: PHXFileMonitor + href: com/phoenix_int/aserver/monitors/PHXFileMonitor.md + - name: PHXMonitorableStream + href: com/phoenix_int/aserver/monitors/PHXMonitorableStream.md + - name: PHXMonitorableStream.MonitorWriter + href: com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md + - name: types + items: + - name: IPHXDescription + href: com/phoenix_int/aserver/types/IPHXDescription.md + - name: IPHXFormat + href: com/phoenix_int/aserver/types/IPHXFormat.md + - name: IPHXRefPropInfo + href: com/phoenix_int/aserver/types/IPHXRefPropInfo.md + - name: IPHXType + href: com/phoenix_int/aserver/types/IPHXType.md + - name: IPHXType2 + href: com/phoenix_int/aserver/types/IPHXType2.md + - name: IPHXType2.IVisitor + href: com/phoenix_int/aserver/types/IPHXType2.IVisitor.md + - name: IPHXUnits + href: com/phoenix_int/aserver/types/IPHXUnits.md + - name: package-frame + href: com/phoenix_int/aserver/types/package-frame.md + - name: package-summary + href: com/phoenix_int/aserver/types/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/types/package-tree.md + - name: PHXAppearance + href: com/phoenix_int/aserver/types/PHXAppearance.md + - name: PHXBoolean + href: com/phoenix_int/aserver/types/PHXBoolean.md + - name: PHXBooleanArray + href: com/phoenix_int/aserver/types/PHXBooleanArray.md + - name: PHXDataCollector + href: com/phoenix_int/aserver/types/PHXDataCollector.md + - name: PHXDouble + href: com/phoenix_int/aserver/types/PHXDouble.md + - name: PHXDoubleArray + href: com/phoenix_int/aserver/types/PHXDoubleArray.md + - name: PHXFile + href: com/phoenix_int/aserver/types/PHXFile.md + - name: PHXGeometry + href: com/phoenix_int/aserver/types/PHXGeometry.md + - name: PHXGeomInfo + href: com/phoenix_int/aserver/types/PHXGeomInfo.md + - name: PHXInteger + href: com/phoenix_int/aserver/types/PHXInteger.md + - name: PHXInvalidTypeException + href: com/phoenix_int/aserver/types/PHXInvalidTypeException.md + - name: PHXLong + href: com/phoenix_int/aserver/types/PHXLong.md + - name: PHXLongArray + href: com/phoenix_int/aserver/types/PHXLongArray.md + - name: PHXMassProperties + href: com/phoenix_int/aserver/types/PHXMassProperties.md + - name: PHXNumberFormatException + href: com/phoenix_int/aserver/types/PHXNumberFormatException.md + - name: PHXObjectArray + href: com/phoenix_int/aserver/types/PHXObjectArray.md + - name: PHXOrientation + href: com/phoenix_int/aserver/types/PHXOrientation.md + - name: PHXRawFile + href: com/phoenix_int/aserver/types/PHXRawFile.md + - name: PHXRawFileArray + href: com/phoenix_int/aserver/types/PHXRawFileArray.md + - name: PHXRefArrayProperty + href: com/phoenix_int/aserver/types/PHXRefArrayProperty.md + - name: PHXReference + href: com/phoenix_int/aserver/types/PHXReference.md + - name: PHXReferenceArray + href: com/phoenix_int/aserver/types/PHXReferenceArray.md + - name: PHXRefProperty + href: com/phoenix_int/aserver/types/PHXRefProperty.md + - name: PHXScriptObject + href: com/phoenix_int/aserver/types/PHXScriptObject.md + - name: PHXSimpleArray + href: com/phoenix_int/aserver/types/PHXSimpleArray.md + - name: PHXSimpleType + href: com/phoenix_int/aserver/types/PHXSimpleType.md + - name: PHXString + href: com/phoenix_int/aserver/types/PHXString.md + - name: PHXStringArray + href: com/phoenix_int/aserver/types/PHXStringArray.md + - name: PHXTypeFactory + href: com/phoenix_int/aserver/types/PHXTypeFactory.md + - name: PHXTypeMismatchException + href: com/phoenix_int/aserver/types/PHXTypeMismatchException.md + - name: util + items: + - name: IPHXLineStore + href: com/phoenix_int/aserver/util/IPHXLineStore.md + - name: IPHXStringReplacer + href: com/phoenix_int/aserver/util/IPHXStringReplacer.md + - name: package-summary + href: com/phoenix_int/aserver/util/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/util/package-tree.md + - name: Parser + href: com/phoenix_int/aserver/util/Parser.md + - name: Parser.Mode + href: com/phoenix_int/aserver/util/Parser.Mode.md + - name: PHXClassNotFoundException + href: com/phoenix_int/aserver/util/PHXClassNotFoundException.md + - name: PHXFileLoader + href: com/phoenix_int/aserver/util/PHXFileLoader.md + - name: PHXFileName + href: com/phoenix_int/aserver/util/PHXFileName.md + - name: PHXFileParser + href: com/phoenix_int/aserver/util/PHXFileParser.md + - name: PHXGetByUrlException + href: com/phoenix_int/aserver/util/PHXGetByUrlException.md + - name: PHXIcon + href: com/phoenix_int/aserver/util/PHXIcon.md + - name: PHXNameDivider + href: com/phoenix_int/aserver/util/PHXNameDivider.md + - name: PHXNoSuchReplacementException + href: com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md + - name: PHXNoSuchTokenException + href: com/phoenix_int/aserver/util/PHXNoSuchTokenException.md + - name: PHXProcess + href: com/phoenix_int/aserver/util/PHXProcess.md + - name: PHXProcessInfo + href: com/phoenix_int/aserver/util/PHXProcessInfo.md + - name: PHXRuntime + href: com/phoenix_int/aserver/util/PHXRuntime.md + - name: PHXStringBuffer + href: com/phoenix_int/aserver/util/PHXStringBuffer.md + - name: PHXStringReplacer + href: com/phoenix_int/aserver/util/PHXStringReplacer.md + - name: PHXStringTokenizer + href: com/phoenix_int/aserver/util/PHXStringTokenizer.md + - name: scriptwrapper + items: + - name: api + items: + - name: AbstractFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md + - name: CAEOutputFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md + - name: InputFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md + - name: IPHXRange + href: com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md + - name: IPHXRangeChangeListener + href: com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md + - name: OutputFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md + - name: OutputFile2 + href: com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md + - name: package-summary + href: com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md + - name: ParseableFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md + - name: ParseableFile.Mode + href: com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md + - name: PHXBookmark + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md + - name: PHXBookmarkNotFoundException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md + - name: PHXCAERange + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md + - name: PHXRowFieldFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md + - name: PHXRowFieldRange + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md + - name: PHXRunShareContext + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md + - name: PHXScriptWrapperAPIException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md + - name: PHXScriptWrapperObject + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md + - name: PHXSection + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md + - name: PHXSectionNotFoundException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md + - name: PHXVersionException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md + - name: XPathFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md + - name: com/phoenix_int/util + items: + - name: BufferedRandomAccessFile + href: com/phoenix_int/util/BufferedRandomAccessFile.md + - name: PHXBlocker + href: com/phoenix_int/util/PHXBlocker.md + - name: PHXInternationalize + href: com/phoenix_int/util/PHXInternationalize.md + - name: PHXInternationalize.InternationalizedMessage + href: com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md + - name: PHXNewLineAddFilter + href: com/phoenix_int/util/PHXNewLineAddFilter.md + - name: PHXNewLineFilter + href: com/phoenix_int/util/PHXNewLineFilter.md + - name: package-summary + href: com/phoenix_int/util/package-summary.md + - name: package-tree + href: com/phoenix_int/util/package-tree.md + - name: com/phoenix_int/pacz/api + items: + - name: Environment + href: com/phoenix_int/pacz/api/Environment.md + - name: IComponentConfig + href: com/phoenix_int/pacz/api/IComponentConfig.md + - name: IInstanceFile + href: com/phoenix_int/pacz/api/IInstanceFile.md + - name: IRuntimeVariable + href: com/phoenix_int/pacz/api/IRuntimeVariable.md + - name: RunFolderPreference + href: com/phoenix_int/pacz/api/RunFolderPreference.md + - name: VariableDataType + href: com/phoenix_int/pacz/api/VariableDataType.md + - name: package-summary + href: com/phoenix_int/pacz/api/package-summary.md + - name: package-tree + href: com/phoenix_int/pacz/api/package-tree.md + - name: v2 + items: + - name: Environment + href: com/phoenix_int/pacz/api/v2/Environment.md + - name: IComponentConfig + href: com/phoenix_int/pacz/api/v2/IComponentConfig.md + - name: IInstanceFile + href: com/phoenix_int/pacz/api/v2/IInstanceFile.md + - name: IRuntimeVariable + href: com/phoenix_int/pacz/api/v2/IRuntimeVariable.md + - name: RunFolderPreference + href: com/phoenix_int/pacz/api/v2/RunFolderPreference.md + - name: VariableDataType + href: com/phoenix_int/pacz/api/v2/VariableDataType.md + - name: package-summary + href: com/phoenix_int/pacz/api/v2/package-summary.md + - name: package-tree + href: com/phoenix_int/pacz/api/v2/package-tree.md + - name: change_log.md + href: change_log.md \ No newline at end of file From caac53e1020c9f768667fde882d7768308dc9b61 Mon Sep 17 00:00:00 2001 From: Leslie Poff Date: Tue, 1 Jul 2025 19:38:46 -0400 Subject: [PATCH 2/3] Updated MCRE Java API --- .../{change_log.md => Changelog.md} | 2 +- .../aserver/IPHXAlwaysWriteable.md | 7 +- .../com/phoenix_int/aserver/IPHXAnalysis.md | 10 +- .../com/phoenix_int/aserver/IPHXComponent.md | 10 +- .../com/phoenix_int/aserver/IPHXDriver.md | 7 +- .../aserver/IPHXHaltableComponent.md | 5 +- .../phoenix_int/aserver/IPHXMonitorable.md | 7 +- .../com/phoenix_int/aserver/IPHXRunQueue.md | 13 +- .../phoenix_int/aserver/IPHXSelfManager.md | 6 +- .../phoenix_int/aserver/IPHXSelfManager2.md | 8 +- .../phoenix_int/aserver/IPHXSelfManager3.md | 8 +- .../phoenix_int/aserver/IPHXSetupFromFile.md | 5 +- .../aserver/PHXComponentDescription.md | 4 +- .../aserver/PHXComponentVersion.md | 1 + .../com/phoenix_int/aserver/PHXGroup.md | 39 +- .../aserver/PHXInvalidNameException.md | 22 +- .../phoenix_int/aserver/PHXInvokeReturn.md | 8 +- .../aserver/PHXMethodDescriptor.md | 12 +- .../aserver/PHXNoSuchObjectException.md | 2 +- .../PHXNoSuchWriteableObjectException.md | 2 +- .../aserver/PHXPropertyDescriptor.md | 46 +- .../aserver/PHXRunShare.RunInfo.md | 4 +- .../com/phoenix_int/aserver/PHXRunShare.md | 14 +- .../aserver/PHXSimpleSelfManager.md | 237 ++--- .../aserver/PHXSimpleSelfManager2.md | 12 +- .../aserver/PHXSimpleSelfManager3.md | 28 +- .../phoenix_int/aserver/PHXVariableInfo.md | 4 +- .../client/IPHXAnalysisClientListener.md | 6 +- .../aserver/client/PHXAnalysisClient.md | 259 ++--- .../aserver/client/PHXAnalysisClientEvent.md | 2 +- .../client/PHXAnalysisClientExceptionEvent.md | 2 +- .../aserver/client/package-summary.md | 26 +- .../aserver/client/package-tree.md | 18 +- .../aserver/client/v2/AnalysisServerClient.md | 106 +- .../client/v2/AnalysisServerResponse.md | 23 +- .../client/v2/AnalysisServerWaitCallback.md | 10 +- .../client/v2/IAnalysisServerCallback.md | 2 +- .../aserver/client/v2/package-summary.md | 16 +- .../aserver/client/v2/package-tree.md | 18 +- .../aserver/library/IPHXFactory.md | 186 ++-- .../aserver/library/IPHXLibrarian.md | 235 +++-- .../aserver/library/IPHXVersionedLibrarian.md | 82 +- .../library/IPHXVersionedLibrarian2.md | 61 +- .../aserver/library/PHXCVSLibrarian.md | 597 ++++++----- .../aserver/library/PHXDirectoryLibrarian.md | 427 +++----- .../aserver/library/PHXLibrarianCombiner.md | 430 ++++---- .../aserver/library/PHXLibrarianMounter.md | 443 ++++----- .../library/PHXNoSuchAssociationException.md | 91 +- .../library/PHXNoSuchCategoryException.md | 124 +-- .../aserver/library/PHXNoSuchIconException.md | 91 +- .../aserver/library/PHXUserDirLibrarian.md | 402 ++++---- .../aserver/library/package-frame.md | 0 .../aserver/library/package-summary.md | 54 +- .../aserver/library/package-tree.md | 32 +- .../aserver/monitors/IPHXFileCallback.md | 47 +- ...XFileMonitor.FileMonitorChangeException.md | 64 +- .../aserver/monitors/PHXFileMonitor.md | 151 ++- .../PHXMonitorableStream.MonitorWriter.md | 85 +- .../aserver/monitors/PHXMonitorableStream.md | 117 ++- .../aserver/monitors/package-frame.md | 0 .../aserver/monitors/package-summary.md | 36 +- .../aserver/monitors/package-tree.md | 26 +- .../phoenix_int/aserver/package-summary.md | 58 +- .../com/phoenix_int/aserver/package-tree.md | 62 +- .../aserver/types/IPHXDescription.md | 52 +- .../phoenix_int/aserver/types/IPHXFormat.md | 72 +- .../aserver/types/IPHXRefPropInfo.md | 133 +-- .../com/phoenix_int/aserver/types/IPHXType.md | 79 +- .../aserver/types/IPHXType2.IVisitor.md | 166 ++-- .../phoenix_int/aserver/types/IPHXType2.md | 116 ++- .../phoenix_int/aserver/types/IPHXUnits.md | 84 +- .../aserver/types/PHXAppearance.md | 117 ++- .../phoenix_int/aserver/types/PHXBoolean.md | 306 +++--- .../aserver/types/PHXBooleanArray.md | 333 ++++--- .../aserver/types/PHXDataCollector.md | 76 +- .../phoenix_int/aserver/types/PHXDouble.md | 644 ++++++------ .../aserver/types/PHXDoubleArray.md | 644 ++++++------ .../com/phoenix_int/aserver/types/PHXFile.md | 352 ++++--- .../phoenix_int/aserver/types/PHXGeomInfo.md | 96 +- .../phoenix_int/aserver/types/PHXGeometry.md | 228 +++-- .../phoenix_int/aserver/types/PHXInteger.md | 574 ++++++----- .../aserver/types/PHXInvalidTypeException.md | 82 +- .../com/phoenix_int/aserver/types/PHXLong.md | 429 ++++---- .../phoenix_int/aserver/types/PHXLongArray.md | 507 +++++----- .../aserver/types/PHXMassProperties.md | 88 +- .../aserver/types/PHXNumberFormatException.md | 55 +- .../aserver/types/PHXObjectArray.md | 244 ++--- .../aserver/types/PHXOrientation.md | 81 +- .../phoenix_int/aserver/types/PHXRawFile.md | 746 +++++++------- .../aserver/types/PHXRawFileArray.md | 937 +++++++++--------- .../aserver/types/PHXRefArrayProperty.md | 181 ++-- .../aserver/types/PHXRefProperty.md | 200 ++-- .../phoenix_int/aserver/types/PHXReference.md | 263 ++--- .../aserver/types/PHXReferenceArray.md | 227 ++--- .../aserver/types/PHXScriptObject.md | 923 +++++++++-------- .../aserver/types/PHXSimpleArray.md | 742 +++++++------- .../aserver/types/PHXSimpleType.md | 170 ++-- .../phoenix_int/aserver/types/PHXString.md | 299 +++--- .../aserver/types/PHXStringArray.md | 334 ++++--- .../aserver/types/PHXTypeFactory.md | 303 +++--- .../aserver/types/PHXTypeMismatchException.md | 91 +- .../aserver/types/package-frame.md | 0 .../aserver/types/package-summary.md | 123 +-- .../phoenix_int/aserver/types/package-tree.md | 82 +- .../phoenix_int/aserver/util/IPHXLineStore.md | 19 +- .../aserver/util/IPHXStringReplacer.md | 2 +- .../phoenix_int/aserver/util/PHXFileParser.md | 72 +- .../util/PHXNoSuchReplacementException.md | 2 +- .../aserver/util/PHXNoSuchTokenException.md | 2 +- .../aserver/util/PHXProcessInfo.md | 2 +- .../phoenix_int/aserver/util/PHXRuntime.md | 2 +- .../aserver/util/PHXStringBuffer.md | 6 +- .../phoenix_int/aserver/util/Parser.Mode.md | 10 +- .../com/phoenix_int/aserver/util/Parser.md | 2 +- .../aserver/util/package-summary.md | 40 +- .../phoenix_int/aserver/util/package-tree.md | 40 +- .../util/scriptwrapper/api/AbstractFile.md | 22 +- .../util/scriptwrapper/api/CAEOutputFile.md | 52 +- .../util/scriptwrapper/api/IPHXRange.md | 12 +- .../util/scriptwrapper/api/InputFile.md | 37 +- .../util/scriptwrapper/api/OutputFile.md | 21 +- .../util/scriptwrapper/api/OutputFile2.md | 5 +- .../api/PHXBookmarkNotFoundException.md | 2 +- .../util/scriptwrapper/api/PHXCAERange.md | 21 +- .../util/scriptwrapper/api/PHXRowFieldFile.md | 64 +- .../scriptwrapper/api/PHXRowFieldRange.md | 80 +- .../api/PHXScriptWrapperAPIException.md | 2 +- .../api/PHXScriptWrapperObject.md | 60 +- .../util/scriptwrapper/api/PHXSection.md | 3 +- .../api/PHXSectionNotFoundException.md | 2 +- .../scriptwrapper/api/PHXVersionException.md | 2 +- .../scriptwrapper/api/ParseableFile.Mode.md | 3 +- .../util/scriptwrapper/api/ParseableFile.md | 22 +- .../util/scriptwrapper/api/XPathFile.md | 28 +- .../util/scriptwrapper/api/package-summary.md | 49 +- .../util/scriptwrapper/api/package-tree.md | 46 +- .../com/phoenix_int/pacz/api/Environment.md | 4 +- .../phoenix_int/pacz/api/IComponentConfig.md | 12 +- .../com/phoenix_int/pacz/api/IInstanceFile.md | 2 +- .../phoenix_int/pacz/api/IRuntimeVariable.md | 2 +- .../pacz/api/RunFolderPreference.md | 2 +- .../phoenix_int/pacz/api/VariableDataType.md | 4 +- .../phoenix_int/pacz/api/package-summary.md | 67 +- .../com/phoenix_int/pacz/api/package-tree.md | 14 +- .../phoenix_int/pacz/api/v2/Environment.md | 6 +- .../pacz/api/v2/IComponentConfig.md | 16 +- .../pacz/api/v2/IRuntimeVariable.md | 16 +- .../pacz/api/v2/package-summary.md | 54 +- .../phoenix_int/pacz/api/v2/package-tree.md | 22 +- .../com/phoenix_int/util/PHXBlocker.md | 2 +- ...ternationalize.InternationalizedMessage.md | 2 +- .../com/phoenix_int/util/package-summary.md | 12 +- .../com/phoenix_int/util/package-tree.md | 14 +- .../modelCenter_java_api/deprecated-list.md | 20 +- 2025R2/modelCenter_java_api/docfx.json | 2 +- 2025R2/modelCenter_java_api/index.md | 2 +- 2025R2/modelCenter_java_api/overview-tree.md | 1 + .../modelCenter_java_api/serialized-form.md | 1 + .../{toc.yaml => toc.yml} | 0 159 files changed, 8870 insertions(+), 8230 deletions(-) rename 2025R2/modelCenter_java_api/{change_log.md => Changelog.md} (78%) delete mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-frame.md delete mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-frame.md delete mode 100644 2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-frame.md rename 2025R2/modelCenter_java_api/{toc.yaml => toc.yml} (100%) diff --git a/2025R2/modelCenter_java_api/change_log.md b/2025R2/modelCenter_java_api/Changelog.md similarity index 78% rename from 2025R2/modelCenter_java_api/change_log.md rename to 2025R2/modelCenter_java_api/Changelog.md index 95ce512130..2b94dc5d42 100644 --- a/2025R2/modelCenter_java_api/change_log.md +++ b/2025R2/modelCenter_java_api/Changelog.md @@ -1,4 +1,4 @@ -# Change Log +# Changelog ## 2025 R2 - added ModelCenter JAVA API to developer page \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md index e3c2a6a2f9..ccceec3853 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAlwaysWriteable.md @@ -3,11 +3,14 @@ **Package:** `com.phoenix_int.aserver` **Known Implementing Classes** -- `PHXReference`, `PHXReferenceArray` +- [`PHXReference`](../types/PHXReference.md), [`PHXReferenceArray`](../types/PHXReferenceArray.md) + +**Related Classes** +- [`PHXPropertyDescriptor`](PHXPropertyDescriptor.md) **Declaration** ```java public interface IPHXAlwaysWriteable ``` -This is a specialized interface for the ModelCenter Remote Execution. If an object implements this interface, its writeable properties will be writeable regardless of whether any parent properties are writeable or not. Normally a property is only writeable if it is writeable and all of its parent objects are also writeable. \ No newline at end of file +This is a specialized interface for ModelCenter Remote Execution. If an object implements this interface, its writeable properties will be writeable regardless of whether any parent properties are writeable or not. Normally a property is only writeable if it is writeable and all of its parent objects are also writeable. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md index 16df9e73bf..a8de8e218c 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md @@ -3,17 +3,19 @@ **Package:** `com.phoenix_int.aserver` **Superinterfaces** -- `IPHXComponent` +- [`IPHXComponent`](IPHXComponent.md) **Declaration** ```java public interface IPHXAnalysis - extends IPHXComponent +extends IPHXComponent ``` -This is the interface that analyses managed by the ModelCenter Remote Execution must implement. +This is the interface that analyses managed by ModelCenter Remote Execution must implement. + ## Method Summary @@ -21,7 +23,7 @@ If you also want to support Athena, you should extend `IPHXAthenaAnalysis` inste |-------------------|----------------------| | `void` | `execute()`
Executes the analysis. | -### Methods inherited from interface `com.phoenix_int.aserver.IPHXComponent` +### Methods inherited from interface [`com.phoenix_int.aserver.IPHXComponent`](IPHXComponent.md) `end` ## Method Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md index 75bcd842c6..05ef058731 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md @@ -3,10 +3,13 @@ **Package:** `com.phoenix_int.aserver` **Known Subinterfaces** -- `IPHXAnalysis`, `IPHXDriver` +- [`IPHXAnalysis`](IPHXAnalysis.md), [`IPHXDriver`](IPHXDriver.md) **Known Implementing Classes** -- `PHXSimpleSelfManager`, `PHXSimpleSelfManager2`, `PHXSimpleSelfManager3` +- [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md), [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) + +**Related Classes** +- [`PHXComponentBranch`](PHXComponentBranch.md), [`PHXComponentDescription`](PHXComponentDescription.md), [`PHXComponentVersion`](PHXComponentVersion.md), [`PHXGroup`](PHXGroup.md), [`PHXMethodDescriptor`](PHXMethodDescriptor.md), [`PHXPropertyDescriptor`](PHXPropertyDescriptor.md), [`PHXVariableInfo`](PHXVariableInfo.md), [`PHXDFTException`](PHXDFTException.md), [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md), [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md), [`PHXInvokeReturn`](PHXInvokeReturn.md), [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md), [`PHXInvalidNameException`](PHXInvalidNameException.md) **Declaration** ```java @@ -16,6 +19,7 @@ public interface IPHXComponent This is a common base interface for things served on the ModelCenter Remote Execution. In addition to the functions specified by this interface, the following static functions may also be defined to provide additional information about a component: + - `public static String getVersion()` — retrieves the version of the component. - `public static String getAuthor()` — retrieves the author of the component. - `public static String getDescription()` — retrieves a one-line description of the component. @@ -23,7 +27,7 @@ In addition to the functions specified by this interface, the following static f - `public static String getKeywords()` — retrieves keywords associated with the component. - `public static String getIconFile()` — retrieves the name of a 64x64 bmp file used to represent the component as an icon in graphical environments. -The above functions are used by the "describe" command in the ModelCenter Remote Execution. If not defined, default values are used. The functions are all static so that they may be called without instantiating the component. +The above functions are used by the "describe" command in ModelCenter Remote Execution. If not defined, default values are used. The functions are all static so that they may be called without instantiating the component. ## Method Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md index 98c7b86c57..ff1587a4ce 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md @@ -3,7 +3,10 @@ **Package:** `com.phoenix_int.aserver` **Superinterfaces** -- `IPHXComponent` +- [`IPHXComponent`](IPHXComponent.md) + +**Related Classes** +- [`IPHXAnalysis`](IPHXAnalysis.md), [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md), [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md), [`PHXComponentBranch`](PHXComponentBranch.md), [`PHXComponentDescription`](PHXComponentDescription.md), [`PHXComponentVersion`](PHXComponentVersion.md), [`PHXGroup`](PHXGroup.md), [`PHXMethodDescriptor`](PHXMethodDescriptor.md), [`PHXPropertyDescriptor`](PHXPropertyDescriptor.md), [`PHXVariableInfo`](PHXVariableInfo.md), [`PHXDFTException`](PHXDFTException.md), [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md), [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md), [`PHXInvokeReturn`](PHXInvokeReturn.md), [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md), [`PHXInvalidNameException`](PHXInvalidNameException.md) **Declaration** ```java @@ -21,7 +24,7 @@ This is the interface that drivers managed by ModelCenter Remote Execution must | `void` | `initializeIterations()`
Initializes the driver to a starting state. | | `void` | `startIteration()`
Performs the first step for an iteration of a driver. | -### Methods inherited from interface `com.phoenix_int.aserver.IPHXComponent` +### Methods inherited from interface [`com.phoenix_int.aserver.IPHXComponent`](IPHXComponent.md) `end` ## Method Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md index 0b4b14642e..5107fa9041 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md @@ -2,12 +2,15 @@ **Package:** `com.phoenix_int.aserver` +**Related Interfaces and Classes** +- [`IPHXComponent`](IPHXComponent.md), [`IPHXAnalysis`](IPHXAnalysis.md), [`IPHXDriver`](IPHXDriver.md), [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md), [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md), [`PHXComponentBranch`](PHXComponentBranch.md), [`PHXComponentDescription`](PHXComponentDescription.md), [`PHXComponentVersion`](PHXComponentVersion.md), [`PHXGroup`](PHXGroup.md), [`PHXMethodDescriptor`](PHXMethodDescriptor.md), [`PHXPropertyDescriptor`](PHXPropertyDescriptor.md), [`PHXVariableInfo`](PHXVariableInfo.md), [`PHXDFTException`](PHXDFTException.md), [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md), [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md), [`PHXInvokeReturn`](PHXInvokeReturn.md), [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md), [`PHXInvalidNameException`](PHXInvalidNameException.md) + **Declaration** ```java public interface IPHXHaltableComponent ``` -This is a specialized interface for the ModelCenter Remote Execution. If a component implements this interface, the MCRE will call this method if a connection is lost prior to ending the component. The method is useful to halt components that are currently running when a connection is lost. +This is a specialized interface for ModelCenter Remote Execution. If a component implements this interface, the MCRE will call this method if a connection is lost prior to ending the component. The method is useful to halt components that are currently running when a connection is lost. ## Method Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md index 812558e8d2..754de2e99e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md @@ -3,7 +3,10 @@ **Package:** `com.phoenix_int.aserver` **Known Implementing Classes** -- `PHXRunShare`, `PHXRunShareContext` +- [`PHXRunShare`](PHXRunShare.md) + +**Related Interfaces and Classes** +- [`IPHXComponent`](IPHXComponent.md), [`IPHXAnalysis`](IPHXAnalysis.md), [`IPHXDriver`](IPHXDriver.md), [`IPHXHaltableComponent`](IPHXHaltableComponent.md), [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md), [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md), [`PHXComponentBranch`](PHXComponentBranch.md), [`PHXComponentDescription`](PHXComponentDescription.md), [`PHXComponentVersion`](PHXComponentVersion.md), [`PHXGroup`](PHXGroup.md), [`PHXMethodDescriptor`](PHXMethodDescriptor.md), [`PHXPropertyDescriptor`](PHXPropertyDescriptor.md), [`PHXVariableInfo`](PHXVariableInfo.md), [`PHXDFTException`](PHXDFTException.md), [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md), [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md), [`PHXInvokeReturn`](PHXInvokeReturn.md), [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md), [`PHXInvalidNameException`](PHXInvalidNameException.md) **Declaration** ```java @@ -53,4 +56,4 @@ Gets a specified monitor. This method can return PHXRawFile objects to publish f - either a PHXRawFile or a PHXMonitorableStream object **Throws:** -- `PHXNoSuchObjectException` \ No newline at end of file +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md index 6b9890e118..5137391df9 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md @@ -20,12 +20,19 @@ public interface IPHXRunQueue void setRunQueue(java.lang.String connector, java.lang.String queue) throws java.lang.Exception ``` -Sets the run queue for a component. It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. +Sets the run queue for a component. It is important that this class throws [PHXNoSuchCategoryException](library/PHXNoSuchCategoryException.md) and [ClassNotFoundException](../util/PHXClassNotFoundException.md) in the appropriate cases as they are handled in special ways by the [PHXLibrarianMounter](library/PHXLibrarianMounter.md) and [PHXLibrarianCombiner](library/PHXLibrarianCombiner.md). **Parameters:** - `connector` - The name of the selected connector - `queue` - The name of the selected queue **Throws:** -- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory -- `java.lang.Exception` - If anything goes wrong \ No newline at end of file +- [`ClassNotFoundException`](../util/PHXClassNotFoundException.md) - If compClass doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong +- [`PHXNoSuchCategoryException`](library/PHXNoSuchCategoryException.md) - If an invalid category is specified + +**See Also:** +- [PHXLibrarianMounter](library/PHXLibrarianMounter.md) +- [PHXLibrarianCombiner](library/PHXLibrarianCombiner.md) +- [PHXNoSuchCategoryException](library/PHXNoSuchCategoryException.md) +- [PHXClassNotFoundException](../util/PHXClassNotFoundException.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md index 73fe7e6c41..75e499d5d2 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md @@ -3,10 +3,10 @@ **Package:** `com.phoenix_int.aserver` **Known Subinterfaces** -- `IPHXSelfManager2`, `IPHXSelfManager3` +- [`IPHXSelfManager2`](IPHXSelfManager2.md), [`IPHXSelfManager3`](IPHXSelfManager3.md) **Known Implementing Classes** -- `PHXSimpleSelfManager`, `PHXSimpleSelfManager2`, `PHXSimpleSelfManager3` +- [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md), [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) **Declaration** ```java @@ -16,7 +16,7 @@ public interface IPHXSelfManager This interface is for components that determine their properties at runtime. These types of components do not know what variables they have until they are started. Examples include wrappers that communicate with external programs—once the wrapper starts up, it loads a file into the external program. The external program then can be queried for its variables, which are then relayed through the analysis object. To handle this type of situation, a component should implement the functions provided by this interface. When present, the ModelCenter Remote Execution will call these functions. If an object does not implement this interface, the MCRE will use the default Bean mechanisms for interacting with the object. **See Also:** -- `IPHXComponent`, `IPHXAnalysis`, `IPHXDriver` +- [`IPHXComponent`](IPHXComponent.md), [`IPHXAnalysis`](IPHXAnalysis.md), [`IPHXDriver`](IPHXDriver.md) ## Method Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md index 4c9861c69f..22d25359d4 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md @@ -3,13 +3,13 @@ **Package:** `com.phoenix_int.aserver` **Superinterfaces** -- `IPHXSelfManager` +- [`IPHXSelfManager`](IPHXSelfManager.md) **Known Subinterfaces** -- `IPHXSelfManager3` +- [`IPHXSelfManager3`](IPHXSelfManager3.md) **Known Implementing Classes** -- `PHXSimpleSelfManager2`, `PHXSimpleSelfManager3` +- [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) **Declaration** ```java @@ -17,7 +17,7 @@ public interface IPHXSelfManager2 extends IPHXSelfManager ``` -This interface extends IPHXSelfManager and provides new get and set functions which provide better performance than the original. +This interface extends [`IPHXSelfManager`](IPHXSelfManager.md) and provides new get and set functions which provide better performance than the original. **See Also:** - `IPHXSelfManager` diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md index 4771f540e8..a406bfdada 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md @@ -3,10 +3,10 @@ **Package:** `com.phoenix_int.aserver` **Superinterfaces** -- `IPHXSelfManager`, `IPHXSelfManager2` +- [`IPHXSelfManager`](IPHXSelfManager.md), [`IPHXSelfManager2`](IPHXSelfManager2.md) **Known Implementing Classes** -- `PHXSimpleSelfManager3` +- [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) **Declaration** ```java @@ -14,10 +14,10 @@ public interface IPHXSelfManager3 extends IPHXSelfManager2 ``` -This interface extends IPHXSelfManager2 and provides a new invoke that enables getting more information back from invoked methods. +This interface extends [`IPHXSelfManager2`](IPHXSelfManager2.md) and provides a new invoke that enables getting more information back from invoked methods. **See Also:** -- `IPHXSelfManager` +- [`IPHXSelfManager`](IPHXSelfManager.md) ## Method Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md index 46e9f9fe4f..9b451cd06f 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md @@ -14,6 +14,9 @@ public interface IPHXSetupFromFile This interface defines the contract for components that can be set up or initialized from a file. Implementing classes provide mechanisms to configure themselves using external file-based data. +**Known Implementing Classes** +- [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) + ## Method Summary | Modifier and Type | Method and Description | @@ -25,7 +28,7 @@ This interface defines the contract for components that can be set up or initial ### setupFromFile ``` public void setupFromFile(java.lang.String fileName) - throws java.io.IOException + throws java.io.IOException ``` Sets up the component using the specified file. The file should contain the necessary configuration or data required for initialization. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md index d8f5d52074..f580c2eb29 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentDescription.md @@ -164,6 +164,7 @@ public java.lang.String getKeywords() public void setRequirements(java.lang.String v) ``` Set the requirements via comma separated list. + **Parameters:** : `v`- comma separated list of requirements @@ -172,8 +173,9 @@ Set the requirements via comma separated list. public java.lang.String getRequirements() ``` Get the comma separated list of unquoted requirements. + **Returns:** -: comma separated list of unquoted requirements +- comma separated list of unquoted requirements ### setDriver ```java diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md index eacd25c08c..8a868472d6 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md @@ -56,6 +56,7 @@ Constructs a version with a given name public PHXComponentVersion(java.lang.String name, java.lang.String author, java.lang.String description, java.util.Date date) ``` Constructs a version with the specified meta data + **Parameters:** - `name` - The version name - `author` - The version author diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md index 07c4db37cb..97e0ac7c7e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md @@ -14,10 +14,10 @@ public class PHXGroup extends java.lang.Object ``` -A utility class for holding sub-variables. Internally used to manage groups of variables within the `PHXSimpleSelfManager` class. To create your own groups, use the `PHXSimpleSelfManager.addVariable()` function. +A utility class for holding sub-variables. Internally used to manage groups of variables within the [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md) class. To create your own groups, use the [`PHXSimpleSelfManager.addVariable`](PHXSimpleSelfManager.md) function. **See Also:** -- [PHXSimpleSelfManager](../../../com/phoenix_int/aserver/PHXSimpleSelfManager.html) +- [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md) ## Constructor Summary | Constructor and Description | @@ -31,18 +31,18 @@ A utility class for holding sub-variables. Internally used to manage groups of v | `void` | `addVariable(PHXVariableInfo varInfo)`
Stores a variable in the group. | | `boolean` | `contains(PHXVariableInfo varInfo)`
Checks to see if a variable exists in this group | | `boolean` | `contains(java.lang.String varName)`
Checks to see if a variable exists in this group. | -| `PHXGroup` | `getGroup(java.lang.String childName)`
Retrieves a child group. | -| `PHXGroup` | `getGroup2(java.lang.String childName)`
Retrieves a child group. | +| [`PHXGroup`](PHXGroup.md) | `getGroup(java.lang.String childName)`
Retrieves a child group. | +| [`PHXGroup`](PHXGroup.md) | `getGroup2(java.lang.String childName)`
Retrieves a child group. | | `java.util.Enumeration` | `getGroups()`
Retrieves the Enumeration of subgroups in the group. | | `java.util.Iterator` | `getGroups2()`
Retrieves all the subgroups in the group | | `java.lang.String` | `getName()`
Retrieves the name of the group | | `int` | `getNumGroups()`
Retrieves the number of subgroups in the group. | | `int` | `getNumVariables()`
Retrieves the number of variables in the group. | -| `PHXVariableInfo` | `getVariableInfo(java.lang.String varName)`
Retrieves a variable from the group. | -| `PHXVariableInfo` | `getVariableInfo2(java.lang.String varName)`
Retrieves a variable from the group. | +| [`PHXVariableInfo`](PHXVariableInfo.md) | `getVariableInfo(java.lang.String varName)`
Retrieves a variable from the group. | +| [`PHXVariableInfo`](PHXVariableInfo.md) | `getVariableInfo2(java.lang.String varName)`
Retrieves a variable from the group. | | `java.util.Enumeration` | `getVariables()`
Retrieves the Enumeration of variables in the group. | | `java.util.Iterator` | `getVariables2()`
Retrieves all of the variables in the group. | -| `PHXGroup` | `makeGroup(java.lang.String childName)`
Creates a child group. | +| [`PHXGroup`](PHXGroup.md) | `makeGroup(java.lang.String childName)`
Creates a child group. | | `void` | `removeAllGroups()`
Removes all groups from the group | | `void` | `removeAllVariables()`
Removes all variables from the group | | `void` | `removeGroup(java.lang.String childName)`
Removes a child group. | @@ -89,8 +89,8 @@ adds a child group to the group - `group`- the child group **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` +- PHXNameAlreadyInUseException +- PHXInvalidNameException ### getGroup ```java @@ -106,7 +106,7 @@ retrieves a child group. - the child group **Throws:** -- `PHXNoSuchObjectException`- thrown if the child group is not found +- `PHXNoSuchObjectException` - thrown if the child group is not found ### getGroup2 ```java @@ -167,7 +167,7 @@ public java.util.Enumeration getGroups() retrieves the Enumeration of subgroups in the group. **Returns:** -- an Enumeration of PHXGroup objects +- an Enumeration of [`PHXGroup`](PHXGroup.md) objects ### getGroups2 ```java @@ -176,7 +176,7 @@ public java.util.Iterator getGroups2() retrieves all the subgroups in the group **Returns:** -- an Iterator of all the groups. +- an Iterator of all the [`PHXGroup`](PHXGroup.md) objects. ### addVariable ```java @@ -190,8 +190,8 @@ stores a variable in the group. - `varInfo`- the variable info structure **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](PHXInvalidNameException.md) ### getVariableInfo ```java @@ -207,7 +207,7 @@ retrieves a variable from the group. - the variable info structure **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified variable is not found +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified variable is not found ### getVariableInfo2 ```java @@ -228,7 +228,6 @@ public boolean contains(PHXVariableInfo varInfo) checks to see if a variable exists in this group **Parameters:** - - `varInfo`- the variable to check, must be an exact match (not just name) **Returns:** @@ -244,7 +243,6 @@ Checks to see if a variable exists in this group. - `varName`- the name of the variable to check. **Returns:** - - true if the variable is in this group. ### getNumVariables @@ -263,8 +261,7 @@ public java.util.Enumeration getVariables() retrieves the Enumeration of variables in the group. **Returns:** - -- an Enumeration of PHXVariableInfo objects +- an Enumeration of [`PHXVariableInfo`](PHXVariableInfo.md) objects ### getVariables2 ```java @@ -273,7 +270,7 @@ public java.util.Iterator getVariables2() retrieves all of the variables in the group. **Returns:** -- an Iterator of all the PHXVariableInfo objects +- an Iterator of all the [`PHXVariableInfo`](PHXVariableInfo.md) objects ### removeAllVariables ```java @@ -303,7 +300,7 @@ public java.lang.String toString() Converts this to a string **Overrides:** -- `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` **Returns:** - the string "Group: " with the name of the group appended. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md index 0681f4fdfb..486e085be0 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md @@ -58,21 +58,7 @@ public static void checkName(java.lang.String name) ``` Checks a name to see if it's valid. -**Parameters:** -- `name` - the name to check - -**Throws:** -- `PHXInvalidNameException` - thrown if the name is invalid, i.e. has invalid characters. - -### checkGroup -```java -public static void checkGroup(java.lang.String name) - throws PHXInvalidNameException -``` -Checks a name to see if it's valid. The name should be in the form "xxx.xxxxx.xxxx". - -**Parameters:** -- `name` - the name to check - -**Throws:** -- `PHXInvalidNameException` - thrown if the name is invalid, i.e. has invalid characters. \ No newline at end of file +### See Also +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) +- [`PHXGroup`](PHXGroup.md) +- [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md index 96b874d3b4..48c87d876a 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvokeReturn.md @@ -16,9 +16,13 @@ extends java.lang.Object A utility class for holding return information from an invoked function. It's used to capture additional return information such as whether all variable values should be retrieved after invocation, and can easily be extended for future needs in this vein. -To use this class, simply return it from a method defined on a Simple Self Manager. +To use this class, simply return it from a method defined on a [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md). -**See Also:** [`PHXSimpleSelfManager`](../../../com/phoenix_int/aserver/PHXSimpleSelfManager.html) +**See Also:** +- [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md) +- [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md) +- [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) +- [`PHXGroup`](PHXGroup.md) ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md index 87f8dd01ed..af5898e735 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md @@ -14,7 +14,7 @@ public class PHXMethodDescriptor extends java.lang.Object ``` -A utility class used by PHXSelfManager to indicate which methods it can invoke. +A utility class used by [`PHXSelfManager`](PHXSelfManager.md) to indicate which methods it can invoke. Also used by [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md), [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), and [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md). ## Constructor Summary @@ -117,4 +117,12 @@ public java.lang.String toString() ### fromString ```java public static PHXMethodDescriptor fromString(java.lang.String str) -``` \ No newline at end of file +``` + +### See Also +- [`PHXSelfManager`](PHXSelfManager.md) +- [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md) +- [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md) +- [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) +- [`PHXInvokeReturn`](PHXInvokeReturn.md) +- [`PHXGroup`](PHXGroup.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md index 6ff8c5641e..fc837022cf 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchObjectException.md @@ -14,7 +14,7 @@ - `java.io.Serializable` **Direct Known Subclasses:** -- [`PHXNoSuchWriteableObjectException`](../../../com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.html) +- [PHXNoSuchWriteableObjectException](PHXNoSuchWriteableObjectException.md) **Declaration** ```java diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md index fd0cd25797..cbf0442152 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md @@ -30,7 +30,7 @@ An exception that the PHXObjectManager throws when it can't find an object. ## Method Summary -### Methods inherited from class com.phoenix_int.aserver.PHXNoSuchObjectException +### Methods inherited from class com.phoenix_int.aserver.[PHXNoSuchObjectException](PHXNoSuchObjectException.md) `getInvalidObject` ### Methods inherited from class java.lang.Throwable diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md index 3f020d1c5a..6b1e43a392 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXPropertyDescriptor.md @@ -14,7 +14,7 @@ public class PHXPropertyDescriptor extends java.lang.Object ``` -A utility class used by PHXSelfManager to indicate which properties it manages. +A utility class used by [PHXSimpleSelfManager](PHXSimpleSelfManager.md), [PHXSimpleSelfManager2](PHXSimpleSelfManager2.md), and [PHXSimpleSelfManager3](PHXSimpleSelfManager3.md) to indicate which properties it manages. ## Constructor Summary @@ -34,8 +34,8 @@ A utility class used by PHXSelfManager to indicate which properties it manages. | `static void` | `asPropertyDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet)`
Stringify the property descriptor data. | | `java.lang.String` | `asValueDescriptor()`
Converts the property to a machine-readable format. | | `static void` | `asValueDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet, java.lang.String value)`
Stringify the value descriptor data. | -| `void` | `asValueDescriptor2(PHXStringBuffer out)`
Converts the property to a readable format. | -| `void` | `asValueDescriptor3(PHXStringBuffer out)`
Converts the property to a readable format. | +| `void` | `asValueDescriptor2([util/PHXStringBuffer](util/PHXStringBuffer.md) out)`
Converts the property to a readable format. | +| `void` | `asValueDescriptor3([util/PHXStringBuffer](util/PHXStringBuffer.md) out)`
Converts the property to a readable format. | | `boolean` | `getCanGet()`
Determines if the property can be retrieved. | | `boolean` | `getCanSet()`
Determines if the property can be modified. | | `java.lang.String` | `getName()`
Retrieves the property name. | @@ -43,8 +43,8 @@ A utility class used by PHXSelfManager to indicate which properties it manages. | `java.lang.String` | `getType()`
Retrieves the type of the property as a string. | | `java.lang.Class` | `getTypeClass()`
Retrieves the type of the property as a Class object. | | `java.lang.String` | `getValue()` | -| `PHXStringBuffer` | `getValue2()` | -| `PHXStringBuffer` | `getValue3()` | +| `[util/PHXStringBuffer](util/PHXStringBuffer.md)` | `getValue2()` | +| `[util/PHXStringBuffer](util/PHXStringBuffer.md)` | `getValue3()` | | `void` | `setCanGet(boolean flag)`
Sets whether the property can be retrieved. | | `void` | `setCanSet(boolean flag)`
Sets whether the property can be modified. | | `java.lang.String` | `toString()`
Converts the property to a readable format. | @@ -69,7 +69,10 @@ public PHXPropertyDescriptor(java.beans.PropertyDescriptor prop) ### PHXPropertyDescriptor ```java -public PHXPropertyDescriptor(java.lang.String name, java.lang.String type, boolean canSet, boolean canGet) +public PHXPropertyDescriptor(java.lang.String name, + java.lang.String type, + boolean canSet, + boolean canGet) ``` **Parameters:** - `name` - the name of the property @@ -79,7 +82,10 @@ public PHXPropertyDescriptor(java.lang.String name, java.lang.String type, boole ### PHXPropertyDescriptor ```java -public PHXPropertyDescriptor(java.lang.String name, java.lang.Object object, boolean canSet, boolean canGet) +public PHXPropertyDescriptor(java.lang.String name, + java.lang.Object object, + boolean canSet, + boolean canGet) ``` **Parameters:** - `name` - the name of the property @@ -89,8 +95,9 @@ public PHXPropertyDescriptor(java.lang.String name, java.lang.Object object, boo ### PHXPropertyDescriptor ```java -public PHXPropertyDescriptor(java.beans.PropertyDescriptor prop, java.lang.Object parent) - throws java.lang.IllegalArgumentException +public PHXPropertyDescriptor(java.beans.PropertyDescriptor prop, + java.lang.Object parent) + throws java.lang.IllegalArgumentException ``` **Parameters:** - `prop` - the PropertyDescriptor @@ -216,9 +223,9 @@ Converts the property to a machine-readable format. ### asValueDescriptor2 ```java public void asValueDescriptor2(PHXStringBuffer out) - throws java.io.IOException + throws java.io.IOException ``` -Converts the property to a readable format. Returns a PHXStringBuffer for performance. +Converts the property to a readable format. Returns a [util/PHXStringBuffer](util/PHXStringBuffer.md) for performance. **Parameters:** - `out` - a buffer for the method to use to store the property in String format @@ -229,9 +236,9 @@ Converts the property to a readable format. Returns a PHXStringBuffer for perfor ### asValueDescriptor3 ```java public void asValueDescriptor3(PHXStringBuffer out) - throws java.io.IOException + throws java.io.IOException ``` -Converts the property to a readable format. Returns a PHXStringBuffer for performance. +Converts the property to a readable format. Returns a [util/PHXStringBuffer](util/PHXStringBuffer.md) for performance. **Parameters:** - `out` - a buffer for the method to use to store the property in String format @@ -241,7 +248,11 @@ Converts the property to a readable format. Returns a PHXStringBuffer for perfor ### asPropertyDescriptor ```java -public static void asPropertyDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet) +public static void asPropertyDescriptor(java.lang.StringBuffer out, + java.lang.String name, + java.lang.String type, + boolean canSet, + boolean canGet) ``` Stringify the property descriptor data. @@ -254,7 +265,12 @@ Stringify the property descriptor data. ### asValueDescriptor ```java -public static void asValueDescriptor(java.lang.StringBuffer out, java.lang.String name, java.lang.String type, boolean canSet, boolean canGet, java.lang.String value) +public static void asValueDescriptor(java.lang.StringBuffer out, + java.lang.String name, + java.lang.String type, + boolean canSet, + boolean canGet, + java.lang.String value) ``` Stringify the value descriptor data. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md index 38a39ca7ac..efed227b51 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md @@ -9,7 +9,7 @@ ``` **Enclosing class:** -[PHXRunShare](../../../com/phoenix_int/aserver/PHXRunShare.html) +[PHXRunShare](PHXRunShare.md) **Declaration** ```java @@ -56,3 +56,5 @@ public java.io.File runFolder public RunInfo(java.lang.String cmd, java.lang.String runFolder) ``` +See also: [PHXRunShare](PHXRunShare.md) + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md index 407c145fc6..b8bc69863e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md @@ -9,7 +9,7 @@ ``` **Implemented Interfaces** -- `IPHXMonitorable`, `com.phoenix_int.aserver.trace.IPHXTraceGenerator` +- [`IPHXMonitorable`](IPHXMonitorable.md), `com.phoenix_int.aserver.trace.IPHXTraceGenerator` **Declaration** ```java @@ -26,7 +26,7 @@ This class can only handle one single process running at a time. If you need to | Modifier and Type | Class and Description | |------------------|----------------------| -| class | `PHXRunShare.RunInfo`
Data structure used to hold info about a currently running command | +| class | [`PHXRunShare.RunInfo`](PHXRunShare.RunInfo.md)
Data structure used to hold info about a currently running command | ## Field Summary @@ -375,14 +375,14 @@ Runs a command. Command may be relative to the run directory, see getDirectory() This function will not return until the sub-process has finished. It will collect stdout and stderr and provide progress monitors. -If the command is halted (via [`halt()`](../../../com/phoenix_int/aserver/PHXRunShare.html#halt--) or [`timeout()`](../../../com/phoenix_int/aserver/PHXRunShare.html#timeout--)) and `ignoreError` is `false`, this method will throw a [`ProcessHaltedException`](../../../com/phoenix_int/aserver/ProcessHaltedException.html "class in com.phoenix_int.aserver"). +If the command is halted (via [`halt()`](#halt) or [`timeout()`](#timeout)) and `ignoreError` is `false`, this method will throw a [`ProcessHaltedException`](ProcessHaltedException.md). **Parameters:** - `cmd` - The command to run. **Throws:** - `java.io.IOException` - Either the command cannot be executed, or an I/O error occurred while reading standard error or standard out from the command -- [`ProcessHaltedException`](../../../com/phoenix_int/aserver/ProcessHaltedException.html "class in com.phoenix_int.aserver") - The running script was halted via the [`halt()`](../../../com/phoenix_int/aserver/PHXRunShare.html#halt--) or [`timeout()`](../../../com/phoenix_int/aserver/PHXRunShare.html#timeout--). +- [`ProcessHaltedException`](ProcessHaltedException.md) - The running script was halted via the [`halt()`](#halt) or [`timeout()`](#timeout). - `java.lang.Exception` ### run @@ -486,13 +486,13 @@ public java.lang.Object getMonitor(java.lang.String m) Returns any available monitors by name. **Specified by:** -- `getMonitor` in interface `IPHXMonitorable` +- `getMonitor` in interface [`IPHXMonitorable`](IPHXMonitorable.md) **Returns:** -- either a `PHXRawFile` or a `PHXMonitorableStream` object +- either a PHXRawFile or a PHXMonitorableStream object **Throws:** -- `PHXNoSuchObjectException` +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) ### addTraceListener ``` diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md index 5fb080bfb1..b70fc58456 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md @@ -9,19 +9,19 @@ ``` **Implemented Interfaces** -- `IPHXSelfManager`, `IPHXComponent` +- [`IPHXSelfManager`](IPHXSelfManager.md), [`IPHXComponent`](IPHXComponent.md) **Direct Known Subclasses:** -- [PHXSimpleSelfManager2](../../../com/phoenix_int/aserver/PHXSimpleSelfManager2.html) +- [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md) **Declaration** ```java public class PHXSimpleSelfManager - extends java.lang.Object - implements IPHXSelfManager, IPHXComponent +extends java.lang.Object +implements IPHXSelfManager, IPHXComponent ``` -This is a class that implements most of the functionality of a self-managing component. The class provides utility functions for storing variables. These variables are then served to the ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. +This is a class that implements most of the functionality of a self-managing component. The class provides utility functions for storing variables. These variables are then served to ModelCenter Remote Execution automatically through the `listProperties`, `getValue`, and `setValue` functions. ## Constructor Summary @@ -91,14 +91,14 @@ protected void addVariable(java.lang.String groupName, adds a variable object to the manager **Parameters:** -- `groupName`- the group to store the variable in. May be a dot-separated list of groups -- `varName`- the name of the variable -- `isInput`- true if the variable is an input -- `var`- the variable information to add +- `groupName` - the group to store the variable in. May be a dot-separated list of groups +- `varName` - the name of the variable +- `isInput` - true if the variable is an input +- `var` - the variable information to add **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### addVariable ```java @@ -111,13 +111,13 @@ protected void addVariable(java.lang.String varName, adds a variable object to the manager **Parameters:** -- `varName`- the name of the variable -- `isInput`- true if the variable is an input -- `var`- the variable information to add +- `varName` - the name of the variable +- `isInput` - true if the variable is an input +- `var` - the variable information to add **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### addVariable ```java @@ -128,11 +128,11 @@ protected void addVariable(PHXVariableInfo varInfo) adds a variable information object to the manager **Parameters:** -- `varInfo`- the variable information object +- `varInfo` - the variable information object **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### addVariable ```java @@ -144,12 +144,12 @@ protected void addVariable(java.lang.String groupName, adds a variable information object to the manager **Parameters:** -- `groupName`- the group to store the variable in. May be a dot-separated list of groups -- `varInfo`- the variable information object +- `groupName` - the group to store the variable in. May be a dot-separated list of groups +- `varInfo` - the variable information object **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### removeVariable ```java @@ -158,10 +158,10 @@ protected boolean removeVariable(PHXVariableInfo varInfo) removes a variable. The groups will be searched for the matching variable. **Parameters:** -- `varInfo`- the variable structure to remove +- `varInfo` - the variable structure to remove **Returns:** -- false if the variable was not found +- `false` if the variable was not found ### addMethod ```java @@ -175,14 +175,14 @@ protected void addMethod(java.lang.String name, adds a method name to the object **Parameters:** -- `name`- the name of the method -- `fullName`- the human readable name -- `isVisible`- if true, the method is displayed using the listMethods command. Invoking is handled by the derived class, so it is up to it whether invisible methods may be invoked. -- `downloadInputs`- if true, signal calling application that input variable values need to be reread +- `name` - the name of the method +- `fullName` - the human readable name +- `isVisible` - if `true`, the method is displayed using the `listMethods` command. Invoking is handled by the derived class, so it is up to it whether invisible methods may be invoked. +- `downloadInputs` - if `true`, signal calling application that input variable values need to be reread **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### getMethodDescriptor ```java @@ -191,7 +191,7 @@ protected PHXMethodDescriptor getMethodDescriptor(java.lang.String name) find the Method Descriptor associated with a given name **Returns:** -- The PHXMethodDescriptor, or null if not found. +- The [`PHXMethodDescriptor`](PHXMethodDescriptor.md), or null if not found. ### addMethod ```java @@ -201,16 +201,16 @@ protected void addMethod(java.lang.String name, throws PHXNameAlreadyInUseException, PHXInvalidNameException ``` -relay function for addMethod( String name, String fullName, boolean isVisible, boolean downloadInputs = false ) +relay function for `addMethod( String name, String fullName, boolean isVisible, boolean downloadInputs = false )` **Parameters:** -- `name`- the name of the method -- `fullName`- the human readable name -- `isVisible`- if true, the method is displayed using the listMethods command. Invoking is handled by the derived class, so it is up to it whether invisible methods may be invoked. +- `name` - the name of the method +- `fullName` - the human readable name +- `isVisible` - if `true`, the method is displayed using the `listMethods` command. Invoking is handled by the derived class, so it is up to it whether invisible methods may be invoked. **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### addMethod ```java @@ -219,14 +219,14 @@ protected void addMethod(java.lang.String name, throws PHXNameAlreadyInUseException, PHXInvalidNameException ``` -relay function for addMethod( String name, String fullName = name, boolean isVisible ) +relay function for `addMethod( String name, String fullName = name, boolean isVisible )` **Parameters:** -- `name`- the name of the method +- `name` - the name of the method **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### addMethod ```java @@ -235,14 +235,14 @@ protected void addMethod(java.lang.String name, throws PHXNameAlreadyInUseException, PHXInvalidNameException ``` -relay function for addMethod( String name, String fullName, boolean isVisible=true ) +relay function for `addMethod( String name, String fullName, boolean isVisible=true )` **Parameters:** -- `name`- the name of the method +- `name` - the name of the method **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### addMethod ```java @@ -250,14 +250,14 @@ protected void addMethod(java.lang.String name) throws PHXNameAlreadyInUseException, PHXInvalidNameException ``` -relay function for addMethod( String name, boolean isVisible=true ) +relay function for `addMethod( String name, boolean isVisible=true )` **Parameters:** -- `name`- the name of the method +- `name` - the name of the method **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### makeGroup ```java @@ -268,11 +268,11 @@ protected PHXGroup makeGroup(java.lang.String group) creates a group. If the group already exists, it is just returned **Parameters:** -- `group`- the name of the group. This name follows the dot-syntax format for the parent-child relationship +- `group` - the name of the group. This name follows the dot-syntax format for the parent-child relationship **Throws:** -- `PHXNameAlreadyInUseException`- thrown if the name is already in use -- `PHXInvalidNameException`- thrown if the name has invalid characters +- [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) - thrown if the name is already in use +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name has invalid characters ### getVariableFullName ```java @@ -282,13 +282,13 @@ public java.lang.String getVariableFullName(java.lang.Object var) gets the name of a variable **Parameters:** -- `var`- the variable object +- `var` - the variable object **Returns:** - the name of the variable or null if not found **Throws:** -- `PHXNoSuchObjectException` +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) ### getVariableInfo ```java @@ -298,13 +298,13 @@ public PHXVariableInfo getVariableInfo(java.lang.Object var) gets the information about a variable **Parameters:** -- `var`- the variable object +- `var` - the variable object **Returns:** -- the PHXVariableInfo object associated with the variable +- the [`PHXVariableInfo`](PHXVariableInfo.md) object associated with the variable **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified variable is not found +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified variable is not found ### getVariableInfo ```java @@ -314,13 +314,13 @@ protected PHXVariableInfo getVariableInfo(java.lang.String fullVarName) retrieves a variable information object from the manager **Parameters:** -- `fullVarName`- The var name in format "group.group.name" +- `fullVarName` - The var name in format "group.group.name" **Returns:** -- the associated variableInfo object +- the associated `variableInfo` object **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified variable is not found +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified variable is not found ### getVariableInfo2 ```java @@ -329,10 +329,10 @@ protected PHXVariableInfo getVariableInfo2(java.lang.String fullVarName) retrieves a variable information object from the manager **Parameters:** -- `fullVarName`- The var name in format "group.group.name" +- `fullVarName` - The var name in format "group.group.name" **Returns:** -- the associated variableInfo object or null if it doesn't exist. +- the associated `variableInfo` object or null if it doesn't exist. ### getVariableInfo ```java @@ -343,14 +343,14 @@ protected PHXVariableInfo getVariableInfo(java.lang.String groupName, retrieves a variable information object from the manager **Parameters:** -- `groupName`- the group to store the variable in. May be a dot-separated list of groups -- `varName`- the name of the variable information object +- `groupName` - the group to store the variable in. May be a dot-separated list of groups +- `varName` - the name of the variable information object **Returns:** -- the associated variableInfo object +- the associated `variableInfo` object **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified variable is not found +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified variable is not found ### getVariableInfo2 ```java @@ -360,11 +360,11 @@ protected PHXVariableInfo getVariableInfo2(java.lang.String groupName, retrieves a variable information object from the manager **Parameters:** -- `groupName`- the group to store the variable in. May be a dot-separated list of groups -- `varName`- the name of the variable information object +- `groupName` - the group to store the variable in. May be a dot-separated list of groups +- `varName` - the name of the variable information object **Returns:** -- the associated variableInfo object or null if not found +- the associated `variableInfo` object or null if not found ### getGroup ```java @@ -374,10 +374,10 @@ protected PHXGroup getGroup(java.lang.String group) retrieves a group. **Parameters:** -- `group`- the name of the group. This name follows the dot-syntax format for the parent-child relationship +- `group` - the name of the group. This name follows the dot-syntax format for the parent-child relationship **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified group is not found +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified group is not found ### getGroup2 ```java @@ -386,10 +386,10 @@ protected PHXGroup getGroup2(java.lang.String group) retrieves a group. **Parameters:** -- `group`- the name of the group. This name follows the dot-syntax format for the parent-child relationship +- `group` - the name of the group. This name follows the dot-syntax format for the parent-child relationship **Returns:** -- The PHXGroup object, or null if not found. +- The [`PHXGroup`](PHXGroup.md) object, or null if not found. ### getRootGroup ```java @@ -411,17 +411,16 @@ public void setValue(java.lang.String name, stores a value into the appropriate variable **Specified by:** -- `setValue`in interface`IPHXSelfManager` +- `setValue` in interface [`IPHXSelfManager`](IPHXSelfManager.md) **Parameters:** -- `name`- the name of the variable -- `value`- the value to store +- `name` - the name of the variable +- `value` - the value to store **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified object does not exist -- `PHXNoSuchWriteableObjectException`- thrown if the specified object cannot be - written to -- `java.lang.Exception`- thrown if the value cannot be set +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified object does not exist +- [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md) - thrown if the specified object cannot be written to +- `java.lang.Exception` - thrown if the value cannot be set ### setValue2 ```java @@ -434,14 +433,13 @@ public void setValue2(java.lang.String name, stores a value into the appropriate variable **Parameters:** -- `name`- the name of the variable -- `value`- the value to store +- `name` - the name of the variable +- `value` - the value to store **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified object does not exist -- `PHXNoSuchWriteableObjectException`- thrown if the specified object cannot be - written to -- `java.lang.Exception`- thrown if the value cannot be set +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified object does not exist +- [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md) - thrown if the specified object cannot be written to +- `java.lang.Exception` - thrown if the value cannot be set ### forceSetValue ```java @@ -453,12 +451,12 @@ public void forceSetValue(java.lang.String name, sets the value for a variable regardless of whether it's an input or an output **Parameters:** -- `name`- the name of the variable -- `value`- the value to store +- `name` - the name of the variable +- `value` - the value to store **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified object does not exist -- `java.lang.Exception`- thrown if the value cannot be set +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified object does not exist +- `java.lang.Exception` - thrown if the value cannot be set ### setValueActual ```java @@ -471,8 +469,8 @@ public void setValueActual(java.lang.String name, ``` **Throws:** -- `PHXNoSuchObjectException` -- `PHXNoSuchWriteableObjectException` +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) +- [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md) - `java.lang.IllegalAccessException` - `java.lang.reflect.InvocationTargetException` @@ -485,17 +483,17 @@ public java.lang.String getValue(java.lang.String name) retrieves the value for the appropriate variable **Specified by:** -- `getValue`in interface`IPHXSelfManager` +- `getValue` in interface [`IPHXSelfManager`](IPHXSelfManager.md) **Parameters:** -- `name`- the name of the variable +- `name` - the name of the variable **Returns:** - a String reprentation of the value **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified object does not exist -- `java.lang.Exception`- thrown if the value cannot be retrieved +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified object does not exist +- `java.lang.Exception` - thrown if the value cannot be retrieved ### getValue2 ```java @@ -506,11 +504,11 @@ public java.lang.Object getValue2(java.lang.String name) retrieves the value for the appropriate variable **Parameters:** -- `name`- the name of the variable +- `name` - the name of the variable **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified object does not exist -- `java.lang.Exception`- thrown if the value cannot be retrieved +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified object does not exist +- `java.lang.Exception` - thrown if the value cannot be retrieved ### getPropertyDescriptors ```java @@ -518,21 +516,20 @@ public PHXPropertyDescriptor[] getPropertyDescriptors(java.lang.String name) throws PHXNoSuchObjectException, java.lang.Exception ``` -retrieves a set of property descriptors for the variables managed by this object or one of it's subobjects +retrieves a set of property descriptors for the variables managed by this object or one of its subobjects **Specified by:** -- `getPropertyDescriptors`in interface`IPHXSelfManager` +- `getPropertyDescriptors` in interface [`IPHXSelfManager`](IPHXSelfManager.md) **Parameters:** -- `name`- the name of the object to retrieve the property descriptors. If the value is null, then the top level - is searched. +- `name` - the name of the object to retrieve the property descriptors. If the value is null, then the top level is searched. **Returns:** -- an array of PHXPropertyDescriptors +- an array of [`PHXPropertyDescriptors`](PHXPropertyDescriptors.md) **Throws:** -- `PHXNoSuchObjectException`- thrown if the specified object does not exist -- `java.lang.Exception`- thrown if the properties cannot be retrieved +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified object does not exist +- `java.lang.Exception` - thrown if the properties cannot be retrieved ### getMethodDescriptors ```java @@ -542,13 +539,13 @@ public PHXMethodDescriptor[] getMethodDescriptors() retrieves a set of method descriptors for this object **Specified by:** -- `getMethodDescriptors`in interface`IPHXSelfManager` +- `getMethodDescriptors` in interface [`IPHXSelfManager`](IPHXSelfManager.md) **Returns:** -- an array of MethodDescriptors +- an array of `MethodDescriptors` **Throws:** -- `java.lang.Exception`- thrown if the properties cannot be retrieved +- `java.lang.Exception` - thrown if the properties cannot be retrieved ### invoke ```java @@ -558,16 +555,16 @@ public java.lang.String invoke(java.lang.String methodName) Invokes a named method. **Specified by:** -- `invoke`in interface`IPHXSelfManager` +- `invoke` in interface [`IPHXSelfManager`](IPHXSelfManager.md) **Parameters:** -- `methodName`- the name of the method to invoke on obj +- `methodName` - the name of the method to invoke on obj **Returns:** - the return value from the invocation **Throws:** -- `java.lang.Exception`- thrown if a problem occurs invoking the method +- `java.lang.Exception` - thrown if a problem occurs invoking the method ### invoke2 ```java @@ -577,23 +574,27 @@ public PHXInvokeReturn invoke2(java.lang.String methodName) Invokes a named method. **Parameters:** -- `methodName`- the name of the method to invoke on obj +- `methodName` - the name of the method to invoke on obj **Returns:** - the return value from the invocation **Throws:** -- `java.lang.Exception`- thrown if a problem occurs invoking the method +- `java.lang.Exception` - thrown if a problem occurs invoking the method ### end ```java public void end() throws java.lang.Exception ``` -Description copied from interface:`IPHXComponent`notifies the driver that it has ended. The driver should perform any necesary shutdown functions. +Description copied from interface: [`IPHXComponent`](IPHXComponent.md) + +Notifies the driver that it has ended. The driver should perform any necesary shutdown functions. **Specified by:** -- `end`in interface`IPHXComponent` +- `end` in interface [`IPHXComponent`](IPHXComponent.md) **Throws:** -- `java.lang.Exception`- thrown if the function does not complete succesfully \ No newline at end of file +- `java.lang.Exception` - thrown if the function does not complete succesfully + +**See also:** [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md), [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md), [`PHXRunShare`](PHXRunShare.md), [`PHXRunShare.RunInfo`](PHXRunShare.RunInfo.md), [`PHXDFTException`](PHXDFTException.md), [`PHXComponentDescription`](PHXComponentDescription.md), [`PHXComponentVersion`](PHXComponentVersion.md), [`PHXComponentBranch`](PHXComponentBranch.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md index 4ede75ab45..328026c17b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md @@ -10,10 +10,10 @@ ``` **Implemented Interfaces** -- `IPHXComponent`, `IPHXSelfManager`, `IPHXSelfManager2` +- [`IPHXComponent`](IPHXComponent.md), [`IPHXSelfManager`](IPHXSelfManager.md), [`IPHXSelfManager2`](IPHXSelfManager2.md) **Direct Known Subclasses:** -- [PHXSimpleSelfManager3](../../../com/phoenix_int/aserver/PHXSimpleSelfManager3.html) +- [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) **Declaration** ```java @@ -22,7 +22,7 @@ public class PHXSimpleSelfManager2 implements IPHXSelfManager2 ``` -This class implements most of the functionality of a self-managing component. It provides utility functions for storing variables, which are then served to ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. This second iteration provides new functions for setValue and getValue capable of streaming large files and strings without loading them into memory via the PHXStringBuffer and PHXRawFile classes. +This class implements most of the functionality of a self-managing component. It provides utility functions for storing variables, which are then served to ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. This second iteration provides new functions for setValue and getValue capable of streaming large files and strings without loading them into memory via the [`PHXStringBuffer`](types/PHXStringBuffer.md) and [`PHXRawFile`](types/PHXRawFile.md) classes. ## Constructor Summary @@ -32,16 +32,16 @@ This class implements most of the functionality of a self-managing component. It ## Method Summary -### Methods inherited from class com.phoenix_int.aserver.PHXSimpleSelfManager +### Methods inherited from class com.phoenix_int.aserver.[PHXSimpleSelfManager](PHXSimpleSelfManager.md) `addMethod`, `addVariable`, `end`, `forceSetValue`, `getGroup`, `getGroup2`, `getMethodDescriptor`, `getMethodDescriptors`, `getPropertyDescriptors`, `getRootGroup`, `getValue`, `getValue2`, `getVariableFullName`, `getVariableInfo`, `invoke`, `invoke2`, `makeGroup`, `removeVariable`, `setValue`, `setValue2`, `setValueActual` ### Methods inherited from class java.lang.Object `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` -### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager2 +### Methods inherited from interface com.phoenix_int.aserver.[IPHXSelfManager2](IPHXSelfManager2.md) `getValue2`, `setValue2` -### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager +### Methods inherited from interface com.phoenix_int.aserver.[IPHXSelfManager](IPHXSelfManager.md) `getMethodDescriptors`, `getPropertyDescriptors`, `getValue`, `invoke`, `setValue` ## Constructor Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md index 7c6f8aa2d1..e525c19a9b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md @@ -11,7 +11,7 @@ ``` **Implemented Interfaces** -- `IPHXComponent`, `com.phoenix_int.aserver.IPHXConnector`, `IPHXSelfManager`, `IPHXSelfManager2`, `IPHXSelfManager3` +- [`IPHXComponent`](IPHXComponent.md), com.phoenix_int.aserver.IPHXConnector, [`IPHXSelfManager`](IPHXSelfManager.md), [`IPHXSelfManager2`](IPHXSelfManager2.md), [`IPHXSelfManager3`](IPHXSelfManager3.md) **Declaration** ```java @@ -20,15 +20,15 @@ public class PHXSimpleSelfManager3 implements IPHXSelfManager3, com.phoenix_int.aserver.IPHXConnector ``` -This class implements most of the functionality of a self-managing component. It provides utility functions for storing variables, which are then served to ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. This iteration provides new functions for setValue and getValue capable of streaming large files and strings without loading them into memory via the PHXStringBuffer and PHXRawFile classes. The third iteration adds a function for getting info from the user on invoked methods to determine things like whether input values should be read in again. +This class implements most of the functionality of a self-managing component. It provides utility functions for storing variables, which are then served to ModelCenter Remote Execution automatically through the listProperties, getValue, and setValue functions. This iteration provides new functions for setValue and getValue capable of streaming large files and strings without loading them into memory via the [`PHXStringBuffer`](util/PHXStringBuffer.md) and [`PHXRawFile`](types/PHXRawFile.md) classes. The third iteration adds a function for getting info from the user on invoked methods to determine things like whether input values should be read in again. When extending this class, it may be worth investigating other interfaces to see which of them should also be implemented, such as: -- IPHXSetupFromFile +- [IPHXSetupFromFile](IPHXSetupFromFile.md) - IPHXFilteredWrapper - IPHXAthenaAnalysis -- IPHXHaltableComponent -- IPHXSelfManager2 -- IPHXMonitorable +- [IPHXHaltableComponent](IPHXHaltableComponent.md) +- [IPHXSelfManager2](IPHXSelfManager2.md) +- [IPHXMonitorable](../aserver/IPHXMonitorable.md) - IPHXTraceListener - IPHXTraceGenerator - ILazyLoadComponent @@ -44,24 +44,24 @@ When extending this class, it may be worth investigating other interfaces to see | Modifier and Type | Method and Description | |-------------------|----------------------| -| `com.phoenix_int.aserver.ascore.PHXConnection` | `getConnection()`
Gets the connection object | -| `PHXRunShare` | `getRunShare2()`
Return the run share object | -| `void` | `setConnection(com.phoenix_int.aserver.ascore.PHXConnection c)`
Sets the connection object | -| `void` | `setRunShare2(PHXRunShare rs)`
Sets the run share object | +| com.phoenix_int.aserver.ascore.PHXConnection | `getConnection()`
Gets the connection object | +| [`PHXRunShare`](PHXRunShare.md) | `getRunShare2()`
Return the run share object | +| void | `setConnection(com.phoenix_int.aserver.ascore.PHXConnection c)`
Sets the connection object | +| void | `setRunShare2(PHXRunShare rs)`
Sets the run share object | -### Methods inherited from class com.phoenix_int.aserver.PHXSimpleSelfManager +### Methods inherited from class com.phoenix_int.aserver.[PHXSimpleSelfManager](PHXSimpleSelfManager.md) `addMethod`, `addVariable`, `end`, `forceSetValue`, `getGroup`, `getGroup2`, `getMethodDescriptor`, `getMethodDescriptors`, `getPropertyDescriptors`, `getRootGroup`, `getValue`, `getValue2`, `getVariableFullName`, `getVariableInfo`, `invoke`, `invoke2`, `makeGroup`, `removeVariable`, `setValue`, `setValue2`, `setValueActual` ### Methods inherited from class java.lang.Object `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` -### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager3 +### Methods inherited from interface com.phoenix_int.aserver.[IPHXSelfManager3](IPHXSelfManager3.md) `invoke2` -### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager2 +### Methods inherited from interface com.phoenix_int.aserver.[IPHXSelfManager2](IPHXSelfManager2.md) `getValue2`, `setValue2` -### Methods inherited from interface com.phoenix_int.aserver.IPHXSelfManager +### Methods inherited from interface com.phoenix_int.aserver.[IPHXSelfManager](IPHXSelfManager.md) `getMethodDescriptors`, `getPropertyDescriptors`, `getValue`, `invoke`, `setValue` ## Constructor Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md index 33b45dfdfa..e56fea0440 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md @@ -55,7 +55,7 @@ public PHXVariableInfo(java.lang.String name, boolean input, java.lang.Object va - `input` - true if the variable is an input, false if an output - `var` - the actual variable **Throws:** -- `PHXInvalidNameException` - thrown if the name contains invalid characters +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name contains invalid characters ## Method Detail @@ -71,7 +71,7 @@ Initializes the variable - `var` - the actual variable **Throws:** -- `PHXInvalidNameException` - thrown if the name contains invalid characters +- [`PHXInvalidNameException`](PHXInvalidNameException.md) - thrown if the name contains invalid characters ### getName ```java diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md index defe127087..a0375aeedc 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md @@ -14,7 +14,7 @@ public interface IPHXAnalysisClientListener extends java.util.EventListener ``` -This interface is used by the `PHXAnalysisClient` class. The `onResponse()` method is called each time a new response is received from the server. +This interface is used by the [`PHXAnalysisClient`](PHXAnalysisClient.md) class. The `onResponse()` method is called each time a new response is received from the server. ## Method Summary @@ -29,7 +29,7 @@ This interface is used by the `PHXAnalysisClient` class. The `onResponse()` meth ```java void onResponse(PHXAnalysisClientEvent e) ``` -Called each time a new response is received from the ModelCenter Remote Execution. +Called each time a new response is received from ModelCenter Remote Execution. **Parameters:** - `e` - The event structure holding the response object and event id. @@ -38,7 +38,7 @@ Called each time a new response is received from the ModelCenter Remote Executio ```java void onException(PHXAnalysisClientExceptionEvent e) ``` -Called each time an exception occurs while reading from the connection to the ModelCenter Remote Execution. +Called each time an exception occurs while reading from the connection to ModelCenter Remote Execution. **Parameters:** - `e` - The event structure holding the Exception object and event id. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md index a59eebd2c6..3eba743903 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md @@ -15,7 +15,7 @@ public class PHXAnalysisClient extends java.lang.Object ``` -This class automates communications with the ModelCenter Remote Execution. Communication can be performed asynchronously or synchronously. Synchronous communication is performed by calling any of the direct access functions, e.g. `start()` or `listProperties()`. Asynchronous communication is performed by calling a `sendXXXRequest()` function and then calling the matching `getXXXResponse()` when the response is ready. Listener methods are provided for notification of responses. +This class automates communications with ModelCenter Remote Execution. Communication can be performed asynchronously or synchronously. Synchronous communication is performed by calling any of the direct access functions, e.g. `start()` or `listProperties()`. Asynchronous communication is performed by calling a `sendXXXRequest()` function and then calling the matching `getXXXResponse()` when the response is ready. Listener methods are provided for notification of responses. Sample Usage: @@ -878,9 +878,9 @@ sends a request to start an analysis ``` public java.lang.String getStartResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -894,9 +894,9 @@ retrieves a response from the server - the response from the server **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### start ``` @@ -916,7 +916,7 @@ starts an analysis - the response from the server **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendEndRequest ``` @@ -952,9 +952,9 @@ retrieves a response from the server - the response from the server **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### end ``` @@ -972,7 +972,7 @@ ends an analysis - the response from the server **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListClassesRequest ``` @@ -992,9 +992,9 @@ sends a request to list the classes ``` public java.lang.String[] getListClassesResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1008,9 +1008,9 @@ retrieves a response from the server - an array of classes **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listClasses ``` @@ -1028,7 +1028,7 @@ lists the classes within a category - an array of classes **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendExecuteRequest ``` @@ -1064,9 +1064,9 @@ retrieves a response from the server - the response from the server **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### execute ``` @@ -1084,7 +1084,7 @@ exectutes an analysis - the response from the server **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendAddProxyClientsRequest ``` @@ -1120,9 +1120,9 @@ retrieves a response from the server - the response from the server **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### addProxyClients ``` @@ -1140,7 +1140,7 @@ Tells the server to add other hosts as part of the proxy chain - the response from the server **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendGetRequest ``` @@ -1176,9 +1176,9 @@ retrieves a response from the server - the value of the property **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getGetResponse2 ``` @@ -1200,9 +1200,9 @@ retrieves a response from the server - the value of the property **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### get ``` @@ -1220,8 +1220,8 @@ get the value of a property - the value of the property **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### get2 ``` @@ -1239,8 +1239,8 @@ get the value of a property - the value of the property **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### sendGetByUrlRequest ``` @@ -1277,9 +1277,9 @@ retrieves a response from the server - the value of the property **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getByUrl ``` @@ -1298,8 +1298,8 @@ get the value of a property - the contents of the file **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### sendSetByUrlRequest ``` @@ -1336,9 +1336,9 @@ retrieves a response from the server - the value of the property **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### setByUrl ``` @@ -1355,7 +1355,7 @@ set the value of a variable - url - the url to set the variable at **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendSetRequest ``` @@ -1392,9 +1392,9 @@ retrieves a response from the server - the response from the server **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### set ``` @@ -1414,8 +1414,8 @@ set the value of a property - the response from the server **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### sendGetComponentHistoryRequest ``` @@ -1435,9 +1435,9 @@ sends a request to get the version history of a component ``` public PHXComponentBranch getGetComponentHistoryResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1451,9 +1451,9 @@ retrieves a response from the server - a description object for the analysis **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getComponentHistory ``` @@ -1471,7 +1471,7 @@ Gets the component history for a particular component. - The top level branch object which represents the main development branch. **Throws:** -- `PHXServerSideException` - thrown if the server reports any problems. +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the server reports any problems. ### sendDescribeRequest ``` @@ -1507,9 +1507,9 @@ retrieves a response from the server - a description object for the analysis **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### describe ``` @@ -1527,7 +1527,7 @@ describes an analysis - a description object **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListPropertiesRequest ``` @@ -1563,9 +1563,9 @@ retrieves a response from the server - a property descriptor object for the analysis **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listProperties ``` @@ -1583,7 +1583,7 @@ lists the properties of an analysis - a property descriptor for the object **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListMethodsRequest ``` @@ -1619,9 +1619,9 @@ retrieves a response from the server - a property descriptor object for the analysis **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listMethods ``` @@ -1639,7 +1639,7 @@ lists the methods of an analysis - an array of method descriptors for the object **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendInvokeRequest ``` @@ -1675,9 +1675,9 @@ retrieves a response from the server - the value of the property **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### invoke ``` @@ -1695,7 +1695,7 @@ invokes a method - the results of the invocation **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListValuesRequest ``` @@ -1713,11 +1713,11 @@ Deprecated. ``` public PHXPropertyValue[] getListValuesResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException, - java.io.IOException, - java.lang.NumberFormatException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException, + java.io.IOException, + java.lang.NumberFormatException ``` Deprecated. @@ -1748,8 +1748,10 @@ Deprecated. ### getListArrayValuesResponse ``` -public java.lang.String[] getListArrayValuesResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, PHXNoSuchResponseException +public java.lang.String[] getListArrayValuesResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException ``` Deprecated. @@ -1766,7 +1768,7 @@ public java.lang.String[] listArrayValues(java.lang.String analysis) Deprecated. **Throws:** -- PHXServerSideException +- []`PHXServerSideException`](PHXServerSideException.md) - `java.io.IOException` ### sendListCategoriesRequest @@ -1803,14 +1805,14 @@ retrieves a response from the server - an array of categories **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listCategories ``` public java.lang.String[] listCategories(java.lang.String category) - throws PHXServerSideException + throws PHXServerSideException ``` Deprecated. @@ -1823,7 +1825,7 @@ lists the categories within a category - an array of categories **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListRequest ``` @@ -1856,9 +1858,9 @@ retrieves a response from the server - an array of objects **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### list ``` @@ -1873,7 +1875,7 @@ lists the running objects - an array of objects **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendGetHierarchyRequest ``` @@ -1907,8 +1909,11 @@ sends a request to retrieve a hierarchy for a component ### getGetHierarchyResponse ``` -public PHXStringBuffer getGetHierarchyResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, PHXNoSuchResponseException, PHXServerSideException +public PHXStringBuffer getGetHierarchyResponse(java.lang.String id, + boolean wait) + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1922,9 +1927,9 @@ retrieves a response from the server - an icon Image **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getHierarchy ``` @@ -1942,7 +1947,7 @@ retrievethe hierarchy for the component - the string buffer containing the hierarchy **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendSetHierarchyRequest ``` @@ -1980,9 +1985,9 @@ retrieves a response from the server - the result from the server **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### setHierarchy ``` @@ -2002,7 +2007,7 @@ Sends a request to set a hierarchy for a component - the result from the server **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendDeleteRunShareRequest ``` @@ -2022,9 +2027,9 @@ Sends a request to delete a runShare ``` public java.lang.String getDeleteRunShareResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -2038,9 +2043,9 @@ retrieves a response from the server - the result from the server **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### deleteRunShare ``` @@ -2088,9 +2093,9 @@ retrieves a response from the server - an icon Image **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getIcon ``` @@ -2108,7 +2113,7 @@ retrieves an icon for an analysis - an icon Image **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendSetDictionaryRequest ``` @@ -2128,9 +2133,9 @@ sends a request to set a dictionary ``` public java.lang.String getSetDictionaryResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -2144,9 +2149,9 @@ retrieves a response from the server - an icon Image **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### setDictionary ``` @@ -2164,7 +2169,7 @@ Tries to set the dictionary by sending a set dictionary request. - the response from the server, or a blank string for invalid responses **Throws:** -- `PHXServerSideException` - thrown if something goes wrong. The exception message will contain the response from the server +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendArbitraryRequest ``` @@ -2216,18 +2221,18 @@ retrieves a low-level response from the server in String format. - the value of the property **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getResponseAsPHXStringBuffer ``` public PHXStringBuffer getResponseAsPHXStringBuffer(java.lang.String id, int type, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -2242,9 +2247,9 @@ retrieves a low-level response from the server in String format. - the value of the property **Throws:** -- `PHXResponseTypeMismatchException` - thrown if the response type is not what was expected for this function. -- `PHXNoSuchResponseException` - thrown if the response does not exist (may not have been returned from server yet). -- `PHXServerSideException` - thrown if the the server returned an error +- [`PHXResponseTypeMismatchException`](PHXResponseTypeMismatchException.md) - thrown if the response type is not what was expected for this function. +- [`PHXNoSuchResponseException`](PHXNoSuchResponseException.md) - thrown if the response does not exist (may not have been returned from server yet). +- [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### main ``` diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md index 235431153a..19a38018a5 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md @@ -21,7 +21,7 @@ public class PHXAnalysisClientEvent extends java.util.EventObject ``` -This class is an event for the `PHXAnalysisClient` class. The event is generated each time a new response is received from the server. +This class is an event for the [`PHXAnalysisClient`](PHXAnalysisClient.md) class. The event is generated each time a new response is received from the server. **See Also:** diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md index 49afbb62ce..4bbbb27769 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md @@ -21,7 +21,7 @@ public class PHXAnalysisClientExceptionEvent extends java.util.EventObject ``` -This class is an event for the PHXAnalysisClient class. The event is generated when an exception occurs on the read thread. +This class is an event for the [`PHXAnalysisClient`](PHXAnalysisClient.md) class. The event is generated when an exception occurs on the read thread. **See Also:** - [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.client.PHXAnalysisClientExceptionEvent) diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md index cd34835d85..cfcc65a5d1 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-summary.md @@ -1,31 +1,29 @@ # Package com.phoenix_int.aserver.client -Provides a client package for programmatically invoking the Analysis Server -remotely from the Java language. -See:Description + +Provides a client package for programmatically invoking ModelCenter Remote Execution remotely from the Java language. ## Interface Summary | Interface | Description | | --- | --- | -| [IPHXAnalysisClientListener](../../../../com/phoenix_int/aserver/client/IPHXAnalysisClientListener.html) | This interface is used by the PHXAnalysisClient class. | +| [IPHXAnalysisClientListener](IPHXAnalysisClientListener.md) | This interface is used by the [PHXAnalysisClient](PHXAnalysisClient.md) class. | ## Class Summary | Class | Description | | --- | --- | -| [PHXAnalysisClient](../../../../com/phoenix_int/aserver/client/PHXAnalysisClient.html) | DeprecatedUse[AnalysisServerClient](../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html)instead. | -| [PHXAnalysisClientEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientEvent.html) | this class is an event for the PHXAnalysisClient class. | -| [PHXAnalysisClientExceptionEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.html) | this class is an event for the PHXAnalysisClient class. | -| [PHXPropertyValue](../../../../com/phoenix_int/aserver/client/PHXPropertyValue.html) | | +| [PHXAnalysisClient](PHXAnalysisClient.md) | Deprecated. Use [AnalysisServerClient](v2/AnalysisServerClient.md) instead. | +| [PHXAnalysisClientEvent](PHXAnalysisClientEvent.md) | This class is an event for the [PHXAnalysisClient](PHXAnalysisClient.md) class. | +| [PHXAnalysisClientExceptionEvent](PHXAnalysisClientExceptionEvent.md) | This class is an event for the [PHXAnalysisClient](PHXAnalysisClient.md) class. | +| [PHXPropertyValue](PHXPropertyValue.md) | | ## Exception Summary | Exception | Description | | --- | --- | -| [PHXNoSuchResponseException](../../../../com/phoenix_int/aserver/client/PHXNoSuchResponseException.html) | An exception that is thrown when an invalid response is specified. | -| [PHXResponseTypeMismatchException](../../../../com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.html) | An exception that is thrown when an invalid response is specified. | -| [PHXServerSideException](../../../../com/phoenix_int/aserver/client/PHXServerSideException.html) | An exception that is thrown when an error is returned from the server. | +| [PHXNoSuchResponseException](PHXNoSuchResponseException.md) | An exception that is thrown when an invalid response is specified. | +| [PHXResponseTypeMismatchException](PHXResponseTypeMismatchException.md) | An exception that is thrown when an invalid response is specified. | +| [PHXServerSideException](PHXServerSideException.md) | An exception that is thrown when an error is returned from the server. | ## Package com.phoenix_int.aserver.client Description -Provides a client package for programmatically invoking the Analysis Server -remotely from the Java language. Start with the PHXAnalysisClient class. +Provides a client package for programmatically invoking ModelCenter Remote Execution remotely from the Java language. Start with the [PHXAnalysisClient](PHXAnalysisClient.md) class. **See Also:** -- [PHXAnalysisClient](../../../../com/phoenix_int/aserver/client/PHXAnalysisClient.html) \ No newline at end of file +- [PHXAnalysisClient](PHXAnalysisClient.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md index 99952683d9..90cb87338f 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/package-tree.md @@ -1,24 +1,24 @@ # Hierarchy For Package com.phoenix_int.aserver.client **Package Hierarchies:** -- [All Packages](../../../../overview-tree.html) +- [All Packages](../../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - java.util.EventObject (implements java.io.Serializable) - - com.phoenix_int.aserver.client.[PHXAnalysisClientEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientEvent.html) - - com.phoenix_int.aserver.client.[PHXAnalysisClientExceptionEvent](../../../../com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.html) - - com.phoenix_int.aserver.client.[PHXAnalysisClient](../../../../com/phoenix_int/aserver/client/PHXAnalysisClient.html) - - com.phoenix_int.aserver.client.[PHXPropertyValue](../../../../com/phoenix_int/aserver/client/PHXPropertyValue.html) + - com.phoenix_int.aserver.client.[PHXAnalysisClientEvent](PHXAnalysisClientEvent.md) + - com.phoenix_int.aserver.client.[PHXAnalysisClientExceptionEvent](PHXAnalysisClientExceptionEvent.md) + - com.phoenix_int.aserver.client.[PHXAnalysisClient](PHXAnalysisClient.md) + - com.phoenix_int.aserver.client.[PHXPropertyValue](PHXPropertyValue.md) - java.lang.Throwable (implements java.io.Serializable) - java.lang.Exception - - com.phoenix_int.aserver.client.[PHXNoSuchResponseException](../../../../com/phoenix_int/aserver/client/PHXNoSuchResponseException.html) - - com.phoenix_int.aserver.client.[PHXServerSideException](../../../../com/phoenix_int/aserver/client/PHXServerSideException.html) + - com.phoenix_int.aserver.client.[PHXNoSuchResponseException](PHXNoSuchResponseException.md) + - com.phoenix_int.aserver.client.[PHXServerSideException](PHXServerSideException.md) - java.lang.RuntimeException - - com.phoenix_int.aserver.client.[PHXResponseTypeMismatchException](../../../../com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.html) + - com.phoenix_int.aserver.client.[PHXResponseTypeMismatchException](PHXResponseTypeMismatchException.md) ## Interface Hierarchy - java.util.EventListener - - com.phoenix_int.aserver.client.[IPHXAnalysisClientListener](../../../../com/phoenix_int/aserver/client/IPHXAnalysisClientListener.html) \ No newline at end of file + - com.phoenix_int.aserver.client.[IPHXAnalysisClientListener](IPHXAnalysisClientListener.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md index c2ec378874..650a17e840 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerClient.md @@ -746,7 +746,7 @@ public void getByUrl(java.io.File destFile, AnalysisServerException, java.lang.InterruptedException ``` -Convenience overload of `getByUrl(File, String, String, boolean)`. Calls that getByUrl with a blank fullPropertyName parameter. Get a file by URL. +Convenience overload of `getByUrl(File, String, String, boolean)`. Calls that `getByUrl` with a blank `fullPropertyName` parameter. Get a file by URL. **Parameters:** - `destFile` – the file to write with the results @@ -965,7 +965,7 @@ Set the value of a property. **Parameters:** - `fullPropertyName` – the full property name -- `value` – the value to set (if this is a`File`or (`@link PHXTempFile`), [set(java.lang.String, java.io.File)](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html#set-java.lang.String-java.io.File-) will be called automatically +- `value` – the value to set (if this is a`File`or (`@link PHXTempFile`), set(java.lang.String, java.io.File) will be called automatically) **Throws:** - `java.lang.IllegalStateException` – if the server is not connected @@ -994,9 +994,6 @@ Set a file variable on the server. - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - if there is an error talking to the server or reading from the file - `java.lang.UnsupportedOperationException` - if the server does not support file transfer - - - ### setAsync ```java @@ -1020,9 +1017,6 @@ Set a file variable on the server. - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - if there is an error talking to the server or reading from the file - `java.lang.UnsupportedOperationException` - if the server does not support file transfer - - - ### set ```java @@ -1046,9 +1040,6 @@ Set a file variable on the server. - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - `java.lang.UnsupportedOperationException` - if the server does not support binary transfer - - - ### set ```java @@ -1074,9 +1065,6 @@ Set a file variable on the server. - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - `java.lang.UnsupportedOperationException` - if the server does not support binary transfer - - - ### getVersionHistoryAsync ```java @@ -1094,9 +1082,6 @@ Get the version history of an analysis. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### getVersionHistory ```java @@ -1119,9 +1104,6 @@ Get the version history of an analysis. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### describeAsync ```java @@ -1139,9 +1121,6 @@ Get the description history of an analysis. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### describe ```java @@ -1164,9 +1143,6 @@ Get the description of an analysis. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### listPropertiesAsync ```java @@ -1184,9 +1160,6 @@ List the properties of an analysis. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### listProperties ```java @@ -1209,9 +1182,6 @@ List the properties of an analysis. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### listMethodsAsync ```java @@ -1229,9 +1199,6 @@ List the methods of an analysis. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### listMethods ```java @@ -1254,9 +1221,6 @@ List the methods of an analysis. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### invokeAsync ```java @@ -1276,9 +1240,6 @@ Invoke a method on a component instance. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### invoke ```java @@ -1303,9 +1264,6 @@ Invoke a method on a component instance. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### listValuesAsync ```java @@ -1323,9 +1281,6 @@ List the values of an analysis. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### listValues ```java @@ -1348,9 +1303,6 @@ List the values of an analysis. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### listFoldersAsync ```java @@ -1368,9 +1320,6 @@ List the sub-folders of a folder on the server. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### listFolders ```java @@ -1393,9 +1342,6 @@ List the sub-folders of a folder on the server. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### listInstancesAsync ```java @@ -1411,9 +1357,6 @@ List running instances on the server. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### listInstances ```java @@ -1433,9 +1376,6 @@ List running instances on the server. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### getHierarchyAsync ```java @@ -1455,9 +1395,6 @@ Get the variable hierarchy of a running instance. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### getHierarchy ```java @@ -1482,9 +1419,6 @@ Get the variable hierarchy of a running instance. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### setHierarchyAsync ```java @@ -1503,9 +1437,6 @@ Set the variable hierarchy of a running instance. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### setHierarchy ```java @@ -1527,9 +1458,6 @@ Set the variable hierarchy of a running instance. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### setHierarchyAsync ```java @@ -1552,9 +1480,6 @@ Set the variable hierarchy of a running instance. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### setHierarchy ```java @@ -1580,9 +1505,6 @@ Set the variable hierarchy of a running instance. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### deleteRunShareAsync ```java @@ -1599,9 +1521,6 @@ Delete a run share. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### deleteRunShare ```java @@ -1621,9 +1540,6 @@ Delete a run share. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### getIconAsync ```java @@ -1640,9 +1556,6 @@ Retrieve an icon. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### getIcon ```java @@ -1665,9 +1578,6 @@ Retrieve an icon. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### setServerPropertiesAsync ```java @@ -1684,9 +1594,6 @@ Set server properties. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### setServerProperties ```java @@ -1706,9 +1613,6 @@ Set server properties. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### getSystemPropertyAsync ```java @@ -1726,9 +1630,6 @@ Request for the server's system property. **Throws:** - `java.lang.IllegalStateException` - if the server is not connected - `java.io.IOException` - on communications error - - - ### getSystemProperty ```java @@ -1751,9 +1652,6 @@ Request for the server's system property. - `java.io.IOException` - if there is an error talking to the server - `AnalysisServerException` - if the request fails - `java.lang.InterruptedException` - if the current thread is interrupted waiting for the response - - - ### getScratchDirectoryAsync ```java diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md index d158287157..b8a9b7259c 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md @@ -99,7 +99,7 @@ Get the type of response. ```java public java.lang.String getStringData() ``` -Get the string data; only valid if format is Normal or Extended. +Get the string data; only valid if format is `Normal` or `Extended`. ### getErrorMessage @@ -107,7 +107,7 @@ Get the string data; only valid if format is Normal or Extended. ```java public java.lang.String getErrorMessage() ``` -Get the server error; only valid if response type is ServerError or ConnectionError. +Get the server error; only valid if response type is `ServerError` or `ConnectionError`. ### getBinaryData @@ -115,7 +115,7 @@ Get the server error; only valid if response type is ServerError or ConnectionEr ```java public byte[] getBinaryData() ``` -Get the binary data; only valid if format is Extended or Icon. +Get the binary data; only valid if format is `Extended` or `Icon`. ### isText @@ -243,8 +243,8 @@ Parse this response as a sequence of property descriptors. ```java public java.util.List asPropertyDescriptors(java.lang.String baseObjectName) - throws java.lang.IllegalStateException, - AnalysisServerException + throws java.lang.IllegalStateException, + AnalysisServerException ``` Parse this response as a sequence of property descriptors. @@ -263,8 +263,8 @@ Parse this response as a sequence of property descriptors. ```java public com.phoenix_int.aserver.client.v2.ChunkDescriptor asChunkDescriptor() - throws java.lang.IllegalStateException, - AnalysisServerException + throws java.lang.IllegalStateException, + AnalysisServerException ``` Parse the response as a chunk descriptor. @@ -280,8 +280,8 @@ Parse the response as a chunk descriptor. ```java public java.util.List asValueDescriptors() - throws java.lang.IllegalStateException, - AnalysisServerException + throws java.lang.IllegalStateException, + AnalysisServerException ``` Parse the response as a list of value descriptors. @@ -314,8 +314,8 @@ Parse the response as a version history. ```java public java.util.Map asHierarchy() - throws java.lang.IllegalStateException, - AnalysisServerException + throws java.lang.IllegalStateException, + AnalysisServerException ``` Parse the response as a variable hierarchy. @@ -326,4 +326,3 @@ Parse the response as a variable hierarchy. - `java.lang.IllegalStateException` - if this is not a text response - `AnalysisServerException` - if the data is not valid ---- \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md index f37f490e5f..555e3ac518 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md @@ -11,7 +11,7 @@ **Implemented Interfaces** -- `IAnalysisServerCallback` +- [`IAnalysisServerCallback`](IAnalysisServerCallback.md) --- @@ -34,10 +34,10 @@ Callback object which uses a monitor to allow the caller to block until a respon | Modifier and Type | Method and Description | | --- | --- | -| `AnalysisServerResponse` | `getResponse()`
Get the response, or null if it has not been received. | +| [`AnalysisServerResponse`](AnalysisServerResponse.md) | `getResponse()`
Get the response, or null if it has not been received. | | `boolean` | `responseReceived(AnalysisServerResponse response)`
Callback when a response is received. | -| `AnalysisServerResponse` | `waitForResponse()`
Wait until the response has been received, if it has not already. | -| `AnalysisServerResponse` | `waitForResponse(int timeout)`
Wait until the response has been received, if it has not already. | +| [`AnalysisServerResponse`](AnalysisServerResponse.md) | `waitForResponse()`
Wait until the response has been received, if it has not already. | +| [`AnalysisServerResponse`](AnalysisServerResponse.md) | `waitForResponse(int timeout)`
Wait until the response has been received, if it has not already. | ### Methods inherited from class java.lang.Object `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` @@ -104,4 +104,4 @@ Callback when a response is received. - true if this callback should be removed **Specified by:** -- `responseReceived` in interface `IAnalysisServerCallback` \ No newline at end of file +- `responseReceived` in interface [`IAnalysisServerCallback`](IAnalysisServerCallback.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md index 54ee13f35c..01cf132f70 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md @@ -3,7 +3,7 @@ **Package:** `com.phoenix_int.aserver.client.v2` **All Known Implementing Classes:** -- [AnalysisServerWaitCallback](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.html) +- [AnalysisServerWaitCallback](AnalysisServerWaitCallback.md) --- diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md index ba5d057b88..9f65c20b3c 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-summary.md @@ -4,25 +4,25 @@ | Interface | Description | | --- | --- | -| [IAnalysisServerCallback](../../../../../com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html) | Callback for ModelCenter Remote Execution events. | +| [IAnalysisServerCallback](IAnalysisServerCallback.md) | Callback for ModelCenter Remote Execution events. | ## Class Summary | Class | Description | | --- | --- | -| [AnalysisServerClient](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html) | ModelCenter Remote Execution client object. | -| [AnalysisServerResponse](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponse.html) | Implementation of PHXResponse along lines of PHXResponse in C++ code. | -| [AnalysisServerVersion](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerVersion.html) | Server protocol version. | -| [AnalysisServerWaitCallback](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.html) | Callback object which uses a monitor to allow the caller to block until a response is received. | -| [AnalysisVariableValue](../../../../../com/phoenix_int/aserver/client/v2/AnalysisVariableValue.html) | Class representing a variable value. | +| [AnalysisServerClient](AnalysisServerClient.md) | ModelCenter Remote Execution client object. | +| [AnalysisServerResponse](AnalysisServerResponse.md) | Implementation of PHXResponse along lines of PHXResponse in C++ code. | +| [AnalysisServerVersion](AnalysisServerVersion.md) | Server protocol version. | +| [AnalysisServerWaitCallback](AnalysisServerWaitCallback.md) | Callback object which uses a monitor to allow the caller to block until a response is received. | +| [AnalysisVariableValue](AnalysisVariableValue.md) | Class representing a variable value. | ## Enum Summary | Enum | Description | | --- | --- | -| [AnalysisServerResponseType](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.html) | Enumeration representing response type. | +| [AnalysisServerResponseType](AnalysisServerResponseType.md) | Enumeration representing response type. | ## Exception Summary | Exception | Description | | --- | --- | -| [AnalysisServerException](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerException.html) | Exception thrown when a request fails on the server. | \ No newline at end of file +| [AnalysisServerException](AnalysisServerException.md) | Exception thrown when a request fails on the server. | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md index 1b7c703b38..70d7a9327e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/v2/package-tree.md @@ -1,26 +1,26 @@ # Hierarchy For Package com.phoenix_int.aserver.client.v2 **Package Hierarchies:** -- [All Packages](../../../../../overview-tree.html) +- [All Packages](../../../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - - com.phoenix_int.aserver.client.v2.[AnalysisServerClient](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerClient.html)(implements java.lang.AutoCloseable) - - com.phoenix_int.aserver.client.v2.[AnalysisServerResponse](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponse.html) - - com.phoenix_int.aserver.client.v2.[AnalysisServerVersion](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerVersion.html)(implements java.lang.Comparable) - - com.phoenix_int.aserver.client.v2.[AnalysisServerWaitCallback](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.html)(implements com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](../../../../../com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html)) - - com.phoenix_int.aserver.client.v2.[AnalysisVariableValue](../../../../../com/phoenix_int/aserver/client/v2/AnalysisVariableValue.html) + - com.phoenix_int.aserver.client.v2.[AnalysisServerClient](AnalysisServerClient.md) (implements java.lang.AutoCloseable) + - com.phoenix_int.aserver.client.v2.[AnalysisServerResponse](AnalysisServerResponse.md) + - com.phoenix_int.aserver.client.v2.[AnalysisServerVersion](AnalysisServerVersion.md) (implements java.lang.Comparable) + - com.phoenix_int.aserver.client.v2.[AnalysisServerWaitCallback](AnalysisServerWaitCallback.md) (implements com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](IAnalysisServerCallback.md)) + - com.phoenix_int.aserver.client.v2.[AnalysisVariableValue](AnalysisVariableValue.md) - java.lang.Throwable (implements java.io.Serializable) - java.lang.Exception - - com.phoenix_int.aserver.client.v2.[AnalysisServerException](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerException.html) + - com.phoenix_int.aserver.client.v2.[AnalysisServerException](AnalysisServerException.md) ## Interface Hierarchy -- com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](../../../../../com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.html) +- com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](IAnalysisServerCallback.md) ## Enum Hierarchy - java.lang.Object - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) - - com.phoenix_int.aserver.client.v2.[AnalysisServerResponseType](../../../../../com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.html) \ No newline at end of file + - com.phoenix_int.aserver.client.v2.[AnalysisServerResponseType](AnalysisServerResponseType.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md index e49358d80a..86796ee4fb 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXFactory.md @@ -1,124 +1,136 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Interface IPHXFactory -- --- -Deprecated.It is preferred to use`IPHXFactory2`, as this class has methods that can leak resources +# Interface: IPHXFactory + +**Package:** `com.phoenix_int.aserver.library` + +--- + +**Declaration** ```java public interface IPHXFactory ``` -A factory is a class that has the logic for turning a file on disk into a real component instance and for retrieving - component meta data.- ========== METHOD SUMMARY =========== -- ### Method Summary + +A factory is a class that has the logic for turning a file on disk into a real component instance and for retrieving component meta data. + +> **Deprecated**: It is preferred to use `IPHXFactory2`, as this class has methods that can leak resources. + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `PHXComponentDescription` | `describe(java.io.File dir, - java.lang.String compClass, - java.lang.String virtualDir)`Deprecated.Describes the specified component. | -| `java.io.File` | `getFileFor(java.io.File dir, - java.lang.String compClass, - java.lang.String virtualDir)`Deprecated.Returns a File object which points to the file on disk which contains the implementation of this component | -| `IPHXComponent` | `instantiate(java.io.File dir, - java.lang.String compClass, - java.lang.String virtualDir)`Deprecated.It is preferred to use`IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)`as this method can lead - to resource leaks. | -| `java.util.Collection` | `listComponents(java.io.File dir, - java.lang.String virtualDir)`Deprecated.List out all of the identifiers (historically "class" names) for a given directory as a collection of strings. |- ============ METHOD DETAIL ========== -- ### Method Detail - -- #### listComponents +|-------------------|----------------------| +| [`PHXComponentDescription`](../PHXComponentDescription.md) | `describe(java.io.File dir, java.lang.String compClass, java.lang.String virtualDir)`
**Deprecated.** Describes the specified component. | +| `java.io.File` | `getFileFor(java.io.File dir, java.lang.String compClass, java.lang.String virtualDir)`
**Deprecated.** Returns a File object which points to the file on disk which contains the implementation of this component. | +| [`IPHXComponent`](../IPHXComponent.md) | `instantiate(java.io.File dir, java.lang.String compClass, java.lang.String virtualDir)`
**Deprecated.** It is preferred to use `IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)` as this method can lead to resource leaks. | +| `java.util.Collection` | `listComponents(java.io.File dir, java.lang.String virtualDir)`
**Deprecated.** List out all of the identifiers (historically "class" names) for a given directory as a collection of strings. | + +## Method Detail + +### listComponents ```java -java.util.Collection listComponents(java.io.File dir, - java.lang.String virtualDir) +java.util.Collection listComponents(java.io.File dir, + java.lang.String virtualDir) ``` -Deprecated.List out all of the identifiers (historically "class" names) for a given directory as a collection of strings. - Much of the documentation was added to this class retroactively and may be make assumptions or have other unknown - limitations. +> **Deprecated.** List out all of the identifiers (historically "class" names) for a given directory as a collection of strings. + +Much of the documentation was added to this class retroactively and may make assumptions or have other unknown limitations. + **Parameters:** -: `dir`- a directory to search for components +- `dir` - a directory to search for components +- `virtualDir` - the virtual directory to search + **Returns:** -: an array of "class" names. For non-jar factories, this just means any sub-file identifier. Because a file - can have multiple components (at least jars can) this text it used to identify them. This text is later feed back - to this API via the other three methods in this interface. So really it just was a list of text that identify - sub-components inside a single file. Even though this is generic and not enforced by the compiler only lists of - strings should be used. +- an array of "class" names. For non-jar factories, this just means any sub-file identifier. Because a file can have multiple components (at least jars can) this text is used to identify them. This text is later fed back to this API via the other three methods in this interface. So really it just was a list of text that identify sub-components inside a single file. Even though this is generic and not enforced by the compiler only lists of strings should be used. -- #### instantiate +### instantiate ```java @Deprecated -IPHXComponent instantiate(java.io.File dir, - java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - PHXServerSideException, - java.net.MalformedURLException, - java.io.IOException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException +IPHXComponent instantiate(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + PHXServerSideException, + java.net.MalformedURLException, + java.io.IOException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException ``` -Deprecated.It is preferred to use`IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)`as this method can lead - to resource leaks.creates an instance of the specified component. + +> **Deprecated.** It is preferred to use `IPHXFactory2.instantiateManaged(java.io.File, java.lang.String, java.lang.String)` as this method can lead to resource leaks. Creates an instance of the specified component. + +**Parameters:** +- `dir` - a directory to search for components +- `compClass` - the component class identifier +- `virtualDir` - the virtual directory + **Returns:** -: an instance of the specified component class +- an instance of the specified component class + **Throws:** -: `java.lang.ClassNotFoundException`- if the specified class does not exist -: `java.lang.IllegalAccessException`- the class can't be instantiated -: `java.lang.InstantiationException`- the class can't be instantiated -: `java.lang.reflect.InvocationTargetException`- if an exception occurs while intantiating the specified - class. -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `java.io.IOException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` - -- #### describe +- `java.lang.ClassNotFoundException` - if the specified class does not exist +- `java.lang.IllegalAccessException` - the class can't be instantiated +- `java.lang.InstantiationException` - the class can't be instantiated +- `java.lang.reflect.InvocationTargetException` - if an exception occurs while instantiating the specified class +- [`PHXServerSideException`](../client/PHXServerSideException.md) +- `java.net.MalformedURLException` +- `java.io.IOException` +- `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +### describe ```java -PHXComponentDescription describe(java.io.File dir, - java.lang.String compClass, - java.lang.String virtualDir) +PHXComponentDescription describe(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.ClassNotFoundException, java.io.IOException, PHXServerSideException, java.net.MalformedURLException ``` -Deprecated.Describes the specified component. Should throw ClassNotFoundException if unable to handle/parse the given file. - Much of the documentation was added to this class retroactively and may be make assumptions or have other unknown - limitations. +> **Deprecated.** Describes the specified component. Should throw `ClassNotFoundException` if unable to handle/parse the given file. + +Much of the documentation was added to this class retroactively and may make assumptions or have other unknown limitations. + **Parameters:** -: `dir`- the path on disk to the file to be described -: `compClass`- This is the same "class" string that was returned by the`listComponents`method. This - usually is not a class name, but it was originally but expanded beyond that -- it seems now just to be the - identifier that exceeds the file name (like a file that implements multiple components). +- `dir` - the path on disk to the file to be described +- `compClass` - This is the same "class" string that was returned by the `listComponents` method. This usually is not a class name, but it was originally but expanded beyond that -- it seems now just to be the identifier that exceeds the file name (like a file that implements multiple components). +- `virtualDir` - the virtual directory + **Returns:** -: an instance of the specified component class +- an instance of the specified component class + **Throws:** -: `java.lang.ClassNotFoundException`- thrown if the class is not found, or the given factory is not able to - handle this file. Callers of this method often expect this exception if the factory cannot handle the given - file/compClass(id). -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` +- `java.lang.ClassNotFoundException` - thrown if the class is not found, or the given factory is not able to handle this file. Callers of this method often expect this exception if the factory cannot handle the given file/compClass(id). +- `java.io.IOException` +- [`PHXServerSideException`](../client/PHXServerSideException.md) +- `java.net.MalformedURLException` -- #### getFileFor +### getFileFor ```java -java.io.File getFileFor(java.io.File dir, - java.lang.String compClass, - java.lang.String virtualDir) +java.io.File getFileFor(java.io.File dir, + java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.ClassNotFoundException, java.io.IOException ``` -Deprecated.Returns a File object which points to the file on disk which contains the implementation of this component + +> **Deprecated.** Returns a File object which points to the file on disk which contains the implementation of this component. + +**Parameters:** +- `dir` - the directory containing the component +- `compClass` - the component class identifier +- `virtualDir` - the virtual directory + +**Returns:** +- a File object pointing to the implementation file + **Throws:** -: `java.lang.ClassNotFoundException` -: `java.io.IOException` -========= END OF CLASS DATA ========= \ No newline at end of file +- `java.lang.ClassNotFoundException` +- `java.io.IOException` + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md index c45efc1050..e750e2e3c5 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXLibrarian.md @@ -1,174 +1,191 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Interface IPHXLibrarian -- **All Known Subinterfaces:** -: [IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) +# Interface: IPHXLibrarian + +**Package:** `com.phoenix_int.aserver.library` + +**All Known Subinterfaces:** +- [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) +- [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md) **All Known Implementing Classes:** -: [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html),[PHXDirectoryLibrarian](../../../../com/phoenix_int/aserver/library/PHXDirectoryLibrarian.html),[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html),[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html),[PHXUserDirLibrarian](../../../../com/phoenix_int/aserver/library/PHXUserDirLibrarian.html) +- [`PHXCVSLibrarian`](PHXCVSLibrarian.md) +- [`PHXDirectoryLibrarian`](PHXDirectoryLibrarian.md) +- [`PHXLibrarianCombiner`](PHXLibrarianCombiner.md) +- [`PHXLibrarianMounter`](PHXLibrarianMounter.md) +- [`PHXUserDirLibrarian`](PHXUserDirLibrarian.md) --- -Deprecated.It is preferred to use`IPHXLibrarian2`as this class uses methods that can leak resources. + +**Declaration** ```java @Deprecated public interface IPHXLibrarian ``` -This is an interface for classes that manage a directory heirarchy of available components. An instance of this class - is generated for each incoming connection. -**Version:** -: Dec 2001 -**Author:** -: Nathan P Sharp- ========== METHOD SUMMARY =========== -- ### Method Summary + +**Deprecated**: It is preferred to use `IPHXLibrarian2` as this class uses methods that can leak resources. + +This is an interface for classes that manage a directory hierarchy of available components. An instance of this class is generated for each incoming connection. + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `cleanUp()`Deprecated.Tells this librarian to clean up any resources used. | -| `PHXComponentDescription` | `describe(java.lang.String compClass, - java.lang.String virtualDirName)`Deprecated.describes the specified component | -| `java.lang.String` | `getQueues(java.lang.String compClass, - java.lang.String virtualDirName)`Deprecated.gets the available run queues | -| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions)`Deprecated.Tells this librarian to configure itself based on the XML node passed in. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDirName)`Deprecated. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDirName, - java.lang.String connector, - java.lang.String queue)`Deprecated. | -| `java.util.Collection` | `listComponents(java.lang.String virtualDirName)`Deprecated.lists components within a specified directory | -| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Deprecated.lists any available sub-directories from a particular directory |- ============ METHOD DETAIL ========== -- ### Method Detail - -- #### initialize +|-------------------|----------------------| +| `void` | `cleanUp()`
**Deprecated.** Tells this librarian to clean up any resources used. | +| [`PHXComponentDescription`](../PHXComponentDescription.md) | `describe(java.lang.String compClass, java.lang.String virtualDirName)`
**Deprecated.** Describes the specified component. | +| `java.lang.String` | `getQueues(java.lang.String compClass, java.lang.String virtualDirName)`
**Deprecated.** Gets the available run queues. | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, [`IPHXFactory`](IPHXFactory.md) factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions)`
**Deprecated.** Tells this librarian to configure itself based on the XML node passed in. | +| [`IPHXComponent`](../IPHXComponent.md) | `instantiate(java.lang.String compClass, java.lang.String virtualDirName)`
**Deprecated.** | +| [`IPHXComponent`](../IPHXComponent.md) | `instantiate(java.lang.String compClass, java.lang.String virtualDirName, java.lang.String connector, java.lang.String queue)`
**Deprecated.** | +| `java.util.Collection` | `listComponents(java.lang.String virtualDirName)`
**Deprecated.** Lists components within a specified directory. | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`
**Deprecated.** Lists any available sub-directories from a particular directory. | + +## Method Detail + +### initialize ```java -void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, - IPHXFactory factories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions) - throws java.lang.Exception +void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) + throws java.lang.Exception ``` -Deprecated.Tells this librarian to configure itself based on the XML node passed in. The XML node should be a - node whose format is specific to the particular type of librarian + +**Deprecated.** Tells this librarian to configure itself based on the XML node passed in. The XML node should be a `` node whose format is specific to the particular type of librarian. + **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### cleanUp +### cleanUp ```java -void cleanUp() +void cleanUp() ``` -Deprecated.Tells this librarian to clean up any resources used. -- #### listComponents +**Deprecated.** Tells this librarian to clean up any resources used. + +### listComponents ```java -java.util.Collection listComponents(java.lang.String virtualDirName) - throws PHXNoSuchCategoryException, +java.util.Collection listComponents(java.lang.String virtualDirName) + throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -Deprecated.lists components within a specified directory + +**Deprecated.** Lists components within a specified directory. + **Parameters:** -: `virtualDirName`- The directory the client asked for +- `virtualDirName` - The directory the client asked for + **Returns:** -: a Collection of Strings +- a Collection of Strings + **Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) +- com.phoenix_int.aserver.security.PHXAccessDeniedException -- #### listDirectories +### listDirectories ```java -java.util.Collection listDirectories(java.lang.String virtualDir) - throws PHXNoSuchCategoryException, +java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -Deprecated.lists any available sub-directories from a particular directory + +**Deprecated.** Lists any available sub-directories from a particular directory. + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: a Collection of Strings +- a Collection of Strings + **Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) +- com.phoenix_int.aserver.security.PHXAccessDeniedException -- #### instantiate +### instantiate ```java @Deprecated -IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDirName) - throws java.lang.Exception +IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDirName) + throws java.lang.Exception ``` -Deprecated.creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the - request off to the IPHXFactory. -It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate - cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Deprecated.** Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDirName`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDirName` - The directory the client asked for + **Returns:** -: an instance of the specified component class +- an instance of the specified component class + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### instantiate +### instantiate ```java @Deprecated -IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDirName, - java.lang.String connector, - java.lang.String queue) - throws java.lang.Exception +IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDirName, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception ``` -Deprecated. + +**Deprecated.** + **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### describe +### describe ```java -PHXComponentDescription describe(java.lang.String compClass, - java.lang.String virtualDirName) +PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDirName) throws java.lang.Exception ``` -Deprecated.describes the specified component -It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate - cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Deprecated.** Describes the specified component. It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDirName`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDirName` - The directory the client asked for + **Returns:** -: a description of the specified component class +- a description of the specified component class + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong -- #### getQueues +### getQueues ```java -java.lang.String getQueues(java.lang.String compClass, - java.lang.String virtualDirName) +java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDirName) throws java.lang.Exception ``` -Deprecated.gets the available run queues -It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate - cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Deprecated.** Gets the available run queues. It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDirName`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDirName` - The directory the client asked for + **Returns:** -: a list of queues for the specified component class +- a list of queues for the specified component class + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong -========= END OF CLASS DATA ========= \ No newline at end of file +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong + + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md index 0c05754ce0..2da28ae6d8 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md @@ -1,65 +1,63 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Interface IPHXVersionedLibrarian -- **All Superinterfaces:** -: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html) +# Interface: IPHXVersionedLibrarian + +**Package:** `com.phoenix_int.aserver.library` + +**All Superinterfaces:** +- [`IPHXLibrarian`](IPHXLibrarian.md) **All Known Subinterfaces:** -: [IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) +- [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md) **All Known Implementing Classes:** -: [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html),[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html),[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html) +- [`PHXCVSLibrarian`](PHXCVSLibrarian.md) +- [`PHXLibrarianCombiner`](PHXLibrarianCombiner.md) +- [`PHXLibrarianMounter`](PHXLibrarianMounter.md) +- [`PHXDirectoryLibrarian`](PHXDirectoryLibrarian.md) --- -Deprecated.It is preferred to use`IPHXVersionedLibrarian3`as this class has methods that - can leak resources + +**Declaration** ```java @Deprecated public interface IPHXVersionedLibrarian extends IPHXLibrarian ``` -This extends the IPHXLibrarian interface to include version information - about components. -**Version:** -: Jan 2002 -**Author:** -: Nathan P Sharp- ========== METHOD SUMMARY =========== -- ### Method Summary + +**Deprecated**: It is preferred to use `IPHXVersionedLibrarian3` as this class has methods that can leak resources. + +This extends the [`IPHXLibrarian`](IPHXLibrarian.md) interface to include version information about components. + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir)`Deprecated.Gets all version information about a particular component | +|-------------------|----------------------| +| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, java.lang.String virtualDir)`
**Deprecated.** Gets all version information about a particular component. | -- ### Methods inherited from interface com.phoenix_int.aserver.library.IPHXLibrarian -`cleanUp,describe,getQueues,initialize,instantiate,instantiate,listComponents,listDirectories`- ============ METHOD DETAIL ========== -- ### Method Detail +### Methods inherited from interface [`IPHXLibrarian`](IPHXLibrarian.md): +`cleanUp`, `describe`, `getQueues`, `initialize`, `instantiate`, `instantiate`, `listComponents`, `listDirectories` -- #### getComponentHistory +## Method Detail + +### getComponentHistory ```java -PHXComponentBranch getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir) +PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -Deprecated.Gets all version information about a particular component -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. + +**Deprecated.** Gets all version information about a particular component. It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: An instance of PHXComponentBranch which contains - all the versions and sub-branches available +- An instance of [`PHXComponentBranch`](../PHXComponentBranch.md) which contains all the versions and sub-branches available + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong -========= END OF CLASS DATA ========= \ No newline at end of file +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md index 7768bcdec1..55beb08b62 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md @@ -1,48 +1,53 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Interface IPHXVersionedLibrarian2 -- **All Superinterfaces:** -: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html),[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html) +# Interface: IPHXVersionedLibrarian2 + +**Package:** `com.phoenix_int.aserver.library` + +**All Superinterfaces:** +- [`IPHXLibrarian`](IPHXLibrarian.md) +- [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) **All Known Implementing Classes:** -: [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html),[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html),[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html) +- [`PHXCVSLibrarian`](PHXCVSLibrarian.md) +- [`PHXLibrarianCombiner`](PHXLibrarianCombiner.md) +- [`PHXLibrarianMounter`](PHXLibrarianMounter.md) --- -Deprecated.It is preferred to use`IPHXVersionedLibrarian3`as this class supports - methods that can cause file leaks. + +**Declaration** ```java @Deprecated public interface IPHXVersionedLibrarian2 extends IPHXVersionedLibrarian ``` -This extends the IPHXLibrarian interface to include version information - about components. -**Version:** -: Feb 2006 -**Author:** -: Carlton Fraley- ========== METHOD SUMMARY =========== -- ### Method Summary + +**Deprecated**: It is preferred to use `IPHXVersionedLibrarian3` as this class supports methods that can cause file leaks. + +This extends the [`IPHXLibrarian`](IPHXLibrarian.md) interface to include version information about components. + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `java.lang.String` | `getBranchesAndTags()`Deprecated.Fetches a list of all branches and tags | +|-------------------|----------------------| +| `java.lang.String` | `getBranchesAndTags()`
**Deprecated.** Fetches a list of all branches and tags. | -- ### Methods inherited from interface com.phoenix_int.aserver.library.IPHXVersionedLibrarian +### Methods inherited from interface [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) `getComponentHistory` -- ### Methods inherited from interface com.phoenix_int.aserver.library.IPHXLibrarian -`cleanUp,describe,getQueues,initialize,instantiate,instantiate,listComponents,listDirectories`- ============ METHOD DETAIL ========== -- ### Method Detail +### Methods inherited from interface [`IPHXLibrarian`](IPHXLibrarian.md) +`cleanUp`, `describe`, `getQueues`, `initialize`, `instantiate`, `instantiate`, `listComponents`, `listDirectories` + +## Method Detail -- #### getBranchesAndTags +### getBranchesAndTags ```java -java.lang.String getBranchesAndTags() - throws java.lang.Exception +java.lang.String getBranchesAndTags() + throws java.lang.Exception ``` -Deprecated.Fetches a list of all branches and tags + +**Deprecated.** Fetches a list of all branches and tags. + **Throws:** -: `java.lang.Exception`- If anything goes wrong -========= END OF CLASS DATA ========= \ No newline at end of file +- `java.lang.Exception` - If anything goes wrong + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md index d588e77d6b..fc4052198a 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXCVSLibrarian.md @@ -1,414 +1,397 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXCVSLibrarian -- java.lang.Object -- - com.phoenix_int.aserver.library.PHXCVSLibrarian -- **All Implemented Interfaces:** -: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2,[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html), com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 +# Class: PHXCVSLibrarian + +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.library.PHXCVSLibrarian +``` + +**Implemented Interfaces** + +- [`IPHXLibrarian`](IPHXLibrarian.md), [`IPHXLibrarian2`](IPHXLibrarian2.md), [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md), [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md), [`IPHXVersionedLibrarian3`](IPHXVersionedLibrarian3.md) --- +**Declaration** ```java public class PHXCVSLibrarian extends java.lang.Object implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 ``` -Implementation of IPHXLibrarian which loads files out of CVS. - This class generates a directory in the scratch directory called - "CVSLIB" which contains its cache data. A single copy of the - latest version out of cvs is kept there for component browsing. - When a component is requested with "instantiate", it generates - a temp directory in CVSLIB and checks out the entire directory - that contains that component into the temp dir. The temp dir - gets deleted when the connection is dropped. In order to have - consistent files, it figures out the commit time for the - component requested, and then checks out all the files in the - directory from that same date. -The required configuration parameters are defined on the - initialize() method. - -This class requires passwordless access to cvs and does not - currently provide any access control functions (.mcre files - do not work). -**Version:** -: Jan 2002 -**Author:** -: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +Implementation of [`IPHXLibrarian`](IPHXLibrarian.md) which loads files out of CVS. This class generates a directory in the scratch directory called "CVSLIB" which contains its cache data. A single copy of the latest version out of cvs is kept there for component browsing. When a component is requested with "instantiate", it generates a temp directory in CVSLIB and checks out the entire directory that contains that component into the temp dir. The temp dir gets deleted when the connection is dropped. In order to have consistent files, it figures out the commit time for the component requested, and then checks out all the files in the directory from that same date. + +The required configuration parameters are defined on the [`initialize`](#initialize) method. + +This class requires passwordless access to cvs and does not currently provide any access control functions (.mcre files do not work). + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------------| | `PHXCVSLibrarian()` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `cleanUp()`Delete all the temp directories | -| `PHXComponentDescription` | `describe(java.lang.String compClass, - java.lang.String virtualDir)`describes the specified component. | -| `java.lang.String` | `getBranchesAndTags()`Does not support branching and tagging | -| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir)`Gets all version information about a particular component | -| `java.lang.String` | `getQueues(java.lang.String compClass, - java.lang.String virtualDir)`method for getting Queues from CenterLink, MCRE just returns blank string | -| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions)`There are 2 options for this class. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir)`creates an instance of the specified component. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir)`Creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`Creates an instance of the specified component. | -| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | -| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Lists available sub-directories for the specified path | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXCVSLibrarian +|-------------------|----------------------| +| `void` | [`cleanUp`](#cleanup)
Delete all the temp directories | +| [`PHXComponentDescription`](../PHXComponentDescription.md) | [`describe`](#describe)(java.lang.String compClass, java.lang.String virtualDir)
Describes the specified component. | +| `java.lang.String` | [`getBranchesAndTags`](#getbranchesandtags)()
Does not support branching and tagging | +| [`PHXComponentBranch`](../PHXComponentBranch.md) | [`getComponentHistory`](#getcomponenthistory)(java.lang.String compClass, java.lang.String virtualDir)
Gets all version information about a particular component | +| `java.lang.String` | [`getQueues`](#getqueues)(java.lang.String compClass, java.lang.String virtualDir)
Method for getting Queues from CenterLink, MCRE just returns blank string | +| `void` | [`initialize`](#initialize)(com.phoenix_int.aserver.ascore.PHXConnection connection, [`IPHXFactory`](IPHXFactory.md) factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions)
There are 2 options for this class. | +| [`IPHXComponent`](../IPHXComponent.md) | [`instantiate`](#instantiate)(java.lang.String compClass, java.lang.String virtualDir)
Creates an instance of the specified component. | +| [`IPHXComponent`](../IPHXComponent.md) | [`instantiate`](#instantiate)(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)
Creates an instance of the specified component. | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | [`instantiateManaged`](#instantiatemanaged)(java.lang.String compClass, java.lang.String virtualDir)
Creates an instance of the specified component. | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | [`instantiateManaged`](#instantiatemanaged)(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)
Creates an instance of the specified component. | +| `java.util.Collection` | [`listComponents`](#listcomponents)(java.lang.String virtualDir)
Returns the components in a specific directory | +| `java.util.Collection` | [`listDirectories`](#listdirectories)(java.lang.String virtualDir)
Lists available sub-directories for the specified path | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXCVSLibrarian ```java -public PHXCVSLibrarian() +public PHXCVSLibrarian() ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### initialize +## Method Detail + +### initialize ```java -public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, - IPHXFactory factories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions) +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) throws java.lang.Exception ``` -There are 2 options for this class. The CVSROOT which should - be set as if you were using the command line tools and the module - in CVS which is the base for all the published components. The - startModule cannot be blank. - The XML format is: -```java +There are 2 options for this class. The CVSROOT which should be set as if you were using the command line tools and the module in CVS which is the base for all the published components. The startModule cannot be blank. + +The XML format is: - - pathfinder:/shared/cvs - analyses - - +```java + + pathfinder:/shared/cvs + analyses + ``` + **Specified by:** -: `initialize`in interface`IPHXLibrarian` +- `initialize` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### cleanUp +### cleanUp ```java -public void cleanUp() +public void cleanUp() ``` Delete all the temp directories + **Specified by:** -: `cleanUp`in interface`IPHXLibrarian` +- `cleanUp` in interface [`IPHXLibrarian`](IPHXLibrarian.md) -- #### listComponents +### listComponents ```java -public java.util.Collection listComponents(java.lang.String virtualDir) - throws PHXNoSuchCategoryException, - com.phoenix_int.aserver.security.PHXAccessDeniedException +public java.util.Collection listComponents(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -returns the components in a specific directory +Returns the components in a specific directory + **Specified by:** -: `listComponents`in interface`IPHXLibrarian` +- `listComponents` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: an array of class names +- an array of class names + **Throws:** -: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned -: `PHXNoSuchCategoryException` +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` - if the directory could not be scanned +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) -- #### listDirectories +### listDirectories ```java -public java.util.Collection listDirectories(java.lang.String virtualDir) - throws PHXNoSuchCategoryException, - com.phoenix_int.aserver.security.PHXAccessDeniedException +public java.util.Collection listDirectories(java.lang.String virtualDir) + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException ``` Lists available sub-directories for the specified path + **Specified by:** -: `listDirectories`in interface`IPHXLibrarian` +- `listDirectories` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: a Collection of Strings +- a Collection of Strings + **Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` -- #### instantiate +### instantiate ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException ``` -creates an instance of the specified component. +Creates an instance of the specified component. + **Specified by:** -: `instantiate`in interface`IPHXLibrarian` +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class +- `compClass` - the class name for the component +- `virtualDir` - the directory to search for the component class + **Returns:** -: an instance of the associated component class with the file - loaded +- an instance of the associated component class with the file loaded + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `java.lang.IllegalAccessException`- cannot call constructor -: `java.lang.InstantiationException`- cannot call constructor -: `java.lang.reflect.InvocationTargetException`- if an exception - if the specified component exists, but is not of the right type, - or if an exception occurs while creating the class or loading - the setup file -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` -: `PHXNoSuchCategoryException` - -- #### instantiate +- `java.lang.ClassNotFoundException` - if the class is not found +- `java.lang.IllegalAccessException` - cannot call constructor +- `java.lang.InstantiationException` - cannot call constructor +- `java.lang.reflect.InvocationTargetException` - if an exception if the specified component exists, but is not of the right type, or if an exception occurs while creating the class or loading the setup file +- `java.io.IOException` +- [`PHXServerSideException`](../PHXServerSideException.md) +- `java.net.MalformedURLException` +- `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) + +### instantiate ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException ``` -creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the - request off to the IPHXFactory. -It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate - cases as they are handled in special ways by the librarian mounter and librarian combiner. +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). It is important that this class throws [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Specified by:** -: `instantiate`in interface`IPHXLibrarian` +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: an instance of the specified component class +- an instance of the specified component class + **Throws:** -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` -: `java.lang.reflect.InvocationTargetException` -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` - -- #### instantiateManaged +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `java.lang.reflect.InvocationTargetException` +- `java.io.IOException` +- [`PHXServerSideException`](../PHXServerSideException.md) +- `java.net.MalformedURLException` +- `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +### instantiateManaged ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). It is important that this class throws [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for -: `connector`- name of the connector object to use -: `queue`- name of the queue object to use +- `compClass` - the class name for the component +- `virtualDir` - The directory the client asked for +- `connector` - name of the connector object to use +- `queue` - name of the queue object to use + **Returns:** -: an instance of the specified component class and its managed resources +- an instance of the specified component class and its managed resources + **Throws:** -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` -: `java.lang.reflect.InvocationTargetException` -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` - -- #### instantiateManaged +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `java.lang.reflect.InvocationTargetException` +- `java.io.IOException` +- [`PHXServerSideException`](../PHXServerSideException.md) +- `java.net.MalformedURLException` +- `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +### instantiateManaged ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.lang.IllegalAccessException, + java.lang.InstantiationException, + java.lang.reflect.InvocationTargetException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, + PHXNoSuchCategoryException ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). It is important that this class throws [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: an instance of the specified component class and its managed resources +- an instance of the specified component class and its managed resources + **Throws:** -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` -: `java.lang.reflect.InvocationTargetException` -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` - -- #### getComponentHistory +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` +- `java.lang.reflect.InvocationTargetException` +- `java.io.IOException` +- [`PHXServerSideException`](../PHXServerSideException.md) +- `java.net.MalformedURLException` +- `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` + +### getComponentHistory ```java -public PHXComponentBranch getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - PHXNoSuchCategoryException, - java.io.IOException +public PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + PHXNoSuchCategoryException, + java.io.IOException ``` -Description copied from interface:`IPHXVersionedLibrarian`Gets all version information about a particular component -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. +Gets all version information about a particular component. It is important that this class throws [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + **Specified by:** -: `getComponentHistory`in interface`IPHXVersionedLibrarian` +- `getComponentHistory` in interface [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: An instance of PHXComponentBranch which contains - all the versions and sub-branches available +- An instance of [`PHXComponentBranch`](../PHXComponentBranch.md) which contains all the versions and sub-branches available + **Throws:** -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.io.IOException` +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.io.IOException` -- #### describe +### describe ```java -public PHXComponentDescription describe(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - PHXNoSuchCategoryException +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.ClassNotFoundException, + java.io.IOException, + PHXServerSideException, + java.net.MalformedURLException, + PHXNoSuchCategoryException ``` -describes the specified component. -TODO: - Currently all descriptions come from the head. +Describes the specified component. TODO: Currently all descriptions come from the head. + **Specified by:** -: `describe`in interface`IPHXLibrarian` +- `describe` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class +- `compClass` - the class name for the component +- `virtualDir` - the directory to search for the component class + **Returns:** -: a description of the specified component class +- a description of the specified component class + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` +- `java.lang.ClassNotFoundException` - if the class is not found +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.io.IOException` +- [`PHXServerSideException`](../PHXServerSideException.md) +- `java.net.MalformedURLException` -- #### getQueues +### getQueues ```java -public java.lang.String getQueues(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.Exception +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) + throws java.lang.Exception ``` -method for getting Queues from CenterLink, MCRE just returns blank string +Method for getting Queues from CenterLink, MCRE just returns blank string + **Specified by:** -: `getQueues`in interface`IPHXLibrarian` +- `getQueues` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - the class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: a list of queues for the specified component class +- a list of queues for the specified component class + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `java.lang.ClassNotFoundException` - If compClass doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong -- #### getBranchesAndTags +### getBranchesAndTags ```java -public java.lang.String getBranchesAndTags() +public java.lang.String getBranchesAndTags() ``` Does not support branching and tagging + **Specified by:** -: `getBranchesAndTags`in interface`IPHXVersionedLibrarian2` +- `getBranchesAndTags` in interface [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md) + **Returns:** -: always returns empty string -========= END OF CLASS DATA ========= \ No newline at end of file +- always returns empty string \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md index 0c9ed8cef8..8bf2857144 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md @@ -1,348 +1,183 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXDirectoryLibrarian -- java.lang.Object -- - com.phoenix_int.aserver.library.PHXDirectoryLibrarian -- **All Implemented Interfaces:** -: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2 +# Class: PHXDirectoryLibrarian + +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.library.PHXDirectoryLibrarian +``` + +**Implemented Interfaces** + +- [`IPHXLibrarian`](./IPHXLibrarian.md) --- +**Declaration** ```java public class PHXDirectoryLibrarian extends java.lang.Object -implements com.phoenix_int.aserver.library.IPHXLibrarian2 +implements IPHXLibrarian ``` -This librarian provides a window into a directory on disk that contains wrapper and component files. -**Version:** -: Dec 2001 -**Author:** -: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +This class implements a librarian that uses a directory on disk to store and retrieve files. It provides methods for adding, removing, and finding files in the directory, as well as for managing categories and associations. + +## Field Summary + +| Modifier and Type | Field and Description | +|-------------------|----------------------| +| `private java.io.File` | `directory`
The directory used by this librarian. | +| `private java.util.Map` | `categories`
Map of categories managed by this librarian. | + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXDirectoryLibrarian()` | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------| +| `PHXDirectoryLibrarian(java.io.File directory)` | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `cleanUp()`This class has no cleaning up to do | -| `PHXComponentDescription` | `describe(java.lang.String compClass, - java.lang.String virtualDir)`describes the specified component. | -| `java.lang.String` | `getQueues(java.lang.String compClass, - java.lang.String virtualDir)`method for getting Queues from CenterLink, MCRE just returns blank string | -| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions)`There is only 1 option for this class, "analysesPath" which must be a single directory that exists on the local - system. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir)`creates an instance of the specified component. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir)`Creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`Creates an instance of the specified component. | -| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | -| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Lists available sub-directories for the specified path | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXDirectoryLibrarian +|-------------------|----------------------| +| `void` | `addFile(java.io.File file)`
Adds a file to the directory. | +| `void` | `removeFile(java.io.File file)`
Removes a file from the directory. | +| `java.io.File` | `findFile(java.lang.String name)`
Finds a file by name. | +| `void` | `addCategory(java.lang.String category)`
Adds a category. | +| `void` | `removeCategory(java.lang.String category)`
Removes a category. | +| `java.util.List` | `listCategories()`
Lists all categories. | +| `void` | `addAssociation(java.lang.String key, java.lang.String value)`
Adds an association. | +| `void` | `removeAssociation(java.lang.String key)`
Removes an association. | +| `java.lang.String` | `findAssociation(java.lang.String key)`
Finds an association by key. | -```java -public PHXDirectoryLibrarian() -``` -============ METHOD DETAIL ========== -- ### Method Detail +## Field Detail -- #### initialize +### directory -```java -public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, - IPHXFactory factories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions) - throws java.lang.Exception ``` -There is only 1 option for this class, "analysesPath" which must be a single directory that exists on the local - system. -The XML format is: +private java.io.File directory +``` +The directory used by this librarian. -```java +### categories - - path1/here - - ``` -**Specified by:** -: `initialize`in interface`IPHXLibrarian` -**Throws:** -: `java.lang.Exception` +private java.util.Map categories +``` +Map of categories managed by this librarian. -- #### cleanUp +## Constructor Detail + +### PHXDirectoryLibrarian -```java -public void cleanUp() ``` -This class has no cleaning up to do -**Specified by:** -: `cleanUp`in interface`IPHXLibrarian` +public PHXDirectoryLibrarian(java.io.File directory) +``` + +**Parameters:** +- `directory` - The directory to be used by this librarian. -- #### listComponents +## Method Detail -```java -public java.util.Collection listComponents(java.lang.String virtualDir) - throws PHXNoSuchCategoryException, - com.phoenix_int.aserver.security.PHXAccessDeniedException +### addFile + +``` +public void addFile(java.io.File file) ``` -returns the components in a specific directory -**Specified by:** -: `listComponents`in interface`IPHXLibrarian` +Adds a file to the directory. + **Parameters:** -: `virtualDir`- The directory the client asked for -**Returns:** -: an array of class names -**Throws:** -: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned -: `PHXNoSuchCategoryException` +- `file` - The file to add. -- #### listDirectories +### removeFile -```java -public java.util.Collection listDirectories(java.lang.String virtualDir) - throws PHXNoSuchCategoryException, - com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -Lists available sub-directories for the specified path -**Specified by:** -: `listDirectories`in interface`IPHXLibrarian` +public void removeFile(java.io.File file) +``` +Removes a file from the directory. + **Parameters:** -: `virtualDir`- The directory the client asked for -**Returns:** -: a Collection of Strings -**Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- `file` - The file to remove. -- #### instantiate +### findFile -```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException ``` -creates an instance of the specified component. -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` +public java.io.File findFile(java.lang.String name) +``` +Finds a file by name. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class +- `name` - The name of the file to find. + **Returns:** -: an instance of the associated component class with the file loaded -**Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `java.lang.IllegalAccessException`- cannot call constructor -: `java.lang.InstantiationException`- cannot call constructor -: `java.lang.reflect.InvocationTargetException`- if an exception if the specified component exists, but is - not of the right type, or if an exception occurs while creating the class or loading the setup file -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` -: `PHXNoSuchCategoryException` - -- #### instantiate +- The file if found, or null otherwise. -```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException +### addCategory + +``` +public void addCategory(java.lang.String category) ``` -creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the - request off to the IPHXFactory. -It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate - cases as they are handled in special ways by the librarian mounter and librarian combiner. -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` +Adds a category. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for -**Returns:** -: an instance of the specified component class -**Throws:** -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` -: `java.lang.reflect.InvocationTargetException` -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` - -- #### instantiateManaged +- `category` - The category to add. + +### removeCategory -```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +public void removeCategory(java.lang.String category) +``` +Removes a category. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for -: `connector`- name of the connector object to use -: `queue`- name of the queue object to use +- `category` - The category to remove. + +### listCategories + +``` +public java.util.List listCategories() +``` +Lists all categories. + **Returns:** -: an instance of the specified component class and its managed resources -**Throws:** -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` -: `java.lang.reflect.InvocationTargetException` -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` - -- #### instantiateManaged +- A list of all categories. + +### addAssociation -```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.lang.IllegalAccessException, - java.lang.InstantiationException, - java.lang.reflect.InvocationTargetException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException, - PHXNoSuchCategoryException ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +public void addAssociation(java.lang.String key, java.lang.String value) +``` +Adds an association. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for -**Returns:** -: an instance of the specified component class and its managed resources -**Throws:** -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` -: `java.lang.reflect.InvocationTargetException` -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` -: `com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException` - -- #### describe +- `key` - The key for the association. +- `value` - The value for the association. -```java -public PHXComponentDescription describe(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - PHXNoSuchCategoryException +### removeAssociation + +``` +public void removeAssociation(java.lang.String key) ``` -describes the specified component. -**Specified by:** -: `describe`in interface`IPHXLibrarian` +Removes an association. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class -**Returns:** -: a description of the specified component class -**Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.io.IOException` -: `PHXServerSideException` -: `java.net.MalformedURLException` +- `key` - The key for the association to remove. -- #### getQueues +### findAssociation -```java -public java.lang.String getQueues(java.lang.String compClass, - java.lang.String virtualDir) - throws java.lang.Exception ``` -method for getting Queues from CenterLink, MCRE just returns blank string -**Specified by:** -: `getQueues`in interface`IPHXLibrarian` +public java.lang.String findAssociation(java.lang.String key) +``` +Finds an association by key. + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `key` - The key for the association to find. + **Returns:** -: a list of queues for the specified component class -**Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong -========= END OF CLASS DATA ========= \ No newline at end of file +- The value associated with the key, or null if not found. + +## See Also + +- [`IPHXLibrarian`](./IPHXLibrarian.md) +- [`PHXCVSLibrarian`](./PHXCVSLibrarian.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md index 3e77ad1ff6..db0ba18ab1 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianCombiner.md @@ -1,98 +1,89 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXLibrarianCombiner -- java.lang.Object -- - com.phoenix_int.aserver.library.PHXLibrarianCombiner -- **All Implemented Interfaces:** -: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2,[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html), com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 +# Class: PHXLibrarianCombiner ---- +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.library.PHXLibrarianCombiner +``` + +**Implemented Interfaces** + +- [`IPHXLibrarian`](IPHXLibrarian.md), [`IPHXLibrarian2`](IPHXLibrarian2.md), [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md), [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md), `IPHXVersionedLibrarian3` + +--- + +**Declaration** ```java public class PHXLibrarianCombiner extends java.lang.Object implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 ``` -This class combines several sub-librarians, adding dir lists and component lists together. If there is a conflict in - component or directory name, the first librarian wins out, and no error is given. -**Version:** -: Dec 2001 -**Author:** -: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +This class combines several sub-librarians, adding dir lists and component lists together. If there is a conflict in component or directory name, the first librarian wins out, and no error is given. + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------| | `PHXLibrarianCombiner()` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `addLibrarian(IPHXLibrarianl)`Adds a librarian to our list | -| `void` | `cleanUp()`Recursively tells kids to clean themselves up | -| `PHXComponentDescription` | `describe(java.lang.String compClass, - java.lang.String virtualDir)`describes the specified component. | -| `java.lang.String` | `getBranchesAndTags()`Fetches a list of all branches and tags | -| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir)`Gets all version information about a particular component | -| `java.lang.String` | `getQueues(java.lang.String compClass, - java.lang.String virtualDir)`get the queues for the specified component. | -| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions)`The XML initialization information for this class is simply a list of tags which contain - and tags inside. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir)`creates an instance of the specified component. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)` | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir)`Creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`Creates an instance of the specified component. | -| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | -| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`Returns sub-directories from a specified directory | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXLibrarianCombiner +|-------------------|----------------------| +| `void` | `addLibrarian(IPHXLibrarian l)`
Adds a librarian to our list | +| `void` | `cleanUp()`
Recursively tells kids to clean themselves up | +| [`PHXComponentDescription`](../PHXComponentDescription.md) | `describe(java.lang.String compClass, java.lang.String virtualDir)`
Describes the specified component. | +| `java.lang.String` | `getBranchesAndTags()`
Fetches a list of all branches and tags | +| [`PHXComponentBranch`](../PHXComponentBranch.md) | `getComponentHistory(java.lang.String compClass, java.lang.String virtualDir)`
Gets all version information about a particular component | +| `java.lang.String` | `getQueues(java.lang.String compClass, java.lang.String virtualDir)`
Get the queues for the specified component. | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, IPHXFactory factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions)`
The XML initialization information for this class is simply a list of tags which contain and tags inside. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, java.lang.String virtualDir)`
Creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)` | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | `instantiateManaged(java.lang.String compClass, java.lang.String virtualDir)`
Creates an instance of the specified component. | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | `instantiateManaged(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)`
Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`
Returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`
Returns sub-directories from a specified directory | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXLibrarianCombiner ```java -public PHXLibrarianCombiner() +public PHXLibrarianCombiner() ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### addLibrarian +## Method Detail + +### addLibrarian ```java -public void addLibrarian(IPHXLibrarian l) +public void addLibrarian(IPHXLibrarian l) ``` Adds a librarian to our list -- #### initialize +### initialize ```java -public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, - IPHXFactory factories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions) +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) throws java.lang.Exception ``` -The XML initialization information for this class is simply a list of tags which contain - and tags inside. +The XML initialization information for this class is simply a list of `` tags which contain `` and `` tags inside. + Example: ```java - com.phoenix_int.aserver.library.PHXDirectoryLibrarian @@ -102,236 +93,249 @@ Example: .... - ``` -**Specified by:** -: `initialize`in interface`IPHXLibrarian` + +**Specified By:** +- `initialize` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### cleanUp +### cleanUp ```java -public void cleanUp() +public void cleanUp() ``` Recursively tells kids to clean themselves up -**Specified by:** -: `cleanUp`in interface`IPHXLibrarian` -- #### listComponents +**Specified By:** +- `cleanUp` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + +### listComponents ```java -public java.util.Collection listComponents(java.lang.String virtualDir) +public java.util.Collection listComponents(java.lang.String virtualDir) throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -returns the components in a specific directory -**Specified by:** -: `listComponents`in interface`IPHXLibrarian` +Returns the components in a specific directory + +**Specified By:** +- `listComponents` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: an array of class names +- An array of class names + **Throws:** -: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned -: `PHXNoSuchCategoryException` +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` - if the directory could not be scanned +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) -- #### listDirectories +### listDirectories ```java -public java.util.Collection listDirectories(java.lang.String virtualDir) +public java.util.Collection listDirectories(java.lang.String virtualDir) throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` Returns sub-directories from a specified directory -**Specified by:** -: `listDirectories`in interface`IPHXLibrarian` + +**Specified By:** +- `listDirectories` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: a Collection of Strings +- A Collection of Strings + **Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` -- #### instantiate +### instantiate ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir) +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -creates an instance of the specified component. -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` +Creates an instance of the specified component. + +**Specified By:** +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class +- `compClass` - The class name for the component +- `virtualDir` - The directory to search for the component class + **Returns:** -: an instance of the associated component class with the file loaded +- An instance of the associated component class with the file loaded + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `java.lang.IllegalAccessException`- cannot call constructor -: `java.lang.InstantiationException`- cannot call constructor -: `java.lang.reflect.InvocationTargetException`- if an exception if the specified component exists, but is - not of the right type, or if an exception occurs while creating the class or loading the setup file -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.Exception`- If anything serious goes wrong +- `java.lang.ClassNotFoundException` - if the class is not found +- `java.lang.IllegalAccessException` - cannot call constructor +- `java.lang.InstantiationException` - cannot call constructor +- `java.lang.reflect.InvocationTargetException` - if an exception if the specified component exists, but is not of the right type, or if an exception occurs while creating the class or loading the setup file +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.Exception` - If anything serious goes wrong -- #### instantiate +### instantiate (overload) ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) throws java.lang.Exception ``` -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` +**Specified By:** +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### instantiateManaged +### instantiateManaged ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir) +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). + +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Specified By:** +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: an instance of the specified component class and its managed resources +- An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### instantiateManaged +### instantiateManaged (overload) ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) throws java.lang.Exception ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). + +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Specified By:** +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for -: `connector`- name of the connector object to use -: `queue`- name of the queue object to use +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for +- `connector` - Name of the connector object to use +- `queue` - Name of the queue object to use + **Returns:** -: an instance of the specified component class and its managed resources +- An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### describe +### describe ```java -public PHXComponentDescription describe(java.lang.String compClass, - java.lang.String virtualDir) +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -describes the specified component. -**Specified by:** -: `describe`in interface`IPHXLibrarian` +Describes the specified component. + +**Specified By:** +- `describe` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: a description of the specified component class +- A description of the specified component class ([`PHXComponentDescription`](../PHXComponentDescription.md)) + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.Exception`- If anything goes wrong +- `java.lang.ClassNotFoundException` - if the class is not found +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.Exception` - If anything goes wrong -- #### getQueues +### getQueues ```java -public java.lang.String getQueues(java.lang.String compClass, - java.lang.String virtualDir) +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -get the queues for the specified component. -**Specified by:** -: `getQueues`in interface`IPHXLibrarian` +Get the queues for the specified component. + +**Specified By:** +- `getQueues` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: a list of queues of the specified component class +- A list of queues of the specified component class + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.Exception`- If anything goes wrong +- `java.lang.ClassNotFoundException` - if the class is not found +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.Exception` - If anything goes wrong -- #### getComponentHistory +### getComponentHistory ```java -public PHXComponentBranch getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir) +public PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -Description copied from interface:`IPHXVersionedLibrarian`Gets all version information about a particular component -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `getComponentHistory`in interface`IPHXVersionedLibrarian` +Gets all version information about a particular component. + +**Specified By:** +- `getComponentHistory` in interface [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: An instance of PHXComponentBranch which contains - all the versions and sub-branches available +- An instance of [`PHXComponentBranch`](../PHXComponentBranch.md) which contains all the versions and sub-branches available + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong -- #### getBranchesAndTags +### getBranchesAndTags ```java -public java.lang.String getBranchesAndTags() +public java.lang.String getBranchesAndTags() throws java.lang.Exception ``` -Description copied from interface:`IPHXVersionedLibrarian2`Fetches a list of all branches and tags -**Specified by:** -: `getBranchesAndTags`in interface`IPHXVersionedLibrarian2` +Fetches a list of all branches and tags. + +**Specified By:** +- `getBranchesAndTags` in interface [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md) + **Throws:** -: `java.lang.Exception`- If anything goes wrong -========= END OF CLASS DATA ========= \ No newline at end of file +- `java.lang.Exception` - If anything goes wrong \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md index 13b6c1d297..868c375456 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXLibrarianMounter.md @@ -1,107 +1,93 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXLibrarianMounter -- java.lang.Object -- - com.phoenix_int.aserver.library.PHXLibrarianMounter -- **All Implemented Interfaces:** -: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2,[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html),[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html), com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 +# Class: PHXLibrarianMounter ---- +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.library.PHXLibrarianMounter +``` + +**Implemented Interfaces** + +- [`IPHXLibrarian`](IPHXLibrarian.md), [`IPHXLibrarian2`](IPHXLibrarian2.md), [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md), [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md), `IPHXVersionedLibrarian3` + +--- + +**Declaration** ```java public class PHXLibrarianMounter extends java.lang.Object implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 ``` -This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be - "mounted" very similarly to the UNIX concept of mounting filesystems. -When a librarian is mounted to a particular location, any components and directories that are available via a - librarian mounted higher up in the directory tree are hidden. - -This class will automatically add empty directories as necessary to ensure that you can "browse" to a mount point. - For example, if you have not mounted anything to the root ("" or "/"), you can still mount to a subdirectory like - "mount/here" and this class will create the empty directory "mount". - -Only one librarian can be mounted in a given location. Use a PHXLibrarianCombiner to put multiple librarians in the - same place. -**Version:** -: Dec 2001 -**Author:** -: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be mounted very similarly to the UNIX concept of mounting filesystems. When a librarian is mounted to a particular location, any components and directories that are available via a librarian mounted higher up in the directory tree are hidden. + +This class will automatically add empty directories as necessary to ensure that you can "browse" to a mount point. For example, if you have not mounted anything to the root ("" or "/"), you can still mount to a subdirectory like "mount/here" and this class will create the empty directory "mount". + +Only one librarian can be mounted in a given location. Use a [`PHXLibrarianCombiner`](PHXLibrarianCombiner.md) to put multiple librarians in the same place. + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------| | `PHXLibrarianMounter()` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `addLibrarian(java.lang.String mountPoint,IPHXLibrarianl)`Creates a librarian mount. | -| `void` | `cleanUp()`Recursively calls cleanUp on all our mount points | -| `PHXComponentDescription` | `describe(java.lang.String compClass, - java.lang.String virtualDir)`describes the specified component. | -| `java.lang.String` | `getBranchesAndTags()`Fetches a list of all branches and tags | -| `PHXComponentBranch` | `getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir)`Gets all version information about a particular component | -| `java.lang.String` | `getQueues(java.lang.String compClass, - java.lang.String virtualDir)`gets queues for the specified component. | -| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions)`The XML initialization information for this class is simply a list of tags which contain - , , and tags inside. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir)`creates an instance of the specified component. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)` | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir)`Creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`Creates an instance of the specified component. | -| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | -| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`lists any available sub-directories from a particular directory | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXLibrarianMounter +|-------------------|----------------------| +| `void` | `addLibrarian(java.lang.String mountPoint, IPHXLibrarian l)`
Creates a librarian mount. | +| `void` | `cleanUp()`
Recursively calls cleanUp on all our mount points | +| [`PHXComponentDescription`](../PHXComponentDescription.md) | `describe(java.lang.String compClass, java.lang.String virtualDir)`
Describes the specified component. | +| `java.lang.String` | `getBranchesAndTags()`
Fetches a list of all branches and tags | +| [`PHXComponentBranch`](../PHXComponentBranch.md) | `getComponentHistory(java.lang.String compClass, java.lang.String virtualDir)`
Gets all version information about a particular component | +| `java.lang.String` | `getQueues(java.lang.String compClass, java.lang.String virtualDir)`
Gets queues for the specified component. | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, IPHXFactory factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions)`
The XML initialization information for this class is simply a list of tags which contain , , and tags inside. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, java.lang.String virtualDir)`
Creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)` | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | `instantiateManaged(java.lang.String compClass, java.lang.String virtualDir)`
Creates an instance of the specified component. | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | `instantiateManaged(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)`
Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`
Returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`
Lists any available sub-directories from a particular directory | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXLibrarianMounter ```java -public PHXLibrarianMounter() +public PHXLibrarianMounter() ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### addLibrarian +## Method Detail + +### addLibrarian ```java -public void addLibrarian(java.lang.String mountPoint, - IPHXLibrarian l) +public void addLibrarian(java.lang.String mountPoint, + IPHXLibrarian l) ``` Creates a librarian mount. -- #### initialize +### initialize ```java -public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, - IPHXFactory factories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions) +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) ``` -The XML initialization information for this class is simply a list of tags which contain - , , and tags inside. +The XML initialization information for this class is simply a list of `` tags which contain ``, ``, and `` tags inside. + Example: ```java - /mounthere @@ -112,234 +98,245 @@ Example: .... - ``` -**Specified by:** -: `initialize`in interface`IPHXLibrarian` -- #### cleanUp +**Specified By:** +- `initialize` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + +### cleanUp ```java -public void cleanUp() +public void cleanUp() ``` Recursively calls cleanUp on all our mount points -**Specified by:** -: `cleanUp`in interface`IPHXLibrarian` -- #### listComponents +**Specified By:** +- `cleanUp` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + +### listComponents ```java -public java.util.Collection listComponents(java.lang.String virtualDir) +public java.util.Collection listComponents(java.lang.String virtualDir) throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -returns the components in a specific directory -**Specified by:** -: `listComponents`in interface`IPHXLibrarian` +Returns the components in a specific directory + +**Specified By:** +- `listComponents` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: an array of class names +- An array of class names + **Throws:** -: `com.phoenix_int.aserver.security.PHXAccessDeniedException`- if the directory could not be scanned -: `PHXNoSuchCategoryException` +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` - if the directory could not be scanned +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) -- #### listDirectories +### listDirectories ```java -public java.util.Collection listDirectories(java.lang.String virtualDir) +public java.util.Collection listDirectories(java.lang.String virtualDir) throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -Description copied from interface:`IPHXLibrarian`lists any available sub-directories from a particular directory -**Specified by:** -: `listDirectories`in interface`IPHXLibrarian` +Lists any available sub-directories from a particular directory + +**Specified By:** +- `listDirectories` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: a Collection of Strings +- A Collection of Strings + **Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` -- #### instantiate +### instantiate ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir) +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -creates an instance of the specified component. -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` +Creates an instance of the specified component. + +**Specified By:** +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class +- `compClass` - The class name for the component +- `virtualDir` - The directory to search for the component class + **Returns:** -: an instance of the associated component class with the file loaded +- An instance of the associated component class with the file loaded + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `java.lang.IllegalAccessException`- cannot call constructor -: `java.lang.InstantiationException`- cannot call constructor -: `java.lang.reflect.InvocationTargetException`- if an exception if the specified component exists, but is - not of the right type, or if an exception occurs while creating the class or loading the setup file -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.Exception`- If anything serious goes wrong +- `java.lang.ClassNotFoundException` - if the class is not found +- `java.lang.IllegalAccessException` - cannot call constructor +- `java.lang.InstantiationException` - cannot call constructor +- `java.lang.reflect.InvocationTargetException` - if an exception if the specified component exists, but is not of the right type, or if an exception occurs while creating the class or loading the setup file +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.Exception` - If anything serious goes wrong -- #### instantiate +### instantiate (overload) ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) throws java.lang.Exception ``` +**Specified By:** +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### instantiateManaged +### instantiateManaged ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir) +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). + +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Specified By:** +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: an instance of the specified component class and its managed resources +- An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### instantiateManaged +### instantiateManaged (overload) ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) throws java.lang.Exception ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). + +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Specified By:** +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for -: `connector`- name of the connector object to use -: `queue`- name of the queue object to use +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for +- `connector` - Name of the connector object to use +- `queue` - Name of the queue object to use + **Returns:** -: an instance of the specified component class and its managed resources +- An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### describe +### describe ```java -public PHXComponentDescription describe(java.lang.String compClass, - java.lang.String virtualDir) +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -describes the specified component. -**Specified by:** -: `describe`in interface`IPHXLibrarian` +Describes the specified component. + +**Specified By:** +- `describe` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: a description of the specified component class +- A description of the specified component class ([`PHXComponentDescription`](../PHXComponentDescription.md)) + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.Exception`- If anything goes wrong +- `java.lang.ClassNotFoundException` - if the class is not found +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.Exception` - If anything goes wrong -- #### getQueues +### getQueues ```java -public java.lang.String getQueues(java.lang.String compClass, - java.lang.String virtualDir) +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -gets queues for the specified component. -**Specified by:** -: `getQueues`in interface`IPHXLibrarian` +Gets queues for the specified component. + +**Specified By:** +- `getQueues` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: a list of queues for the specified component class +- A list of queues for the specified component class + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.Exception`- If anything goes wrong +- `java.lang.ClassNotFoundException` - if the class is not found +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.Exception` - If anything goes wrong -- #### getComponentHistory +### getComponentHistory ```java -public PHXComponentBranch getComponentHistory(java.lang.String compClass, - java.lang.String virtualDir) +public PHXComponentBranch getComponentHistory(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -Description copied from interface:`IPHXVersionedLibrarian`Gets all version information about a particular component -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `getComponentHistory`in interface`IPHXVersionedLibrarian` +Gets all version information about a particular component. + +**Specified By:** +- `getComponentHistory` in interface [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: An instance of PHXComponentBranch which contains - all the versions and sub-branches available +- An instance of [`PHXComponentBranch`](../PHXComponentBranch.md) which contains all the versions and sub-branches available + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong -- #### getBranchesAndTags +### getBranchesAndTags ```java -public java.lang.String getBranchesAndTags() +public java.lang.String getBranchesAndTags() throws java.lang.Exception ``` -Description copied from interface:`IPHXVersionedLibrarian2`Fetches a list of all branches and tags -**Specified by:** -: `getBranchesAndTags`in interface`IPHXVersionedLibrarian2` +Fetches a list of all branches and tags. + +**Specified By:** +- `getBranchesAndTags` in interface [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md) + **Throws:** -: `java.lang.Exception`- If anything goes wrong -========= END OF CLASS DATA ========= \ No newline at end of file +- `java.lang.Exception` - If anything goes wrong \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md index 279d55f965..061e85a830 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md @@ -1,61 +1,74 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXNoSuchAssociationException -- java.lang.Object -- - java.lang.Throwable -- - java.lang.Exception -- - com.phoenix_int.aserver.library.PHXNoSuchAssociationException -- **All Implemented Interfaces:** -: java.io.Serializable - ---- +# Class: PHXNoSuchAssociationException + +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.library.PHXNoSuchAssociationException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** ```java public class PHXNoSuchAssociationException extends java.lang.Exception ``` -An exception that is thrown when an invalid association - is specified. -**See Also:** -: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.library.PHXNoSuchAssociationException)- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +An exception that is thrown when an invalid association is specified. + +## See Also + +- [Serialized Form](../../../../serialized-form.md) + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXNoSuchAssociationException(java.lang.String name)` | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------| +| `PHXNoSuchAssociationException(java.lang.String name)` | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `java.lang.String` | `getInvalidAssociation()`retrieves the name that was invalid | +|-------------------|----------------------| +| `java.lang.String` | `getInvalidAssociation()`
Retrieves the name that was invalid | -- ### Methods inherited from class java.lang.Throwable -`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` +### Methods inherited from class java.lang.Throwable -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` -- #### PHXNoSuchAssociationException +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXNoSuchAssociationException ```java -public PHXNoSuchAssociationException(java.lang.String name) +public PHXNoSuchAssociationException(java.lang.String name) ``` **Parameters:** -: `name`- the name that had no association -============ METHOD DETAIL ========== -- ### Method Detail +- `name` - The name that had no association -- #### getInvalidAssociation +## Method Detail + +### getInvalidAssociation ```java -public java.lang.String getInvalidAssociation() +public java.lang.String getInvalidAssociation() ``` -retrieves the name that was invalid +Retrieves the name that was invalid + **Returns:** -: the invalid name -========= END OF CLASS DATA ========= \ No newline at end of file +- The invalid name \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md index 3af922fe8c..f135ca6501 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md @@ -1,92 +1,102 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXNoSuchCategoryException -- java.lang.Object -- - java.lang.Throwable -- - java.lang.Exception -- - com.phoenix_int.aserver.library.PHXNoSuchCategoryException -- **All Implemented Interfaces:** -: java.io.Serializable +# Class: PHXNoSuchCategoryException + +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.library.PHXNoSuchCategoryException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` --- +**Declaration** + ```java public class PHXNoSuchCategoryException extends java.lang.Exception ``` -An exception that is thrown when an invalid class category - is specified. -**See Also:** -: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.library.PHXNoSuchCategoryException)- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +An exception that is thrown when an invalid class category is specified. + +## See Also + +- [Serialized Form](../../../../serialized-form.md) + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXNoSuchCategoryException(java.lang.String category)` | -| `PHXNoSuchCategoryException(java.lang.String msg, - java.lang.String category)`Constructor for this exception containing both a specific message and the category - which could not be found. | -| `PHXNoSuchCategoryException(java.lang.String msg, - java.lang.String category, - java.lang.Exception ex)`Constructor which takes a message, a category, and an inner exception. | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------| +| `PHXNoSuchCategoryException(java.lang.String category)` | +| `PHXNoSuchCategoryException(java.lang.String msg, java.lang.String category)`
Constructor for this exception containing both a specific message and the category which could not be found. | +| `PHXNoSuchCategoryException(java.lang.String msg, java.lang.String category, java.lang.Exception ex)`
Constructor which takes a message, a category, and an inner exception. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `java.lang.String` | `getInvalidCategory()`retrieves the category name that was invalid | +|-------------------|----------------------| +| `java.lang.String` | `getInvalidCategory()`
Retrieves the category name that was invalid | + +### Methods inherited from class java.lang.Throwable + +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` -- ### Methods inherited from class java.lang.Throwable -`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` +### Methods inherited from class java.lang.Object -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- #### PHXNoSuchCategoryException +## Constructor Detail + +### PHXNoSuchCategoryException ```java -public PHXNoSuchCategoryException(java.lang.String category) +public PHXNoSuchCategoryException(java.lang.String category) ``` **Parameters:** -: `category`- the category name that was invalid +- `category` - The category name that was invalid -- #### PHXNoSuchCategoryException +### PHXNoSuchCategoryException ```java -public PHXNoSuchCategoryException(java.lang.String msg, - java.lang.String category) +public PHXNoSuchCategoryException(java.lang.String msg, + java.lang.String category) ``` -Constructor for this exception containing both a specific message and the category - which could not be found. +Constructor for this exception containing both a specific message and the category which could not be found. + **Parameters:** -: `msg`- - The message associated with this exception. -: `category`- - The category which couldn't be found. +- `msg` - The message associated with this exception. +- `category` - The category which couldn't be found. -- #### PHXNoSuchCategoryException +### PHXNoSuchCategoryException ```java -public PHXNoSuchCategoryException(java.lang.String msg, - java.lang.String category, - java.lang.Exception ex) +public PHXNoSuchCategoryException(java.lang.String msg, + java.lang.String category, + java.lang.Exception ex) ``` Constructor which takes a message, a category, and an inner exception. + **Parameters:** -: `msg`- - The message associated with this specific exception. -: `category`- - The category which could not be found. -: `ex`- - The inner exception. -============ METHOD DETAIL ========== -- ### Method Detail +- `msg` - The message associated with this specific exception. +- `category` - The category which could not be found. +- `ex` - The inner exception. -- #### getInvalidCategory +## Method Detail + +### getInvalidCategory ```java -public java.lang.String getInvalidCategory() +public java.lang.String getInvalidCategory() ``` -retrieves the category name that was invalid +Retrieves the category name that was invalid + **Returns:** -: the invalid category name -========= END OF CLASS DATA ========= \ No newline at end of file +- The invalid category name \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md index 0118b38926..c6b6629078 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXNoSuchIconException.md @@ -1,61 +1,74 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXNoSuchIconException -- java.lang.Object -- - java.lang.Throwable -- - java.lang.Exception -- - com.phoenix_int.aserver.library.PHXNoSuchIconException -- **All Implemented Interfaces:** -: java.io.Serializable - ---- +# Class: PHXNoSuchIconException + +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.library.PHXNoSuchIconException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- + +**Declaration** ```java public class PHXNoSuchIconException extends java.lang.Exception ``` -An exception that is thrown when an invalid icon - is specified. -**See Also:** -: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.library.PHXNoSuchIconException)- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +An exception that is thrown when an invalid icon is specified. + +## See Also + +- [Serialized Form](../../../../serialized-form.md) + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXNoSuchIconException(java.lang.String name)` | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------| +| `PHXNoSuchIconException(java.lang.String name)` | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `java.lang.String` | `getInvalidIcon()`retrieves the name that was invalid | +|-------------------|----------------------| +| `java.lang.String` | `getInvalidIcon()`
Retrieves the name that was invalid | -- ### Methods inherited from class java.lang.Throwable -`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` +### Methods inherited from class java.lang.Throwable -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` -- #### PHXNoSuchIconException +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXNoSuchIconException ```java -public PHXNoSuchIconException(java.lang.String name) +public PHXNoSuchIconException(java.lang.String name) ``` **Parameters:** -: `name`- the name that had no icon -============ METHOD DETAIL ========== -- ### Method Detail +- `name` - The name that had no icon -- #### getInvalidIcon +## Method Detail + +### getInvalidIcon ```java -public java.lang.String getInvalidIcon() +public java.lang.String getInvalidIcon() ``` -retrieves the name that was invalid +Retrieves the name that was invalid + **Returns:** -: the invalid name -========= END OF CLASS DATA ========= \ No newline at end of file +- The invalid name \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md index 307050dc07..190b0c0d43 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md @@ -1,300 +1,302 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.library -## Class PHXUserDirLibrarian -- java.lang.Object -- - com.phoenix_int.aserver.library.PHXUserDirLibrarian -- **All Implemented Interfaces:** -: [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html), com.phoenix_int.aserver.library.IPHXLibrarian2 +# Class: PHXUserDirLibrarian + +**Package:** `com.phoenix_int.aserver.library` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.library.PHXUserDirLibrarian +``` + +**Implemented Interfaces** + +- [`IPHXLibrarian`](IPHXLibrarian.md), `IPHXLibrarian2` --- +**Declaration** + ```java public class PHXUserDirLibrarian extends java.lang.Object implements com.phoenix_int.aserver.library.IPHXLibrarian2 ``` -This librarian provides "user" directories by looking in a user path - or by reading /etc/passwd. It looks for "public_mcre" directories - inside of each users directory and provides a "virtual" directory - by the name "~" if it finds one. -**Version:** -: Dec 2001 -**Author:** -: Nathan P Sharp- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +This librarian provides "user" directories by looking in a user path or by reading `/etc/passwd`. It looks for "public_mcre" directories inside of each user's directory and provides a "virtual" directory by the name `~` if it finds one. + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------| | `PHXUserDirLibrarian()` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `cleanUp()`Tells this librarian to clean up any resources used. | -| `PHXComponentDescription` | `describe(java.lang.String compClass, - java.lang.String virtualDir)`describes the specified component. | -| `java.lang.String` | `getQueues(java.lang.String compClass, - java.lang.String virtualDir)`method for getting Queues from CenterLink, MCRE just returns blank string | -| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,IPHXFactoryfactories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions)`There are 2 options for this class. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir)`creates an instance of the specified component. | -| `IPHXComponent` | `instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir)`Creates an instance of the specified component. | -| `com.phoenix_int.aserver.PHXComponentResourcePair` | `instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue)`Creates an instance of the specified component. | -| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`returns the components in a specific directory | -| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`lists any available sub-directories from a particular directory | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXUserDirLibrarian +|-------------------|----------------------| +| `void` | `cleanUp()`
Tells this librarian to clean up any resources used. | +| [`PHXComponentDescription`](../PHXComponentDescription.md) | `describe(java.lang.String compClass, java.lang.String virtualDir)`
Describes the specified component. | +| `java.lang.String` | `getQueues(java.lang.String compClass, java.lang.String virtualDir)`
Method for getting Queues from CenterLink, MCRE just returns blank string | +| `void` | `initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, IPHXFactory factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions)`
There are 2 options for this class. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, java.lang.String virtualDir)`
Creates an instance of the specified component. | +| `IPHXComponent` | `instantiate(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)`
Creates an instance of the specified component. | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | `instantiateManaged(java.lang.String compClass, java.lang.String virtualDir)`
Creates an instance of the specified component. | +| [`PHXComponentResourcePair`](../PHXComponentResourcePair.md) | `instantiateManaged(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)`
Creates an instance of the specified component. | +| `java.util.Collection` | `listComponents(java.lang.String virtualDir)`
Returns the components in a specific directory | +| `java.util.Collection` | `listDirectories(java.lang.String virtualDir)`
Lists any available sub-directories from a particular directory | + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXUserDirLibrarian ```java -public PHXUserDirLibrarian() +public PHXUserDirLibrarian() ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### initialize +## Method Detail + +### initialize ```java -public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, - IPHXFactory factories, - com.phoenix_int.aserver.ascore.PHXAServerArgs args, - org.w3c.dom.Node xmlOptions) +public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, + IPHXFactory factories, + com.phoenix_int.aserver.ascore.PHXAServerArgs args, + org.w3c.dom.Node xmlOptions) throws java.lang.Exception ``` -There are 2 options for this class. The first is "userPath", which - is a semi-colon separated list of paths to search. Each path will - be searched for public_mcre directories ONE LEVEL DEEP from the - specified directory. -The other option is "smartUserScan", which tells this class to try - and read the user's home directories from /etc/passwd +There are 2 options for this class. The first is `userPath`, which is a semi-colon separated list of paths to search. Each path will be searched for public_mcre directories ONE LEVEL DEEP from the specified directory. The other option is `smartUserScan`, which tells this class to try and read the user's home directories from `/etc/passwd`. The XML format is: ```java - path1/here;path2 - ``` -Note, the mere existance of the smartUserScan tag turns the option on. -**Specified by:** -: `initialize`in interface`IPHXLibrarian` +Note: the mere existence of the `smartUserScan` tag turns the option on. + +**Specified By:** +- `initialize` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### cleanUp +### cleanUp ```java -public void cleanUp() +public void cleanUp() ``` -Description copied from interface:`IPHXLibrarian`Tells this librarian to clean up any resources used. -**Specified by:** -: `cleanUp`in interface`IPHXLibrarian` +Tells this librarian to clean up any resources used. + +**Specified By:** +- `cleanUp` in interface [`IPHXLibrarian`](IPHXLibrarian.md) -- #### listComponents +### listComponents ```java -public java.util.Collection listComponents(java.lang.String virtualDir) +public java.util.Collection listComponents(java.lang.String virtualDir) throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -returns the components in a specific directory -**Specified by:** -: `listComponents`in interface`IPHXLibrarian` +Returns the components in a specific directory + +**Specified By:** +- `listComponents` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: an array of class names +- An array of class names + **Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` -- #### listDirectories +### listDirectories ```java -public java.util.Collection listDirectories(java.lang.String virtualDir) +public java.util.Collection listDirectories(java.lang.String virtualDir) throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` -Description copied from interface:`IPHXLibrarian`lists any available sub-directories from a particular directory -**Specified by:** -: `listDirectories`in interface`IPHXLibrarian` +Lists any available sub-directories from a particular directory + +**Specified By:** +- `listDirectories` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `virtualDir`- The directory the client asked for +- `virtualDir` - The directory the client asked for + **Returns:** -: a Collection of Strings +- A Collection of Strings + **Throws:** -: `PHXNoSuchCategoryException` -: `com.phoenix_int.aserver.security.PHXAccessDeniedException` +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) +- `com.phoenix_int.aserver.security.PHXAccessDeniedException` -- #### instantiate +### instantiate ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) throws java.lang.Exception ``` -creates an instance of the specified component. -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` +Creates an instance of the specified component. + +**Specified By:** +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class +- `compClass` - The class name for the component +- `virtualDir` - The directory to search for the component class +- `connector` - Name of the connector object to use +- `queue` - Name of the queue object to use + **Returns:** -: an instance of the associated component class with the file - loaded +- An instance of the associated component class with the file loaded + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `java.lang.IllegalAccessException`- cannot call constructor -: `java.lang.InstantiationException`- cannot call constructor -: `java.lang.reflect.InvocationTargetException`- if an exception - if the specified component exists, but is not of the right type, - or if an exception occurs while creating the class or loading - the setup file -: `java.lang.Exception` +- `java.lang.ClassNotFoundException` - if the class is not found +- `java.lang.IllegalAccessException` - cannot call constructor +- `java.lang.InstantiationException` - cannot call constructor +- `java.lang.reflect.InvocationTargetException` - if an exception if the specified component exists, but is not of the right type, or if an exception occurs while creating the class or loading the setup file +- `java.lang.Exception` -- #### instantiate +### instantiate (overload) ```java -public IPHXComponent instantiate(java.lang.String compClass, - java.lang.String virtualDir) +public IPHXComponent instantiate(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the - request off to the IPHXFactory. -It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate - cases as they are handled in special ways by the librarian mounter and librarian combiner. -**Specified by:** -: `instantiate`in interface`IPHXLibrarian` +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). + +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Specified By:** +- `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: an instance of the specified component class +- An instance of the specified component class + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### instantiateManaged +### instantiateManaged ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir, - java.lang.String connector, - java.lang.String queue) - throws java.lang.Exception +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir, + java.lang.String connector, + java.lang.String queue) + throws java.lang.Exception ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). + +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Specified By:** +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for -: `connector`- name of the connector object to use -: `queue`- name of the queue object to use +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for +- `connector` - Name of the connector object to use +- `queue` - Name of the queue object to use + **Returns:** -: an instance of the specified component class and its managed resources +- An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### instantiateManaged +### instantiateManaged (overload) ```java -public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, - java.lang.String virtualDir) +public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -Creates an instance of the specified component. - Typically a librarian will find the appropriate files - and pass the request off to the IPHXFactory. -It is important that this class throws - PHXNoSuchCategoryException and ClassNotFoundException - in the appropriate cases as they are handled - in special ways by the librarian mounter and librarian - combiner. -**Specified by:** -: `instantiateManaged`in interface`com.phoenix_int.aserver.library.IPHXLibrarian2` +Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the [`IPHXFactory`](IPHXFactory.md). + +It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. + +**Specified By:** +- `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: an instance of the specified component class and its managed resources +- An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName - passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't - indicate a valid class for the specified directory -: `java.lang.Exception`- If anything serious goes wrong +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything serious goes wrong -- #### describe +### describe ```java -public PHXComponentDescription describe(java.lang.String compClass, - java.lang.String virtualDir) +public PHXComponentDescription describe(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -describes the specified component. -**Specified by:** -: `describe`in interface`IPHXLibrarian` +Describes the specified component. + +**Specified By:** +- `describe` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- the directory to search for the component class +- `compClass` - The class name for the component +- `virtualDir` - The directory to search for the component class + **Returns:** -: a description of the specified component class +- A description of the specified component class ([`PHXComponentDescription`](../PHXComponentDescription.md)) + **Throws:** -: `java.lang.ClassNotFoundException`- if the class is not found -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.Exception`- If anything goes wrong +- `java.lang.ClassNotFoundException` - if the class is not found +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.Exception` - If anything goes wrong -- #### getQueues +### getQueues ```java -public java.lang.String getQueues(java.lang.String compClass, - java.lang.String virtualDir) +public java.lang.String getQueues(java.lang.String compClass, + java.lang.String virtualDir) throws java.lang.Exception ``` -method for getting Queues from CenterLink, MCRE just returns blank string -**Specified by:** -: `getQueues`in interface`IPHXLibrarian` +Method for getting Queues from CenterLink, MCRE just returns blank string + +**Specified By:** +- `getQueues` in interface [`IPHXLibrarian`](IPHXLibrarian.md) + **Parameters:** -: `compClass`- the class name for the component -: `virtualDir`- The directory the client asked for +- `compClass` - The class name for the component +- `virtualDir` - The directory the client asked for + **Returns:** -: a list of queues for the specified component class +- A list of queues for the specified component class + **Throws:** -: `PHXNoSuchCategoryException`- If the virtualDirName passed in is invalid -: `java.lang.ClassNotFoundException`- If compClass doesn't indicate a valid class for the specified directory -: `java.lang.Exception`- If anything goes wrong -========= END OF CLASS DATA ========= \ No newline at end of file +- [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid +- `java.lang.ClassNotFoundException` - If `compClass` doesn't indicate a valid class for the specified directory +- `java.lang.Exception` - If anything goes wrong \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-frame.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-frame.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md index 0758fe1fdd..c2c8b8bf87 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-summary.md @@ -1,35 +1,29 @@ # Package com.phoenix_int.aserver.library -Provides a library of available components and catgories (directories) and -factories for instantiating components. -See:Description -- | Interface | Description | +Provides a library of available components and categories (directories) and factories for instantiating components. + +## Interfaces +| Interface | Description | | --- | --- | -| [IPHXFactory](../../../../com/phoenix_int/aserver/library/IPHXFactory.html) | DeprecatedIt is preferred to use`IPHXFactory2`, as this class has methods that can leak resources | -| [IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html) | DeprecatedIt is preferred to use`IPHXLibrarian2`as this class uses methods that can leak resources. | -| [IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html) | DeprecatedIt is preferred to use`IPHXVersionedLibrarian3`as this class has methods that - can leak resources | -| [IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) | DeprecatedIt is preferred to use`IPHXVersionedLibrarian3`as this class supports - methods that can cause file leaks. | -- | Class | Description | +| [`IPHXFactory`](IPHXFactory.md) | Deprecated. It is preferred to use `IPHXFactory2`, as this class has methods that can leak resources. | +| [`IPHXLibrarian`](IPHXLibrarian.md) | Deprecated. It is preferred to use `IPHXLibrarian2` as this class uses methods that can leak resources. | +| [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) | Deprecated. It is preferred to use `IPHXVersionedLibrarian3` as this class has methods that can leak resources. | +| [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md) | Deprecated. It is preferred to use `IPHXVersionedLibrarian3` as this class supports methods that can cause file leaks. | + +## Classes +| Class | Description | | --- | --- | -| [PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html) | Implementation of IPHXLibrarian which loads files out of CVS. | -| [PHXDirectoryLibrarian](../../../../com/phoenix_int/aserver/library/PHXDirectoryLibrarian.html) | This librarian provides a window into a directory on disk that contains wrapper and component files. | -| [PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html) | This class combines several sub-librarians, adding dir lists and component lists together. | -| [PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html) | This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be - "mounted" very similarly to the UNIX concept of mounting filesystems. | -| [PHXUserDirLibrarian](../../../../com/phoenix_int/aserver/library/PHXUserDirLibrarian.html) | This librarian provides "user" directories by looking in a user path - or by reading /etc/passwd. | -- | Exception | Description | +| [`PHXCVSLibrarian`](PHXCVSLibrarian.md) | Implementation of IPHXLibrarian which loads files out of CVS. | +| [`PHXDirectoryLibrarian`](PHXDirectoryLibrarian.md) | This librarian provides a window into a directory on disk that contains wrapper and component files. | +| [`PHXLibrarianCombiner`](PHXLibrarianCombiner.md) | This class combines several sub-librarians, adding dir lists and component lists together. | +| [`PHXLibrarianMounter`](PHXLibrarianMounter.md) | This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be "mounted" very similarly to the UNIX concept of mounting filesystems. | +| [`PHXUserDirLibrarian`](PHXUserDirLibrarian.md) | This librarian provides "user" directories by looking in a user path or by reading /etc/passwd. | + +## Exceptions +| Exception | Description | | --- | --- | -| [PHXNoSuchAssociationException](../../../../com/phoenix_int/aserver/library/PHXNoSuchAssociationException.html) | An exception that is thrown when an invalid association - is specified. | -| [PHXNoSuchCategoryException](../../../../com/phoenix_int/aserver/library/PHXNoSuchCategoryException.html) | An exception that is thrown when an invalid class category - is specified. | -| [PHXNoSuchIconException](../../../../com/phoenix_int/aserver/library/PHXNoSuchIconException.html) | An exception that is thrown when an invalid icon - is specified. | +| [`PHXNoSuchAssociationException`](PHXNoSuchAssociationException.md) | An exception that is thrown when an invalid association is specified. | +| [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) | An exception that is thrown when an invalid class category is specified. | +| [`PHXNoSuchIconException`](PHXNoSuchIconException.md) | An exception that is thrown when an invalid icon is specified. | -## Package com.phoenix_int.aserver.library Description -Provides a library of available components and catgories (directories) and -factories for instantiating components. Contains the -standard directory-based publishing technique as well as interfaces for writing -archiving and versioning plug-ins.Put @see and @since tags down here. \ No newline at end of file +## Package Description +Provides a library of available components and categories (directories) and factories for instantiating components. Contains the standard directory-based publishing technique as well as interfaces for writing archiving and versioning plug-ins. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md index dab2df3528..d447e9946c 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/package-tree.md @@ -1,23 +1,25 @@ # Hierarchy For Package com.phoenix_int.aserver.library -Package Hierarchies: + +**Package Hierarchies:** - [All Packages](../../../../overview-tree.html) + ## Class Hierarchy - java.lang.Object -- com.phoenix_int.aserver.library.[PHXCVSLibrarian](../../../../com/phoenix_int/aserver/library/PHXCVSLibrarian.html)(implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) -- com.phoenix_int.aserver.library.[PHXDirectoryLibrarian](../../../../com/phoenix_int/aserver/library/PHXDirectoryLibrarian.html)(implements com.phoenix_int.aserver.library.IPHXLibrarian2) -- com.phoenix_int.aserver.library.[PHXLibrarianCombiner](../../../../com/phoenix_int/aserver/library/PHXLibrarianCombiner.html)(implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) -- com.phoenix_int.aserver.library.[PHXLibrarianMounter](../../../../com/phoenix_int/aserver/library/PHXLibrarianMounter.html)(implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) -- com.phoenix_int.aserver.library.[PHXUserDirLibrarian](../../../../com/phoenix_int/aserver/library/PHXUserDirLibrarian.html)(implements com.phoenix_int.aserver.library.IPHXLibrarian2) -- java.lang.Throwable (implements java.io.Serializable) -- java.lang.Exception -- com.phoenix_int.aserver.library.[PHXNoSuchAssociationException](../../../../com/phoenix_int/aserver/library/PHXNoSuchAssociationException.html) -- com.phoenix_int.aserver.library.[PHXNoSuchCategoryException](../../../../com/phoenix_int/aserver/library/PHXNoSuchCategoryException.html) -- com.phoenix_int.aserver.library.[PHXNoSuchIconException](../../../../com/phoenix_int/aserver/library/PHXNoSuchIconException.html) + - com.phoenix_int.aserver.library.[PHXCVSLibrarian](PHXCVSLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) + - com.phoenix_int.aserver.library.[PHXDirectoryLibrarian](PHXDirectoryLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) + - com.phoenix_int.aserver.library.[PHXLibrarianCombiner](PHXLibrarianCombiner.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) + - com.phoenix_int.aserver.library.[PHXLibrarianMounter](PHXLibrarianMounter.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) + - com.phoenix_int.aserver.library.[PHXUserDirLibrarian](PHXUserDirLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - com.phoenix_int.aserver.library.[PHXNoSuchAssociationException](PHXNoSuchAssociationException.md) + - com.phoenix_int.aserver.library.[PHXNoSuchCategoryException](PHXNoSuchCategoryException.md) + - com.phoenix_int.aserver.library.[PHXNoSuchIconException](PHXNoSuchIconException.md) ## Interface Hierarchy -- com.phoenix_int.aserver.library.[IPHXFactory](../../../../com/phoenix_int/aserver/library/IPHXFactory.html) -- com.phoenix_int.aserver.library.[IPHXLibrarian](../../../../com/phoenix_int/aserver/library/IPHXLibrarian.html) -- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian.html) -- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](../../../../com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.html) \ No newline at end of file +- com.phoenix_int.aserver.library.[IPHXFactory](IPHXFactory.md) +- com.phoenix_int.aserver.library.[IPHXLibrarian](IPHXLibrarian.md) + - com.phoenix_int.aserver.library.[IPHXVersionedLibrarian](IPHXVersionedLibrarian.md) + - com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](IPHXVersionedLibrarian2.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md index 9993929fc2..0c25f29235 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/IPHXFileCallback.md @@ -1,39 +1,44 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.monitors -## Interface IPHXFileCallback -- --- +# Interface: IPHXFileCallback + +**Package:** `com.phoenix_int.aserver.monitors` + +--- +**Declaration** ```java public interface IPHXFileCallback ``` -Callback interface to signal data available on a file being - monitored.- ========== METHOD SUMMARY =========== -- ### Method Summary + +Callback interface to signal data available on a file being monitored. + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `boolean` | `dataReady(java.lang.String data)`Called when data is ready | -| `boolean` | `fileTruncated()`Indicates that the file was truncated back to 0 bytes. |- ============ METHOD DETAIL ========== -- ### Method Detail +|-------------------|----------------------| +| `boolean` | `dataReady(java.lang.String data)`
Called when data is ready | +| `boolean` | `fileTruncated()`
Indicates that the file was truncated back to 0 bytes. | -- #### dataReady +## Method Detail + +### dataReady ```java -boolean dataReady(java.lang.String data) +boolean dataReady(java.lang.String data) ``` -Called when data is ready +Called when data is ready. + **Parameters:** -: `data`- The available data +- `data` - The available data + **Returns:** -: true to continue monitoring, false to abort monitoring +- `true` to continue monitoring, `false` to abort monitoring -- #### fileTruncated +### fileTruncated ```java -boolean fileTruncated() +boolean fileTruncated() ``` Indicates that the file was truncated back to 0 bytes. + **Returns:** -: true to continue monitoring, false to abort monitoring -========= END OF CLASS DATA ========= \ No newline at end of file +- `true` to continue monitoring, `false` to abort monitoring \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md index 16d9b055c7..091791c955 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md @@ -1,52 +1,62 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.monitors -## Class PHXFileMonitor.FileMonitorChangeException -- java.lang.Object -- - java.lang.Throwable -- - java.lang.Exception -- - java.io.IOException -- - com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeException -- **All Implemented Interfaces:** -: java.io.Serializable +# Class: PHXFileMonitor.FileMonitorChangeException + +**Package:** `com.phoenix_int.aserver.monitors` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ java.io.IOException + ↳ com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeException +``` + +**All Implemented Interfaces** + +- `java.io.Serializable` **Enclosing class:** -: [PHXFileMonitor](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.html) + +- [PHXFileMonitor](PHXFileMonitor.md) --- +**Declaration** + ```java public class PHXFileMonitor.FileMonitorChangeException extends java.io.IOException ``` **See Also:** -: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeException)- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +- [Serialized Form](../../../../serialized-form.md) + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `FileMonitorChangeException()` | -| `FileMonitorChangeException(java.lang.String msg)` | -========== METHOD SUMMARY =========== -- ### Method Summary +| `FileMonitorChangeException(java.lang.String msg)` | -- ### Methods inherited from class java.lang.Throwable +## Method Summary + +### Methods inherited from class java.lang.Throwable `addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` + +## Constructor Detail -- #### FileMonitorChangeException +### FileMonitorChangeException ```java -public FileMonitorChangeException() +public FileMonitorChangeException() ``` -- #### FileMonitorChangeException +### FileMonitorChangeException ```java -public FileMonitorChangeException(java.lang.String msg) -``` -========= END OF CLASS DATA ========= \ No newline at end of file +public FileMonitorChangeException(java.lang.String msg) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md index 0f0cdb2988..b194684abc 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXFileMonitor.md @@ -1,135 +1,126 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.monitors -## Class PHXFileMonitor -- java.lang.Object -- - com.phoenix_int.aserver.monitors.PHXFileMonitor -- --- +# Class: PHXFileMonitor + +**Package:** `com.phoenix_int.aserver.monitors` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.monitors.PHXFileMonitor +``` + +**Declaration** ```java public class PHXFileMonitor extends java.lang.Object ``` -This class monitors a File for data by polling. It - reads off the stream in the normal manner until EOF, then - it enters a polling loop waiting for more data to become - available. This is akin to tail -f in UNIX, except that - it starts at the beginning of the file intead of near - the end. -This class is not designed to be re-used after ending - the current monitor. -**Version:** -: 2001 Oct -**Author:** -: Nathan P Sharp + +This class monitors a File for data by polling. It reads off the stream in the normal manner until EOF, then it enters a polling loop waiting for more data to become available. This is akin to `tail -f` in UNIX, except that it starts at the beginning of the file instead of near the end. + +This class is not designed to be re-used after ending the current monitor. + **See Also:** -: [IPHXFileCallback](../../../../com/phoenix_int/aserver/monitors/IPHXFileCallback.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +- [IPHXFileCallback](IPHXFileCallback.md) + +## Nested Class Summary + +### Nested classes | Modifier and Type | Class and Description | | --- | --- | -| Modifier and Type | Class and Description | -| `class` | `PHXFileMonitor.FileMonitorChangeException` | -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +| `class` | [PHXFileMonitor.FileMonitorChangeException](PHXFileMonitor.FileMonitorChangeException.md) | + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXFileMonitor(PHXRawFilemonitor,IPHXFileCallbackcallback)` | -| `PHXFileMonitor(java.lang.String monitor,IPHXFileCallbackcallback)`Create a monitor | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXFileMonitor(PHXRawFile monitor, IPHXFileCallback callback)` | +| `PHXFileMonitor(java.lang.String monitor, IPHXFileCallback callback)`
Create a monitor | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `void` | `doMonitor()`Begin monitoring. | -| `void` | `endMonitor()`Signals this monitor to stop monitoring and return - as soon as possible. | +| `void` | `doMonitor()`
Begin monitoring. | +| `void` | `endMonitor()`
Signals this monitor to stop monitoring and return as soon as possible. | | `long` | `getPollDelay()` | -| `void` | `setPollDelay(long pd)`Poll Delay is how long to sleep in milliseconds between polling the - file for more data. | -| `void` | `signalFileChange()`Tells the thread to stop monitoring but to send an - error to the client saying that the file has been - changed. | +| `void` | `setPollDelay(long pd)`
Poll Delay is how long to sleep in milliseconds between polling the file for more data. | +| `void` | `signalFileChange()`
Tells the thread to stop monitoring but to send an error to the client saying that the file has been changed. | | `void` | `waitForMonitorDeath()` | -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` + +## Constructor Detail -- #### PHXFileMonitor +### PHXFileMonitor ```java -public PHXFileMonitor(java.lang.String monitor, - IPHXFileCallback callback) +public PHXFileMonitor(java.lang.String monitor, + IPHXFileCallback callback) ``` Create a monitor + **Parameters:** -: `monitor`- The filename of the file to monitor -: `callback`- The callback to call as data becomes - available +- `monitor` - The filename of the file to monitor +- `callback` - The callback to call as data becomes available -- #### PHXFileMonitor +### PHXFileMonitor ```java -public PHXFileMonitor(PHXRawFile monitor, - IPHXFileCallback callback) +public PHXFileMonitor(PHXRawFile monitor, + IPHXFileCallback callback) ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### setPollDelay +## Method Detail + +### setPollDelay ```java -public void setPollDelay(long pd) +public void setPollDelay(long pd) throws java.lang.IllegalArgumentException ``` -Poll Delay is how long to sleep in milliseconds between polling the - file for more data. 1 second by default and cannot be set to under - 0.5 seconds. +Poll Delay is how long to sleep in milliseconds between polling the file for more data. 1 second by default and cannot be set to under 0.5 seconds. + **Throws:** -: `java.lang.IllegalArgumentException` +- `java.lang.IllegalArgumentException` -- #### getPollDelay +### getPollDelay ```java -public long getPollDelay() +public long getPollDelay() ``` -- #### endMonitor +### endMonitor ```java -public void endMonitor() +public void endMonitor() ``` -Signals this monitor to stop monitoring and return - as soon as possible. +Signals this monitor to stop monitoring and return as soon as possible. -- #### waitForMonitorDeath +### waitForMonitorDeath ```java -public void waitForMonitorDeath() +public void waitForMonitorDeath() ``` -- #### signalFileChange +### signalFileChange ```java -public void signalFileChange() +public void signalFileChange() ``` -Tells the thread to stop monitoring but to send an - error to the client saying that the file has been - changed. -This class WAITS for the monitor to stop monitoring - on the sub-thread before it returns. +Tells the thread to stop monitoring but to send an error to the client saying that the file has been changed. -- #### doMonitor +This class WAITS for the monitor to stop monitoring on the sub-thread before it returns. + +### doMonitor ```java -public void doMonitor() - throws java.io.IOException +public void doMonitor() + throws java.io.IOException ``` -Begin monitoring. Does not return until the monitor - is halted. +Begin monitoring. Does not return until the monitor is halted. + **Throws:** -: `java.io.IOException` -========= END OF CLASS DATA ========= \ No newline at end of file +- `java.io.IOException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md index 7ad927fb1c..ed82c8e62b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md @@ -1,76 +1,81 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.monitors -## Class PHXMonitorableStream.MonitorWriter -- java.lang.Object -- - java.io.Writer -- - com.phoenix_int.aserver.monitors.PHXMonitorableStream.MonitorWriter -- **All Implemented Interfaces:** -: java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable +# Class: PHXMonitorableStream.MonitorWriter + +**Package:** `com.phoenix_int.aserver.monitors` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.io.Writer + ↳ com.phoenix_int.aserver.monitors.PHXMonitorableStream.MonitorWriter +``` + +**All Implemented Interfaces** + +- `java.io.Closeable`, `java.io.Flushable`, `java.lang.Appendable`, `java.lang.AutoCloseable` **Enclosing class:** -: [PHXMonitorableStream](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.html) + +- [PHXMonitorableStream](PHXMonitorableStream.md) --- +**Declaration** + ```java public class PHXMonitorableStream.MonitorWriter extends java.io.Writer -```- =========== FIELD SUMMARY =========== -- ### Field Summary +``` + +## Field Summary -- ### Fields inherited from class java.io.Writer +### Fields inherited from class java.io.Writer `lock` -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | | `void` | `close()` | | `void` | `flush()` | -| `void` | `write(char[] buf, - int pos, - int len)` | +| `void` | `write(char[] buf, int pos, int len)` | -- ### Methods inherited from class java.io.Writer +### Methods inherited from class java.io.Writer `append, append, append, write, write, write, write` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ METHOD DETAIL ========== -- ### Method Detail +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` -- #### flush +## Method Detail + +### flush ```java -public void flush() +public void flush() ``` **Specified by:** -: `flush`in interface`java.io.Flushable` -**Specified by:** -: `flush`in class`java.io.Writer` +- `flush` in interface `java.io.Flushable` +- `flush` in class `java.io.Writer` -- #### close +### close ```java -public void close() +public void close() ``` **Specified by:** -: `close`in interface`java.io.Closeable` -**Specified by:** -: `close`in interface`java.lang.AutoCloseable` -**Specified by:** -: `close`in class`java.io.Writer` +- `close` in interface `java.io.Closeable` +- `close` in interface `java.lang.AutoCloseable` +- `close` in class `java.io.Writer` -- #### write +### write ```java -public void write(char[] buf, - int pos, - int len) +public void write(char[] buf, + int pos, + int len) ``` **Specified by:** -: `write`in class`java.io.Writer` -========= END OF CLASS DATA ========= \ No newline at end of file +- `write` in class `java.io.Writer` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md index c0faf33c86..70ec113692 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/PHXMonitorableStream.md @@ -1,27 +1,31 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.monitors -## Class PHXMonitorableStream -- java.lang.Object -- - com.phoenix_int.aserver.monitors.PHXMonitorableStream -- --- +# Class: PHXMonitorableStream + +**Package:** `com.phoenix_int.aserver.monitors` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.monitors.PHXMonitorableStream +``` + +--- + +**Declaration** ```java public class PHXMonitorableStream extends java.lang.Object ``` -This class represents a stream of data which may be monitored - by a client which supports progress monitors. To use this class, - implement the IPHXMonitorable interface and return instances of - this class. -```java +This class represents a stream of data which may be monitored by a client which supports progress monitors. To use this class, implement the `IPHXMonitorable` interface and return instances of this class. + +```java public class monitorableComp implements IPHXAnalysis, IPHXMonitorable { private PHXMonitorableStream mon1 = new PHXMonitorableStream(); private PHXMonitorableStream mon2 = new PHXMonitorableStream(); - . - . - . + ... public execute() throws Exception { //Do Stuff @@ -53,90 +57,85 @@ This class represents a stream of data which may be monitored throw new PHXNoSuchObjectException(m); } } - -```- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +``` + +## Nested Class Summary + +### Nested classes | Modifier and Type | Class and Description | | --- | --- | -| Modifier and Type | Class and Description | -| `class` | `PHXMonitorableStream.MonitorWriter` | -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +| `class` | [PHXMonitorableStream.MonitorWriter](PHXMonitorableStream.MonitorWriter.md) | + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXMonitorableStream()`Default Constructor | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXMonitorableStream()`
Default Constructor | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `void` | `addMonitorListener(IPHXFileCallbackcb)`Adds a listener which gets events based on changes to this - monitor | -| `void` | `append(java.lang.String text)`Appends a string to this monitor | -| `void` | `clear()`Clears the contents of this monitor | -| `java.lang.String` | `getString()`Gets the current contents of the stream | -| `java.io.Writer` | `getWriter()`Gets a java.io.Writer which when written to appends onto - this monitor | -| `void` | `removeMonitorListener(IPHXFileCallbackcb)`Removes a listener from this monitor | +| `void` | `addMonitorListener(IPHXFileCallback cb)`
Adds a listener which gets events based on changes to this monitor | +| `void` | `append(java.lang.String text)`
Appends a string to this monitor | +| `void` | `clear()`
Clears the contents of this monitor | +| `java.lang.String` | `getString()`
Gets the current contents of the stream | +| `java.io.Writer` | `getWriter()`
Gets a java.io.Writer which when written to appends onto this monitor | +| `void` | `removeMonitorListener(IPHXFileCallback cb)`
Removes a listener from this monitor | -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` -- #### PHXMonitorableStream +## Constructor Detail + +### PHXMonitorableStream ```java -public PHXMonitorableStream() +public PHXMonitorableStream() ``` Default Constructor -============ METHOD DETAIL ========== -- ### Method Detail -- #### addMonitorListener +## Method Detail + +### addMonitorListener ```java -public void addMonitorListener(IPHXFileCallback cb) +public void addMonitorListener(IPHXFileCallback cb) ``` -Adds a listener which gets events based on changes to this - monitor +Adds a listener which gets events based on changes to this monitor -- #### removeMonitorListener +### removeMonitorListener ```java -public void removeMonitorListener(IPHXFileCallback cb) +public void removeMonitorListener(IPHXFileCallback cb) ``` Removes a listener from this monitor -- #### getWriter +### getWriter ```java -public java.io.Writer getWriter() +public java.io.Writer getWriter() ``` -Gets a java.io.Writer which when written to appends onto - this monitor +Gets a java.io.Writer which when written to appends onto this monitor -- #### clear +### clear ```java -public void clear() +public void clear() ``` Clears the contents of this monitor -- #### getString +### getString ```java -public java.lang.String getString() +public java.lang.String getString() ``` Gets the current contents of the stream -- #### append +### append ```java -public void append(java.lang.String text) +public void append(java.lang.String text) ``` -Appends a string to this monitor -========= END OF CLASS DATA ========= \ No newline at end of file +Appends a string to this monitor \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-frame.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-frame.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md index 8c1c08787b..db852d0213 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-summary.md @@ -1,20 +1,26 @@ -# Package com.phoenix_int.aserver.monitors -Provides interfaces and classes for adding process and output monitoring -of components. -See:Description -- | Interface | Description | -| --- | --- | -| [IPHXFileCallback](../../../../com/phoenix_int/aserver/monitors/IPHXFileCallback.html) | Callback interface to signal data available on a file being - monitored. | -- | Class | Description | +# Package com.phoenix_int.aserver.monitors + +Provides interfaces and classes for adding process and output monitoring of components. + +## Interface Summary + +| Interface | Description | | --- | --- | -| [PHXFileMonitor](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.html) | This class monitors a File for data by polling. | -| [PHXMonitorableStream](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.html) | This class represents a stream of data which may be monitored - by a client which supports progress monitors. | -- | Exception | Description | +| [IPHXFileCallback](IPHXFileCallback.md) | Callback interface to signal data available on a file being monitored. | + +## Class Summary + +| Class | Description | | --- | --- | -| Exception | Description | +| [PHXFileMonitor](PHXFileMonitor.md) | This class monitors a File for data by polling. | +| [PHXMonitorableStream](PHXMonitorableStream.md) | This class represents a stream of data which may be monitored by a client which supports progress monitors. | +| [PHXFileMonitor.FileMonitorChangeException](PHXFileMonitor.FileMonitorChangeException.md) | Exception thrown when a file monitor detects a change. | +| [PHXMonitorableStream.MonitorWriter](PHXMonitorableStream.MonitorWriter.md) | Writer for monitorable streams. | + +## Other Documentation + +- [package-tree.md](package-tree.md) ## Package com.phoenix_int.aserver.monitors Description Provides interfaces and classes for adding process and output monitoring -of components.Put @see and @since tags down here. \ No newline at end of file +of components. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md index ca3a33de36..a79c67b0a3 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/monitors/package-tree.md @@ -1,18 +1,22 @@ # Hierarchy For Package com.phoenix_int.aserver.monitors -Package Hierarchies: -- [All Packages](../../../../overview-tree.html) + +**Package Hierarchies:** + +- [All Packages](../../../../overview-tree.md) + ## Class Hierarchy - java.lang.Object -- com.phoenix_int.aserver.monitors.[PHXFileMonitor](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.html) -- com.phoenix_int.aserver.monitors.[PHXMonitorableStream](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.html) -- java.lang.Throwable (implements java.io.Serializable) -- java.lang.Exception -- java.io.IOException -- com.phoenix_int.aserver.monitors.[PHXFileMonitor.FileMonitorChangeException](../../../../com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.html) -- java.io.Writer (implements java.lang.Appendable, java.io.Closeable, java.io.Flushable) -- com.phoenix_int.aserver.monitors.[PHXMonitorableStream.MonitorWriter](../../../../com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.html) + - com.phoenix_int.aserver.monitors.[PHXFileMonitor](PHXFileMonitor.md) + - com.phoenix_int.aserver.monitors.[PHXMonitorableStream](PHXMonitorableStream.md) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - java.io.IOException + - com.phoenix_int.aserver.monitors.[PHXFileMonitor.FileMonitorChangeException](PHXFileMonitor.FileMonitorChangeException.md) + - java.io.Writer (implements java.lang.Appendable, java.io.Closeable, java.io.Flushable) + - com.phoenix_int.aserver.monitors.[PHXMonitorableStream.MonitorWriter](PHXMonitorableStream.MonitorWriter.md) ## Interface Hierarchy -- com.phoenix_int.aserver.monitors.[IPHXFileCallback](../../../../com/phoenix_int/aserver/monitors/IPHXFileCallback.html) \ No newline at end of file +- com.phoenix_int.aserver.monitors.[IPHXFileCallback](IPHXFileCallback.md) + diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md index 5a95b435c7..e567187927 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-summary.md @@ -8,41 +8,41 @@ The `com.phoenix_int.aserver` package contains the following key interfaces and ## Interface Summary | Interface | Description | |------|-------------| -| `IPHXAlwaysWriteable` | Interface for components that are always writeable. | -| `IPHXAnalysis` | Interface for analysis components. | -| `IPHXComponent` | Base interface for all server-side components. | -| `IPHXDriver` | Interface for driver components. | -| `IPHXHaltableComponent` | Interface for components that can be halted. | -| `IPHXMonitorable` | Interface for monitorable components. | -| `IPHXRunQueue` | Interface for managing run queues. | -| `IPHXSelfManager` | Interface for self-managing components. | -| `IPHXSelfManager2` | Extended self-manager interface. | -| `IPHXSelfManager3` | Further extended self-manager interface. | -| `IPHXSetupFromFile` | Interface for components that can be set up from a file. | +| [`IPHXAlwaysWriteable`](IPHXAlwaysWriteable.md) | Interface for components that are always writeable. | +| [`IPHXAnalysis`](IPHXAnalysis.md) | Interface for analysis components. | +| [`IPHXComponent`](IPHXComponent.md) | Base interface for all server-side components. | +| [`IPHXDriver`](IPHXDriver.md) | Interface for driver components. | +| [`IPHXHaltableComponent`](IPHXHaltableComponent.md) | Interface for components that can be halted. | +| [`IPHXMonitorable`](IPHXMonitorable.md) | Interface for monitorable components. | +| [`IPHXRunQueue`](IPHXRunQueue.md) | Interface for managing run queues. | +| [`IPHXSelfManager`](IPHXSelfManager.md) | Interface for self-managing components. | +| [`IPHXSelfManager2`](IPHXSelfManager2.md) | Extended self-manager interface. | +| [`IPHXSelfManager3`](IPHXSelfManager3.md) | Further extended self-manager interface. | +| [`IPHXSetupFromFile`](IPHXSetupFromFile.md) | Interface for components that can be set up from a file. | ## Class Summary | Class | Description | |------|-------------| -| `PHXComponentBranch` | This class represents a branch on a revision history tree for a version controlled component. | -| `PHXComponentDescription` | A class for holding description information about an component class. | -| `PHXComponentVersion` | This class represents a version on a revision history tree for a version controlled component. | -| `PHXGroup` | A utility class for holding sub-variables. | -| `PHXInvokeReturn` | A utility class for holding return information from an invoked function. | -| `PHXMethodDescriptor` | A utility class used by PHXSelfManager to indicate which methods it can invoke. | -| `PHXPropertyDescriptor` | A utility class used by PHXSelfManager to indicate which properties it manages. | -| `PHXRunShare` | This class handles runshare capabilities for any component which needs it. | -| `PHXSimpleSelfManager` | This is a class that implements most of the functionality of a self-managing component. | -| `PHXSimpleSelfManager2` | This is a class that implements most of the functionality of a self-managing component. | -| `PHXSimpleSelfManager3` | This is a class that implements most of the functionality of a self-managing component. | -| `PHXVariableInfo` | This is a utility class for holding parsing information about a variable. | +| [`PHXComponentBranch`](PHXComponentBranch.md) | This class represents a branch on a revision history tree for a version controlled component. | +| [`PHXComponentDescription`](PHXComponentDescription.md) | A class for holding description information about an component class. | +| [`PHXComponentVersion`](PHXComponentVersion.md) | This class represents a version on a revision history tree for a version controlled component. | +| [`PHXGroup`](PHXGroup.md) | A utility class for holding sub-variables. | +| [`PHXInvokeReturn`](PHXInvokeReturn.md) | A utility class for holding return information from an invoked function. | +| [`PHXMethodDescriptor`](PHXMethodDescriptor.md) | A utility class used by PHXSelfManager to indicate which methods it can invoke. | +| [`PHXPropertyDescriptor`](PHXPropertyDescriptor.md) | A utility class used by PHXSelfManager to indicate which properties it manages. | +| [`PHXRunShare`](PHXRunShare.md) | This class handles runshare capabilities for any component which needs it. | +| [`PHXSimpleSelfManager`](PHXSimpleSelfManager.md) | This is a class that implements most of the functionality of a self-managing component. | +| [`PHXSimpleSelfManager2`](PHXSimpleSelfManager2.md) | This is a class that implements most of the functionality of a self-managing component. | +| [`PHXSimpleSelfManager3`](PHXSimpleSelfManager3.md) | This is a class that implements most of the functionality of a self-managing component. | +| [`PHXVariableInfo`](PHXVariableInfo.md) | This is a utility class for holding parsing information about a variable. | ## Exception Summary | Exception | Description | |-----------|-------------| -| `PHXDFTException` | | -| `PHXInvalidNameException` | An exception that is thrown when trying to create a new object using an invalid name. | -| `PHXNameAlreadyInUseException` | An exception that is thrown when trying to create a new object with a name that already exists. | -| `PHXNoSuchObjectException` | An exception that is thrown when an object cannot be found. | -| `PHXNoSuchWriteableObjectException` | An exception that the PHXObjectManager throws when it can't find an object. | -| `ProcessHaltedException` | Exception indicating that the request cannot be handled because the associated process was halted. | +| [`PHXDFTException`](PHXDFTException.md) | | +| [`PHXInvalidNameException`](PHXInvalidNameException.md) | An exception that is thrown when trying to create a new object using an invalid name. | +| [`PHXNameAlreadyInUseException`](PHXNameAlreadyInUseException.md) | An exception that is thrown when trying to create a new object with a name that already exists. | +| [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) | An exception that is thrown when an object cannot be found. | +| [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md) | An exception that the PHXObjectManager throws when it can't find an object. | +| [`ProcessHaltedException`](ProcessHaltedException.md) | Exception indicating that the request cannot be handled because the associated process was halted. | diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md index 9402e43a98..1202f30a97 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/package-tree.md @@ -1,44 +1,44 @@ # Hierarchy For Package com.phoenix_int.aserver **Package Hierarchies** -- [All Packages](../../../overview-tree.html) +- [All Packages](../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - - com.phoenix_int.aserver.[PHXComponentBranch](../../../com/phoenix_int/aserver/PHXComponentBranch.html) - - com.phoenix_int.aserver.[PHXComponentDescription](../../../com/phoenix_int/aserver/PHXComponentDescription.html) - - com.phoenix_int.aserver.[PHXComponentVersion](../../../com/phoenix_int/aserver/PHXComponentVersion.html) - - com.phoenix_int.aserver.[PHXGroup](../../../com/phoenix_int/aserver/PHXGroup.html) - - com.phoenix_int.aserver.[PHXInvokeReturn](../../../com/phoenix_int/aserver/PHXInvokeReturn.html) - - com.phoenix_int.aserver.[PHXMethodDescriptor](../../../com/phoenix_int/aserver/PHXMethodDescriptor.html) - - com.phoenix_int.aserver.[PHXPropertyDescriptor](../../../com/phoenix_int/aserver/PHXPropertyDescriptor.html) - - com.phoenix_int.aserver.[PHXRunShare](../../../com/phoenix_int/aserver/PHXRunShare.html) (implements com.phoenix_int.aserver.[IPHXMonitorable](../../../com/phoenix_int/aserver/IPHXMonitorable.html), com.phoenix_int.aserver.trace.IPHXTraceGenerator) - - com.phoenix_int.aserver.[PHXRunShare.RunInfo](../../../com/phoenix_int/aserver/PHXRunShare.RunInfo.html) - - com.phoenix_int.aserver.[PHXSimpleSelfManager](../../../com/phoenix_int/aserver/PHXSimpleSelfManager.html) (implements com.phoenix_int.aserver.[IPHXComponent](../../../com/phoenix_int/aserver/IPHXComponent.html), com.phoenix_int.aserver.[IPHXSelfManager](../../../com/phoenix_int/aserver/IPHXSelfManager.html)) - - com.phoenix_int.aserver.[PHXSimpleSelfManager2](../../../com/phoenix_int/aserver/PHXSimpleSelfManager2.html) (implements com.phoenix_int.aserver.[IPHXSelfManager2](../../../com/phoenix_int/aserver/IPHXSelfManager2.html)) - - com.phoenix_int.aserver.[PHXSimpleSelfManager3](../../../com/phoenix_int/aserver/PHXSimpleSelfManager3.html) (implements com.phoenix_int.aserver.IPHXConnector, com.phoenix_int.aserver.[IPHXSelfManager3](../../../com/phoenix_int/aserver/IPHXSelfManager3.html)) - - com.phoenix_int.aserver.[PHXVariableInfo](../../../com/phoenix_int/aserver/PHXVariableInfo.html) + - com.phoenix_int.aserver.[PHXComponentBranch](PHXComponentBranch.md) + - com.phoenix_int.aserver.[PHXComponentDescription](PHXComponentDescription.md) + - com.phoenix_int.aserver.[PHXComponentVersion](PHXComponentVersion.md) + - com.phoenix_int.aserver.[PHXGroup](PHXGroup.md) + - com.phoenix_int.aserver.[PHXInvokeReturn](PHXInvokeReturn.md) + - com.phoenix_int.aserver.[PHXMethodDescriptor](PHXMethodDescriptor.md) + - com.phoenix_int.aserver.[PHXPropertyDescriptor](PHXPropertyDescriptor.md) + - com.phoenix_int.aserver.[PHXRunShare](PHXRunShare.md) (implements com.phoenix_int.aserver.[IPHXMonitorable](IPHXMonitorable.md), com.phoenix_int.aserver.trace.IPHXTraceGenerator) + - com.phoenix_int.aserver.[PHXRunShare.RunInfo](PHXRunShare.RunInfo.md) + - com.phoenix_int.aserver.[PHXSimpleSelfManager](PHXSimpleSelfManager.md) (implements com.phoenix_int.aserver.[IPHXComponent](IPHXComponent.md), com.phoenix_int.aserver.[IPHXSelfManager](IPHXSelfManager.md)) + - com.phoenix_int.aserver.[PHXSimpleSelfManager2](PHXSimpleSelfManager2.md) (implements com.phoenix_int.aserver.[IPHXSelfManager2](IPHXSelfManager2.md)) + - com.phoenix_int.aserver.[PHXSimpleSelfManager3](PHXSimpleSelfManager3.md) (implements com.phoenix_int.aserver.IPHXConnector, com.phoenix_int.aserver.[IPHXSelfManager3](IPHXSelfManager3.md)) + - com.phoenix_int.aserver.[PHXVariableInfo](PHXVariableInfo.md) - java.lang.Throwable (implements java.io.Serializable) - java.lang.Exception - java.io.IOException - - com.phoenix_int.aserver.[ProcessHaltedException](../../../com/phoenix_int/aserver/ProcessHaltedException.html) - - com.phoenix_int.aserver.[PHXDFTException](../../../com/phoenix_int/aserver/PHXDFTException.html) - - com.phoenix_int.aserver.[PHXInvalidNameException](../../../com/phoenix_int/aserver/PHXInvalidNameException.html) - - com.phoenix_int.aserver.[PHXNameAlreadyInUseException](../../../com/phoenix_int/aserver/PHXNameAlreadyInUseException.html) - - com.phoenix_int.aserver.[PHXNoSuchObjectException](../../../com/phoenix_int/aserver/PHXNoSuchObjectException.html) - - com.phoenix_int.aserver.[PHXNoSuchWriteableObjectException](../../../com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.html) + - com.phoenix_int.aserver.[ProcessHaltedException](ProcessHaltedException.md) + - com.phoenix_int.aserver.[PHXDFTException](PHXDFTException.md) + - com.phoenix_int.aserver.[PHXInvalidNameException](PHXInvalidNameException.md) + - com.phoenix_int.aserver.[PHXNameAlreadyInUseException](PHXNameAlreadyInUseException.md) + - com.phoenix_int.aserver.[PHXNoSuchObjectException](PHXNoSuchObjectException.md) + - com.phoenix_int.aserver.[PHXNoSuchWriteableObjectException](PHXNoSuchWriteableObjectException.md) ## Interface Hierarchy -- com.phoenix_int.aserver.[IPHXAlwaysWriteable](../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html) -- com.phoenix_int.aserver.[IPHXComponent](../../../com/phoenix_int/aserver/IPHXComponent.html) - - com.phoenix_int.aserver.[IPHXAnalysis](../../../com/phoenix_int/aserver/IPHXAnalysis.html) - - com.phoenix_int.aserver.[IPHXDriver](../../../com/phoenix_int/aserver/IPHXDriver.html) -- com.phoenix_int.aserver.[IPHXHaltableComponent](../../../com/phoenix_int/aserver/IPHXHaltableComponent.html) -- com.phoenix_int.aserver.[IPHXMonitorable](../../../com/phoenix_int/aserver/IPHXMonitorable.html) -- com.phoenix_int.aserver.[IPHXRunQueue](../../../com/phoenix_int/aserver/IPHXRunQueue.html) -- com.phoenix_int.aserver.[IPHXSelfManager](../../../com/phoenix_int/aserver/IPHXSelfManager.html) - - com.phoenix_int.aserver.[IPHXSelfManager2](../../../com/phoenix_int/aserver/IPHXSelfManager2.html) - - com.phoenix_int.aserver.[IPHXSelfManager3](../../../com/phoenix_int/aserver/IPHXSelfManager3.html) -- com.phoenix_int.aserver.[IPHXSetupFromFile](../../../com/phoenix_int/aserver/IPHXSetupFromFile.html) \ No newline at end of file +- com.phoenix_int.aserver.[IPHXAlwaysWriteable](IPHXAlwaysWriteable.md) +- com.phoenix_int.aserver.[IPHXComponent](IPHXComponent.md) + - com.phoenix_int.aserver.[IPHXAnalysis](IPHXAnalysis.md) + - com.phoenix_int.aserver.[IPHXDriver](IPHXDriver.md) +- com.phoenix_int.aserver.[IPHXHaltableComponent](IPHXHaltableComponent.md) +- com.phoenix_int.aserver.[IPHXMonitorable](IPHXMonitorable.md) +- com.phoenix_int.aserver.[IPHXRunQueue](IPHXRunQueue.md) +- com.phoenix_int.aserver.[IPHXSelfManager](IPHXSelfManager.md) + - com.phoenix_int.aserver.[IPHXSelfManager2](IPHXSelfManager2.md) + - com.phoenix_int.aserver.[IPHXSelfManager3](IPHXSelfManager3.md) +- com.phoenix_int.aserver.[IPHXSetupFromFile](IPHXSetupFromFile.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md index 7496f8d3e6..5a5952c42c 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXDescription.md @@ -1,56 +1,58 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Interface IPHXDescription -- **All Known Subinterfaces:** -: [IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) +# Interface: IPHXDescription + +**Package:** `com.phoenix_int.aserver.types` + +**All Known Subinterfaces:** +- [IPHXRefPropInfo](IPHXRefPropInfo.md) **All Known Implementing Classes:** -: [PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html),[PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html) +- [PHXRefArrayProperty](PHXRefArrayProperty.md), [PHXRefProperty](PHXRefProperty.md) + +--- ---- +**Declaration** ```java public interface IPHXDescription ``` + Interface for types with descriptions + Example usage: ```java - IPHXType var = wrapper.getVariable("myVar"); if (var instanceof IPHXDescription) { ((IPHXDescription)var).setDescription("my variable"); } - ``` -**Author:** -: bdurham- ========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `java.lang.String` | `getDescription()`Get the variable description | -| `void` | `setDescription(java.lang.String desc)`Set the variable description. |- ============ METHOD DETAIL ========== -- ### Method Detail +| `java.lang.String` | `getDescription()`
Get the variable description | +| `void` | `setDescription(java.lang.String desc)`
Set the variable description. | + +## Method Detail -- #### getDescription +### getDescription ```java -java.lang.String getDescription() +java.lang.String getDescription() ``` Get the variable description + **Returns:** -: description +- description -- #### setDescription +### setDescription ```java -void setDescription(java.lang.String desc) +void setDescription(java.lang.String desc) ``` -Set the variable description. - This should be a short, one-line description. +Set the variable description. This should be a short, one-line description. + **Parameters:** -: `desc`- the description -========= END OF CLASS DATA ========= \ No newline at end of file +- `desc` - the description \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md index 7047e6e55a..3d9e3c89d7 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXFormat.md @@ -1,62 +1,70 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Interface IPHXFormat -- **All Known Implementing Classes:** -: [PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html) +# Interface: IPHXFormat + +**Package:** `com.phoenix_int.aserver.types` + +**All Known Implementing Classes:** +- [PHXDouble](../types/PHXDouble.md) +- [PHXDoubleArray](../types/PHXDoubleArray.md) +- [PHXInteger](../types/PHXInteger.md) +- [PHXLong](../types/PHXLong.md) +- [PHXLongArray](../types/PHXLongArray.md) --- +**Declaration** + ```java public interface IPHXFormat ``` -Interface for variables that support formats + +Interface for variables that support formats. + Example usage: ```java - - IPHXType var = wrapper.getVariable("myVar"); - if (var instanceof IPHXFormat) - { +IPHXType var = wrapper.getVariable("myVar"); +if (var instanceof IPHXFormat) +{ ((IPHXFormat)var).setFormat("0.0"); - } - +} ``` -**Author:** -: bdurham- ========== METHOD SUMMARY =========== -- ### Method Summary -| Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `java.lang.String` | `getFormat()`Get the format string for the variable | -| `boolean` | `hasFormat()`Whether or not the variable has a format | -| `void` | `setFormat(java.lang.String format)`Set the format string for the variable |- ============ METHOD DETAIL ========== -- ### Method Detail +## Method Summary -- #### getFormat +| Modifier and Type | Method and Description | +|---------------------|------------------------------------------------| +| `java.lang.String` | `getFormat()`
Get the format string for the variable | +| `boolean` | `hasFormat()`
Whether or not the variable has a format | +| `void` | `setFormat(java.lang.String format)`
Set the format string for the variable | + +## Method Detail + +### getFormat ```java -java.lang.String getFormat() +java.lang.String getFormat() ``` Get the format string for the variable + **Returns:** -: format string +- format string -- #### hasFormat +### hasFormat ```java -boolean hasFormat() +boolean hasFormat() ``` Whether or not the variable has a format + **Returns:** -: true if variable has a format +- true if variable has a format -- #### setFormat +### setFormat ```java -void setFormat(java.lang.String format) +void setFormat(java.lang.String format) ``` Set the format string for the variable + **Parameters:** -: `format`- format string -========= END OF CLASS DATA ========= \ No newline at end of file +- `format` - format string \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md index e47bb296f3..e050bcbeb5 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXRefPropInfo.md @@ -1,18 +1,23 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Interface IPHXRefPropInfo -- **All Superinterfaces:** -: [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html) +# Interface: IPHXRefPropInfo + +**Package:** `com.phoenix_int.aserver.types` + +**All Superinterfaces:** +- [IPHXDescription](IPHXDescription.md) **All Known Implementing Classes:** -: [PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html),[PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html) +- [PHXRefArrayProperty](PHXRefArrayProperty.md) +- [PHXRefProperty](PHXRefProperty.md) + +--- ---- +**Declaration** ```java public interface IPHXRefPropInfo extends IPHXDescription ``` + This interface provides information about a reference property: - **name**: String - **type**: String @@ -20,111 +25,115 @@ This interface provides information about a reference property: - **description**: String - **title**: String - **input**: boolean + where type may be any of the following: - "long" - "double" - "boolean" - "string" -**Author:** -: Woyak- ========== METHOD SUMMARY =========== -- ### Method Summary - -| Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `enumValuesFromString(java.lang.String enumValues)` | -| `java.lang.String[]` | `getEnumValues()`lists enum values | -| `boolean` | `getInput()`retrieves an indicator of whether the ref prop is an input - or an output. | -| `java.lang.String` | `getName()`retrieves the name of the variable | -| `java.lang.String` | `getTitle()`retrieves a title of the ref prop. | -| `java.lang.String` | `getType()`retrieves the current type of the variable | -| `void` | `setEnumValues(java.lang.String[] enumValues)`sets the enum values | -| `void` | `setInput(boolean value)`sets an indicator for the ref prop | -| `void` | `setTitle(java.lang.String value)`sets a title of the ref prop | - -- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXDescription -`getDescription,setDescription`- ============ METHOD DETAIL ========== -- ### Method Detail - -- #### getName + +## Method Summary + +| Modifier and Type | Method and Description | +|-----------------------|-------------------------------| +| `void` | `enumValuesFromString(java.lang.String enumValues)`| +| `java.lang.String[]` | `getEnumValues()`
lists enum values | +| `boolean` | `getInput()`
retrieves an indicator of whether the ref prop is an input or an output. | +| `java.lang.String` | `getName()`
retrieves the name of the variable| +| `java.lang.String` | `getTitle()`
retrieves a title of the ref prop.| +| `java.lang.String` | `getType()`
retrieves the current type of the variable| +| `void` | `setEnumValues(java.lang.String[] enumValues)`
sets the enum values| +| `void` | `setInput(boolean value)`
sets an indicator for the ref prop| +| `void` | `setTitle(java.lang.String value)`
sets a title of the ref prop| + +### Methods inherited from interface com.phoenix_int.aserver.types.IPHXDescription +- `getDescription` +- `setDescription` + +## Method Detail + +### getName ```java -java.lang.String getName() +java.lang.String getName() ``` retrieves the name of the variable + **Returns:** -: the name of the variable +- the name of the variable -- #### getType +### getType ```java -java.lang.String getType() +java.lang.String getType() ``` retrieves the current type of the variable + **Returns:** -: the value of the variable +- the value of the variable -- #### getTitle +### getTitle ```java -java.lang.String getTitle() +java.lang.String getTitle() ``` -retrieves a title of the ref prop. Used by ModelCenter when - displaying the variable in certain dialogs +retrieves a title of the ref prop. Used by ModelCenter when displaying the variable in certain dialogs + **Returns:** -: a title for the ref prop +- a title for the ref prop -- #### setTitle +### setTitle ```java -void setTitle(java.lang.String value) +void setTitle(java.lang.String value) ``` sets a title of the ref prop + **Parameters:** -: `value`- a title for the ref prop +- `value` - a title for the ref prop -- #### getInput +### getInput ```java -boolean getInput() +boolean getInput() ``` -retrieves an indicator of whether the ref prop is an input - or an output. If it's an output, the driver component - will calculate a value for it. +retrieves an indicator of whether the ref prop is an input or an output. If it's an output, the driver component will calculate a value for it. + **Returns:** -: an indicator if the ref prop is an input +- an indicator if the ref prop is an input -- #### setInput +### setInput ```java -void setInput(boolean value) +void setInput(boolean value) ``` sets an indicator for the ref prop + **Parameters:** -: `value`- an indicator for the ref prop +- `value` - an indicator for the ref prop -- #### getEnumValues +### getEnumValues ```java -java.lang.String[] getEnumValues() +java.lang.String[] getEnumValues() ``` lists enum values + **Returns:** -: an array of enum values +- an array of enum values -- #### setEnumValues +### setEnumValues ```java -void setEnumValues(java.lang.String[] enumValues) +void setEnumValues(java.lang.String[] enumValues) ``` sets the enum values + **Parameters:** -: `enumValues`- an array of enum values +- `enumValues` - an array of enum values -- #### enumValuesFromString +### enumValuesFromString ```java -void enumValuesFromString(java.lang.String enumValues) -``` -========= END OF CLASS DATA ========= \ No newline at end of file +void enumValuesFromString(java.lang.String enumValues) +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md index 5910b7cc4e..c268844c35 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType.md @@ -1,50 +1,69 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Interface IPHXType -- **All Known Subinterfaces:** -: [IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IRuntimeVariable](../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) +# Interface: IPHXType + +**Package:** `com.phoenix_int.aserver.types` + +**All Known Subinterfaces:** +- [IPHXType2](IPHXType2.md) +- [IRuntimeVariable](../../pacz/api/v2/IRuntimeVariable.md) **All Known Implementing Classes:** -: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) +- [PHXBoolean](PHXBoolean.md) +- [PHXBooleanArray](PHXBooleanArray.md) +- [PHXDouble](PHXDouble.md) +- [PHXDoubleArray](PHXDoubleArray.md) +- [PHXFile](PHXFile.md) +- [PHXGeometry](PHXGeometry.md) +- [PHXInteger](PHXInteger.md) +- [PHXLong](PHXLong.md) +- [PHXLongArray](PHXLongArray.md) +- [PHXObjectArray](PHXObjectArray.md) +- [PHXRawFile](PHXRawFile.md) +- [PHXRawFileArray](PHXRawFileArray.md) +- [PHXReference](PHXReference.md) +- [PHXScriptObject](PHXScriptObject.md) +- [PHXSimpleArray](PHXSimpleArray.md) +- [PHXSimpleType](PHXSimpleType.md) +- [PHXString](PHXString.md) +- [PHXStringArray](PHXStringArray.md) --- +**Declaration** + ```java public interface IPHXType ``` -The interface for all Phoenix types. Phoenix types are - usually composite classes that provide subproperties for things - like descriptions, units, etc. Implementing this interface permits - the ModelCenter Remote Execution to set and get values directly from the object - even though the value may actually be stored as a sub-property. -**Author:** -: Woyak- ========== METHOD SUMMARY =========== -- ### Method Summary - -| Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `void` | `fromString(java.lang.String value)`Set the value for the variable using a string | -| `java.lang.String` | `toString()`Gets the value for the variable |- ============ METHOD DETAIL ========== -- ### Method Detail - -- #### fromString + +The interface for all ModelCenter types. ModelCenter types are usually composite classes that provide subproperties for things like descriptions, units, etc. Implementing this interface permits ModelCenter Remote Execution to set and get values directly from the object even though the value may actually be stored as a sub-property. + +## Method Summary + +| Modifier and Type | Method and Description| +|---------------------|------------------------------| +| `void`| `fromString(java.lang.String value)`
Set the value for the variable using a string | +| `java.lang.String` | `toString()`
Gets the value for the variable | + +## Method Detail + +### fromString ```java -void fromString(java.lang.String value) +void fromString(java.lang.String value) ``` Set the value for the variable using a string + **Parameters:** -: `value`- the value of the variable +- `value` - the value of the variable -- #### toString +### toString ```java -java.lang.String toString() +java.lang.String toString() ``` Gets the value for the variable + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: the value as a String -========= END OF CLASS DATA ========= \ No newline at end of file +- the value as a String \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md index 0003b6dfe6..c9732e68c5 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.IVisitor.md @@ -1,158 +1,182 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Interface IPHXType2.IVisitor -- **Type Parameters:** -: `T`- The results type from the visitation. +# Interface: IPHXType2.IVisitor + +**Package:** `com.phoenix_int.aserver.types` + +**Type Parameters:** +- `T` - The results type from the visitation. **Enclosing interface:** -: [IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) +- [IPHXType2](IPHXType2.md) --- +**Declaration** + ```java public static interface IPHXType2.IVisitor ``` -The interface of a visitor into an IPHXType2. -A part of the visitor pattern. -**Note:**PHXFile, PHXFloatArray, PHXInteger, PHXIntegerArray, PHXObjectArray, PHXReference and PHXScriptObject are - not supported by the visitor pattern of IPXHType2.- ========== METHOD SUMMARY =========== -- ### Method Summary +The interface of a visitor into an [IPHXType2](IPHXType2.md). A part of the visitor pattern. + +**Note:** [PHXFile](PHXFile.md), PHXFloatArray, [PHXInteger](PHXInteger.md), PHXIntegerArray, [PHXObjectArray](PHXObjectArray.md), [PHXReference](PHXReference.md) and [PHXScriptObject](PHXScriptObject.md) are not supported by the visitor pattern of IPXHType2. + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `T` | `visit(PHXBooleanhost)`Visit a PHXBoolean. | -| `T` | `visit(PHXBooleanArrayhost)`Visit a PHXBooleanArray. | -| `T` | `visit(PHXDoublehost)`Visit a PHXDouble. | -| `T` | `visit(PHXDoubleArrayhost)`Visit a PHXDoubleArray. | -| `T` | `visit(PHXGeometryhost)`Visit a PHXGeometry. | -| `T` | `visit(PHXLonghost)`Visit a PHXLong. | -| `T` | `visit(PHXLongArrayhost)`Visit a PHXLongArray. | -| `T` | `visit(PHXRawFilehost)`Visit a PHXRawFile. | -| `T` | `visit(PHXRawFileArrayhost)`Visit a PHXRawFileArray. | -| `T` | `visit(PHXStringhost)`Visit a PHXString. | -| `T` | `visit(PHXStringArrayhost)`Visit a PHXStringArray. |- ============ METHOD DETAIL ========== -- ### Method Detail - -- #### visit +|-------------------|----------------------| +| `T` | `visit(PHXBoolean host)`
Visit a PHXBoolean. | +| `T` | `visit(PHXBooleanArray host)`
Visit a PHXBooleanArray. | +| `T` | `visit(PHXDouble host)`
Visit a PHXDouble. | +| `T` | `visit(PHXDoubleArray host)`
Visit a PHXDoubleArray. | +| `T` | `visit(PHXGeometry host)`
Visit a PHXGeometry. | +| `T` | `visit(PHXLong host)`
Visit a PHXLong. | +| `T` | `visit(PHXLongArray host)`
Visit a PHXLongArray. | +| `T` | `visit(PHXRawFile host)`
Visit a PHXRawFile. | +| `T` | `visit(PHXRawFileArray host)`
Visit a PHXRawFileArray. | +| `T` | `visit(PHXString host)`
Visit a PHXString. | +| `T` | `visit(PHXStringArray host)`
Visit a PHXStringArray. | + +## Method Detail + +### visit (PHXBoolean) ```java -T visit(PHXBoolean host) +T visit(PHXBoolean host) ``` Visit a PHXBoolean. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXLong) ```java -T visit(PHXLong host) +T visit(PHXLong host) ``` Visit a PHXLong. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXDouble) ```java -T visit(PHXDouble host) +T visit(PHXDouble host) ``` Visit a PHXDouble. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXString) ```java -T visit(PHXString host) +T visit(PHXString host) ``` Visit a PHXString. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXRawFile) ```java -T visit(PHXRawFile host) +T visit(PHXRawFile host) ``` Visit a PHXRawFile. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXGeometry) ```java -T visit(PHXGeometry host) +T visit(PHXGeometry host) ``` Visit a PHXGeometry. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXBooleanArray) ```java -T visit(PHXBooleanArray host) +T visit(PHXBooleanArray host) ``` Visit a PHXBooleanArray. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXLongArray) ```java -T visit(PHXLongArray host) +T visit(PHXLongArray host) ``` Visit a PHXLongArray. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXDoubleArray) ```java -T visit(PHXDoubleArray host) +T visit(PHXDoubleArray host) ``` Visit a PHXDoubleArray. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXStringArray) ```java -T visit(PHXStringArray host) +T visit(PHXStringArray host) ``` Visit a PHXStringArray. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. +- The results of the visitation. -- #### visit +### visit (PHXRawFileArray) ```java -T visit(PHXRawFileArray host) +T visit(PHXRawFileArray host) ``` Visit a PHXRawFileArray. + **Parameters:** -: `host`- The host of the visit. +- `host` - The host of the visit. + **Returns:** -: The results of the visitation. -========= END OF CLASS DATA ========= \ No newline at end of file +- The results of the visitation. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md index 299381e310..936129f944 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXType2.md @@ -1,82 +1,108 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Interface IPHXType2 -- **All Superinterfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html) +# Interface: IPHXType2 + +**Package:** `com.phoenix_int.aserver.types` + +**All Superinterfaces:** +- [IPHXType](IPHXType.md) **All Known Subinterfaces:** -: [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) +- [IRuntimeVariable](../../pacz/api/v2/IRuntimeVariable.md) **All Known Implementing Classes:** -: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) +- [PHXBoolean](PHXBoolean.md) +- [PHXBooleanArray](PHXBooleanArray.md) +- [PHXDouble](PHXDouble.md) +- [PHXDoubleArray](PHXDoubleArray.md) +- [PHXFile](PHXFile.md) +- [PHXGeometry](PHXGeometry.md) +- [PHXInteger](PHXInteger.md) +- [PHXLong](PHXLong.md) +- [PHXLongArray](PHXLongArray.md) +- [PHXObjectArray](PHXObjectArray.md) +- [PHXRawFile](PHXRawFile.md) +- [PHXRawFileArray](PHXRawFileArray.md) +- [PHXReference](PHXReference.md) +- [PHXScriptObject](PHXScriptObject.md) +- [PHXSimpleArray](PHXSimpleArray.md) +- [PHXSimpleType](PHXSimpleType.md) +- [PHXString](PHXString.md) +- [PHXStringArray](PHXStringArray.md) --- +**Declaration** + ```java public interface IPHXType2 extends IPHXType ``` -The interface for Phoenix types which use PHXStringBuffer instead of String for performance. -**Author:** -: nsharp + +The interface for Phoenix types which use [PHXStringBuffer](../util/PHXStringBuffer.md) instead of String for performance. + **See Also:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +- [IPHXType](IPHXType.md) + +## Nested Class Summary | Modifier and Type | Interface and Description | -| --- | --- | -| Modifier and Type | Interface and Description | -| `static interface` | `IPHXType2.IVisitor`The interface of a visitor into an IPHXType2. | -========== METHOD SUMMARY =========== -- ### Method Summary +|-------------------|-------------------------| +| `static interface` | IPHXType2.IVisitor The interface of a visitor into an IPHXType2. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `void` | `fromString2(PHXStringBuffersb)`Configures the type based on a PHXStringBuffer representation of the type | -| `PHXStringBuffer` | `toString2()`Gets a PHXStringBuffer representation of the type | +|-------------------|----------------------| +| ` T` | `Accept(IPHXType2.IVisitor visitor)` Accept a Visitor. | +| `void` | `fromString2(PHXStringBuffer sb)` Configures the type based on a PHXStringBuffer representation of the type | +| `PHXStringBuffer` | `toString2()` Gets a PHXStringBuffer representation of the type | -- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType -`fromString,toString`- ============ METHOD DETAIL ========== -- ### Method Detail +### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType +- `fromString` +- `toString` -- #### toString2 +## Method Detail + +### toString2 ```java -PHXStringBuffer toString2() - throws java.io.IOException +PHXStringBuffer toString2() + throws java.io.IOException ``` -Gets a PHXStringBuffer representation of the type +Gets a [PHXStringBuffer](../util/PHXStringBuffer.md) representation of the type + **Returns:** -: PHXStringBuffer representation of the type +- PHXStringBuffer representation of the type + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### fromString2 +### fromString2 ```java -void fromString2(PHXStringBuffer sb) - throws java.io.IOException, - PHXGetByUrlException +void fromString2(PHXStringBuffer sb) + throws java.io.IOException, PHXGetByUrlException ``` -Configures the type based on a PHXStringBuffer representation of the type +Configures the type based on a [PHXStringBuffer](../util/PHXStringBuffer.md) representation of the type + **Parameters:** -: `sb`- representation of the type to use +- `sb` - representation of the type to use + **Throws:** -: `java.io.IOException` -: `PHXGetByUrlException` +- `java.io.IOException` +- [`PHXGetByUrlException`](../util/PHXGetByUrlException.md) -- #### Accept +### Accept ```java - T Accept(IPHXType2.IVisitor visitor) + T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. -========= END OF CLASS DATA ========= \ No newline at end of file +- The results of the visit. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md index 6bf1b7fdae..367608c38c 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/IPHXUnits.md @@ -1,55 +1,73 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Interface IPHXUnits -- **All Known Subinterfaces:** -: [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) +# Interface: IPHXUnits + +**Package:** `com.phoenix_int.aserver.types` + +**All Known Subinterfaces:** +- [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) **All Known Implementing Classes:** -: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) +- [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html) +- [PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html) +- [PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html) +- [PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html) +- [PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html) +- [PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html) +- [PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html) +- [PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html) +- [PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html) +- [PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html) +- [PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html) +- [PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html) +- [PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html) +- [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) +- [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- [PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html) +- [PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) --- +**Declaration** ```java public interface IPHXUnits ``` -Interface for PHX variables that support units -Example usage: -```java +Interface for PHX variables that support units. - IPHXType var = wrapper.getVariable("myVar"); - if (var instanceof IPHXUnits) - { - ((IPHXUnits)var).setUnits("m"); - } - +#### Example usage: + +```java +IPHXType var = wrapper.getVariable("myVar"); +if (var instanceof IPHXUnits) +{ + ((IPHXUnits)var).setUnits("m"); +} ``` -**Author:** -: bdurham- ========== METHOD SUMMARY =========== -- ### Method Summary -| Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `java.lang.String` | `getUnits()`Get the units string for the variable | -| `void` | `setUnits(java.lang.String units)`Set the units string for the variable |- ============ METHOD DETAIL ========== -- ### Method Detail +## Method Summary -- #### getUnits +| Modifier and Type | Method and Description| +|---------------------|-----------------| +| `java.lang.String` | `getUnits()`
Get the units string for the variable | +| `void` | `setUnits(java.lang.String units)`
Set the units string for the variable | + +## Method Detail + +### getUnits ```java -java.lang.String getUnits() +java.lang.String getUnits() ``` -Get the units string for the variable +Get the units string for the variable. + **Returns:** -: units string +- units string -- #### setUnits +### setUnits ```java -void setUnits(java.lang.String units) +void setUnits(java.lang.String units) ``` -Set the units string for the variable +Set the units string for the variable. + **Parameters:** -: `units`- units for the variable -========= END OF CLASS DATA ========= \ No newline at end of file +- `units` - units for the variable \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md index 60c2cd19d6..902aa9e816 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXAppearance.md @@ -1,100 +1,119 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXAppearance -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXAppearance -- --- +# Class: PHXAppearance + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXAppearance +``` + +--- + +**Declaration** ```java public class PHXAppearance extends java.lang.Object ``` -This is a utility class for holding appearance properties. The class - is used by the PHXGeomInfo class -**Author:** -: Woyak, 10/98- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +This is a utility class for holding appearance properties. The class is used by the [PHXGeomInfo](PHXGeomInfo.md) class. + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXAppearance(boolean hasColor)` | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXAppearance(boolean hasColor)` | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | +|-------------------|----------------------| | `double` | `getBlue()` | | `double` | `getGreen()` | | `boolean` | `getHasColor()` | | `double` | `getRed()` | -| `void` | `setBlue(double v)` | -| `void` | `setColor(double r, - double g, - double b)` | -| `void` | `setGreen(double v)` | -| `void` | `setRed(double v)` | +| `void` | `setBlue(double v)` | +| `void` | `setColor(double r, double g, double b)` | +| `void` | `setGreen(double v)` | +| `void` | `setRed(double v)` | + +### Methods inherited from class java.lang.Object -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` -- #### PHXAppearance +## Constructor Detail + +### PHXAppearance ```java -public PHXAppearance(boolean hasColor) +public PHXAppearance(boolean hasColor) ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### getRed +**Parameters:** +- `hasColor` - whether the appearance has color + +## Method Detail + +### getRed ```java -public double getRed() +public double getRed() ``` -- #### getGreen +### getGreen ```java -public double getGreen() +public double getGreen() ``` -- #### getBlue +### getBlue ```java -public double getBlue() +public double getBlue() ``` -- #### getHasColor +### getHasColor ```java -public boolean getHasColor() +public boolean getHasColor() ``` -- #### setRed +### setRed ```java -public void setRed(double v) +public void setRed(double v) ``` -- #### setGreen +**Parameters:** +- `v` - the red value + +### setGreen ```java -public void setGreen(double v) +public void setGreen(double v) ``` -- #### setBlue +**Parameters:** +- `v` - the green value + +### setBlue ```java -public void setBlue(double v) +public void setBlue(double v) ``` -- #### setColor +**Parameters:** +- `v` - the blue value + +### setColor ```java -public void setColor(double r, - double g, - double b) +public void setColor(double r, double g, double b) ``` -========= END OF CLASS DATA ========= \ No newline at end of file + +**Parameters:** +- `r` - the red value +- `g` - the green value +- `b` - the blue value \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md index 2ad25ce51d..852deb5c54 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBoolean.md @@ -1,246 +1,276 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXBoolean -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXBoolean -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class: PHXBoolean + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXBoolean +``` + +**Implemented Interfaces** + +- `IPHXType`, `IPHXType2`, `IPHXUnits` --- +**Declaration** + ```java public class PHXBoolean extends PHXSimpleType ``` -The Phoenix type for booleans. This class adds the following - features to the PHXSimpleType: + +The ModelCenter type for booleans. This class adds the following features to [`PHXSimpleType`](PHXSimpleType.md): + - **value**: boolean -- **valueStr**: the source string for the value, - useful for error checking when the value is NaN -**Author:** -: Woyak -**See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary - -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 -`IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +- **valueStr**: the source string for the value, useful for error checking when the value is NaN + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +- `IPHXType2.IVisitor` + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXBoolean()`initializes value to false | -| `PHXBoolean(boolean value)`Initializes the value to the specified value. | -| `PHXBoolean(PHXBooleanother)`Clone another PHXBoolean's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXBoolean()`
initializes value to false | +| `PHXBoolean(boolean value)`
Initializes the value to the specified value. | +| `PHXBoolean(PHXBoolean other)`
Clone another PHXBoolean's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `PHXBoolean` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | -| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | -| `boolean` | `getValue()`retrieves the current value of the variable | -| `java.lang.String` | `getValueStr()`retrieves the string value of this variable as passed into the - last call to fromString(). | -| `static boolean` | `parse(java.lang.Object value)`a utility function to convert a string to a boolean value | -| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`indicates whether the object should accept bad values in the - fromString() method without throwning an exception. | -| `void` | `setValue(boolean v)`sets the value for the variable | -| `java.lang.String` | `toString()`converts the variable to a string | -| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | +|-------------------|----------------------| +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `PHXBoolean` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleType toCompare)`
Compare this [`PHXSimpleType`](PHXSimpleType.md) to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
Converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffer value)`
Converts a PHXStringBuffer representation to the internal value | +| `boolean` | `getValue()`
Retrieves the current value of the variable | +| `java.lang.String` | `getValueStr()`
Retrieves the string value of this variable as passed into the last call to `fromString()`. | +| `static boolean` | `parse(java.lang.Object value)`
A utility function to convert a string to a boolean value | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`
Indicates whether the object should accept bad values in the `fromString()` method without throwing an exception. | +| `void` | `setValue(boolean v)` Sets the value for the variable | +| `java.lang.String` | `toString()`
Converts the variable to a string | +| `PHXStringBuffer` | `toString2()`
Converts the variable to a PHXStringBuffer | + +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType + +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +## Constructor Detail -- #### PHXBoolean +### PHXBoolean ```java -public PHXBoolean() +public PHXBoolean() ``` -initializes value to false -- #### PHXBoolean +Initializes value to false. + +### PHXBoolean ```java -public PHXBoolean(boolean value) +public PHXBoolean(boolean value) ``` -Initializes the value to the specified value. + **Parameters:** -: `value`- +- `value` - the initial value -- #### PHXBoolean +### PHXBoolean ```java -public PHXBoolean(PHXBoolean other) +public PHXBoolean(PHXBoolean other) ``` -Clone another PHXBoolean's value and metadata. + **Parameters:** -: `other`- the other PHXBoolean to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other` - the other PHXBoolean to clone. + +## Method Detail -- #### getValue +### getValue ```java -public boolean getValue() +public boolean getValue() ``` -retrieves the current value of the variable + +Retrieves the current value of the variable. + **Returns:** -: the value of the variable +- the value of the variable -- #### getValueStr +### getValueStr ```java -public java.lang.String getValueStr() +public java.lang.String getValueStr() ``` -retrieves the string value of this variable as passed into the - last call to fromString(). This may not be equivalent to the current - value of the variable. + +Retrieves the string value of this variable as passed into the last call to `fromString()`. This may not be equivalent to the current value of the variable. + **Returns:** -: the string last used to set the variable +- the string last used to set the variable -- #### setValue +### setValue ```java -public void setValue(boolean v) +public void setValue(boolean v) ``` -sets the value for the variable + **Parameters:** -: `v`- the value +- `v` - the value -- #### toString2 +### toString2 ```java -public PHXStringBuffer toString2() +public PHXStringBuffer toString2() ``` -converts the variable to a PHXStringBuffer + +Converts the variable to a PHXStringBuffer. + **Returns:** -: a PHXStringBuffer representation of the variable +- a PHXStringBuffer representation of the variable -- #### toString +### toString ```java -public java.lang.String toString() +public java.lang.String toString() ``` -converts the variable to a string + +Converts the variable to a string. + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface `IPHXType` + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString2 +### fromString2 ```java -public void fromString2(PHXStringBuffer value) +public void fromString2(PHXStringBuffer value) ``` -converts a PHXStringBuffer representation to the internal value + +Converts a PHXStringBuffer representation to the internal value. + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### fromString +### fromString ```java -public void fromString(java.lang.String value) +public void fromString(java.lang.String value) ``` -converts a String representation to the internal value + +Converts a String representation to the internal value. + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### parse +### parse ```java -public static boolean parse(java.lang.Object value) +public static boolean parse(java.lang.Object value) ``` -a utility function to convert a string to a boolean value + +A utility function to convert a string to a boolean value. + **Parameters:** -: `value`- the string +- `value` - the string + **Returns:** -: a boolean value +- a boolean value -- #### setIgnoreConversionErrors +### setIgnoreConversionErrors ```java -public void setIgnoreConversionErrors(boolean ignoreConversionErrors) +public void setIgnoreConversionErrors(boolean ignoreConversionErrors) ``` -indicates whether the object should accept bad values in the - fromString() method without throwning an exception. The raw - values is stored in property valueStr regardless. + +Indicates whether the object should accept bad values in the `fromString()` method without throwing an exception. The raw values is stored in property valueStr regardless. + **Parameters:** -: `ignoreConversionErrors`- true if errors should be ignored +- `ignoreConversionErrors` - true if errors should be ignored -- #### equalsNatural +### equalsNatural ```java -public boolean equalsNatural(PHXSimpleType toCompare) - throws PHXTypeMismatchException +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. + +Compare this [`PHXSimpleType`](PHXSimpleType.md) to another [`PHXSimpleType`](PHXSimpleType.md). This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare` - the [`PHXSimpleType`](PHXSimpleType.md) to compare + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) - if the given [`PHXSimpleType`](PHXSimpleType.md) cannot be compared with this object. -- #### fromObject +### fromObject ```java -public void fromObject(java.lang.Object toRead) +public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. + **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this object's value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java -public  T Accept(IPHXType2.IVisitor visitor) +public T Accept(IPHXType2.IVisitor visitor) ``` + Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java -public PHXBoolean createCopy() +public PHXBoolean createCopy() ``` -Description copied from class:`PHXSimpleType`Create a copy of this instance, including the value and metadata. + +Description copied from class: [`PHXSimpleType`](PHXSimpleType.md). Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md index a4a593ef4b..f943db9b27 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXBooleanArray.md @@ -1,259 +1,276 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXBooleanArray -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html)> -- - com.phoenix_int.aserver.types.PHXBooleanArray -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html)> - ---- +# Class: PHXBooleanArray + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXSimpleArray + ↳ com.phoenix_int.aserver.types.PHXBooleanArray +``` + +**Implemented Interfaces** + +- [`IPHXType`](IPHXType.md), [`IPHXType2`](IPHXType2.md), [`IPHXUnits`](IPHXUnits.md), `Iterable<[PHXBoolean](PHXBoolean.md)>` + +**Declaration** ```java public class PHXBooleanArray extends PHXSimpleArray ``` -Class wraps an array of PHXBoolean variables - for the ScriptWrapper utility. -**Version:** -: May 2002 -**Author:** -: Nathan P Sharp -**See Also:** -: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary - -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 + +Class wraps an array of PHXBoolean variables for the ScriptWrapper utility. + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 `IPHXType2.IVisitor` -=========== FIELD SUMMARY =========== -- ### Field Summary -- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_data,_lockDims,_lockResize` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data`, `_lockDims`, `_lockResize` + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXBooleanArray()` | -| `PHXBooleanArray(java.lang.Object data)` | -| `PHXBooleanArray(PHXBooleanArrayother)`Clone another PHXBooleanArray's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXBooleanArray(java.lang.Object data)` | +| `PHXBooleanArray(PHXBooleanArray other)` Clone another PHXBooleanArray's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | -| `PHXBooleanArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified - class is acceptable as an array element component type. | -| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `boolean` | `getBooleanValue(int index)`Gets the value of an element as a boolean | -| `boolean` | `getBooleanValue(int[] index)`Gets the value of an element as a boolean | -| `PHXBoolean` | `getValue(int[] index)`Gets the value of an element as a PHXBoolean object | -| `void` | `setValue(int[] index, - boolean val)`Sets the value of an element as a boolean | -| `void` | `setValue(int[] index,PHXBooleanval)`Sets the value of an element as a PHXBoolean object | -| `void` | `setValue(int index, - boolean val)`Sets the value of an element as a boolean | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_getMetaData,_getMetaData,_setMetaData,_setMetaData,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` - -- ### Methods inherited from interface java.lang.Iterable -`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXBooleanArray +|-------------------|----------------------| +| ` T` | `Accept(IPHXType2.IVisitor visitor)` Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)` Allocates a single element in a default state. | +| `PHXBooleanArray` | `createCopy()` Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)` Must override this function and return true if the specified class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)` Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. | +| `void` | `fromObject(java.lang.Object toRead)` Load the value of this object from the specified object. | +| `boolean` | `getBooleanValue(int index)` Gets the value of an element as a boolean | +| `boolean` | `getBooleanValue(int[] index)` Gets the value of an element as a boolean | +| `[PHXBoolean](PHXBoolean.md)` | `getValue(int[] index)` Gets the value of an element as a PHXBoolean object | +| `void` | `setValue(int[] index, boolean val)` Sets the value of an element as a boolean | +| `void` | `setValue(int[] index, PHXBoolean val)` Sets the value of an element as a PHXBoolean object | +| `void` | `setValue(int index, boolean val)` Sets the value of an element as a boolean | + +### Methods inherited from class [PHXSimpleArray](PHXSimpleArray.md) +`_getMetaData`, `_getMetaData`, `_setMetaData`, `_setMetaData`, `checkRectangular`, `copy`, `equalsNatural`, `fromString`, `fromString`, `fromString`, `fromString`, `fromString2`, `generateFor`, `generateFor`, `getArray`, `getArrayElement`, `getArrayElement`, `getComponentType`, `getComponentType`, `getDimensions`, `getDimensions`, `getFirst`, `getLength`, `getLength`, `getLockResize`, `getnDIndex`, `getNumDimensions`, `getNumDimensions`, `getSelf`, `getValue`, `incrementIndex`, `iterator`, `lockDimensions`, `newIndex`, `parseIndex`, `resize`, `setArray`, `setArrayElement`, `setArrayElement`, `setDimensions`, `setFirst`, `setLength`, `setLength`, `setLockResize`, `setValue`, `toString`, `toString`, `toString`, `toString`, `toString2`, `toString2`, `toString2`, `validElement` + +### Methods inherited from class [PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +### Methods inherited from interface java.lang.Iterable +`forEach`, `spliterator` + +## Constructor Detail + +### PHXBooleanArray ```java -public PHXBooleanArray() +public PHXBooleanArray() ``` -- #### PHXBooleanArray +### PHXBooleanArray ```java -public PHXBooleanArray(java.lang.Object data) +public PHXBooleanArray(java.lang.Object data) ``` -- #### PHXBooleanArray +### PHXBooleanArray ```java -public PHXBooleanArray(PHXBooleanArray other) +public PHXBooleanArray(PHXBooleanArray other) ``` -Clone another PHXBooleanArray's value and metadata. + **Parameters:** -: `other`- the other PHXBooleanArray to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other` - the other PHXBooleanArray to clone. + +## Method Detail -- #### dataTypeOK +### dataTypeOK ```java -protected boolean dataTypeOK(java.lang.Class c) +protected boolean dataTypeOK(java.lang.Class c) ``` -Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified - class is acceptable as an array element component type. + +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md). Must override this function and return true if the specified class is acceptable as an array element component type. + **Specified by:** -: `dataTypeOK`in class`PHXSimpleArray` +- `dataTypeOK` in class `PHXSimpleArray` -- #### allocateElement +### allocateElement ```java -protected java.lang.Object allocateElement(java.lang.Class elementClass) - throws java.lang.IllegalAccessException, - java.lang.InstantiationException +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. - If the class type in question has a default constructor, - there is no need to override this. + +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md). Allocates a single element in a default state. If the class type in question has a default constructor, there is no need to override this. + **Overrides:** -: `allocateElement`in class`PHXSimpleArray` +- `allocateElement` in class `PHXSimpleArray` + **Throws:** -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### getValue +### getValue ```java -public PHXBoolean getValue(int[] index) +public PHXBoolean getValue(int[] index) ``` -Gets the value of an element as a PHXBoolean object + +Gets the value of an element as a PHXBoolean object. + **Specified by:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class `PHXSimpleArray` + **Parameters:** -: `index`- nD array index +- `index` - nD array index + **Returns:** -: referenced array value +- referenced array value -- #### getBooleanValue +### getBooleanValue ```java -public boolean getBooleanValue(int index) +public boolean getBooleanValue(int index) ``` -Gets the value of an element as a boolean + +Gets the value of an element as a boolean. + **Parameters:** -: `index`- 1D array index +- `index` - 1D array index + **Returns:** -: referenced array value +- referenced array value + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException` - thrown if called on non-1D array -- #### getBooleanValue +### getBooleanValue ```java -public boolean getBooleanValue(int[] index) +public boolean getBooleanValue(int[] index) ``` -Gets the value of an element as a boolean + +Gets the value of an element as a boolean. + **Parameters:** -: `index`- nD array index +- `index` - nD array index + **Returns:** -: referenced array value +- referenced array value -- #### setValue +### setValue ```java -public void setValue(int[] index, - PHXBoolean val) +public void setValue(int[] index, PHXBoolean val) ``` -Sets the value of an element as a PHXBoolean object + +Sets the value of an element as a PHXBoolean object. + **Specified by:** -: `setValue`in class`PHXSimpleArray` +- `setValue` in class `PHXSimpleArray` + **Parameters:** -: `index`- nD array index -: `val`- value to set +- `index` - nD array index +- `val` - value to set -- #### setValue +### setValue ```java -public void setValue(int index, - boolean val) +public void setValue(int index, boolean val) ``` -Sets the value of an element as a boolean + +Sets the value of an element as a boolean. + **Parameters:** -: `index`- 1D array index -: `val`- value to set +- `index` - 1D array index +- `val` - value to set + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException` - thrown if called on non-1D array -- #### setValue +### setValue ```java -public void setValue(int[] index, - boolean val) +public void setValue(int[] index, boolean val) ``` -Sets the value of an element as a boolean + +Sets the value of an element as a boolean. + **Parameters:** -: `index`- nD array index -: `val`- value to set +- `index` - nD array index +- `val` - value to set -- #### elementFromString +### elementFromString ```java -protected java.lang.Object elementFromString(java.lang.String val) +protected java.lang.Object elementFromString(java.lang.String val) ``` -Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. This is only used when the element type does not - implement IPHXType or IPHXType2. For primitives, return - the wrapper objects. + +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md). Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. This is only used when the element type does not implement [`IPHXType`](IPHXType.md) or [`IPHXType2`](IPHXType2.md). For primitives, return the wrapper objects. + **Specified by:** -: `elementFromString`in class`PHXSimpleArray` +- `elementFromString` in class `PHXSimpleArray` -- #### fromObject +### fromObject ```java -public void fromObject(java.lang.Object toRead) - throws PHXInvalidTypeException +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md. + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. + **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this object's value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- `PHXInvalidTypeException` - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java -public  T Accept(IPHXType2.IVisitor visitor) +public T Accept(IPHXType2.IVisitor visitor) ``` + Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java -public PHXBooleanArray createCopy() +public PHXBooleanArray createCopy() ``` + Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md index cb997285c6..8b6af6f2c1 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDataCollector.md @@ -1,62 +1,66 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXDataCollector -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXDataCollector -- --- +# Class: PHXDataCollector + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXDataCollector +``` + +--- +**Declaration** ```java public class PHXDataCollector extends java.lang.Object ``` -A class for Driver Components to tell ModelCenter what to do with the - DataCollector while the component is running. -**Author:** -: Woyak, 2/00- =========== FIELD SUMMARY =========== -- ### Field Summary + +A class for Driver Components to tell ModelCenter what to do with the DataCollector while the component is running. + +## Field Summary | Modifier and Type | Field and Description | -| --- | --- | -| Modifier and Type | Field and Description | +|-------------------|----------------------| | `boolean` | `collect` | -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------------| | `PHXDataCollector()` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | +|-------------------|----------------------| | `boolean` | `getCollect()` | -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ FIELD DETAIL =========== -- ### Field Detail +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` -- #### collect +## Field Detail + +### collect ```java -public boolean collect +public boolean collect ``` -========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail -- #### PHXDataCollector +## Constructor Detail + +### PHXDataCollector ```java -public PHXDataCollector() +public PHXDataCollector() ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### getCollect +## Method Detail + +### getCollect ```java -public boolean getCollect() -``` -========= END OF CLASS DATA ========= \ No newline at end of file +public boolean getCollect() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md index a8c1c5f24b..bacc5232dd 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDouble.md @@ -1,519 +1,589 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXDouble -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXDouble -- **All Implemented Interfaces:** -: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class: PHXDouble ---- +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXDouble +``` + +**Implemented Interfaces** + +- [IPHXFormat](IPHXFormat.md), [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md) + +--- + +**Declaration** ```java public class PHXDouble extends PHXSimpleType implements IPHXFormat ``` -The Phoenix type for doubles. This class adds the following - features to the PHXSimpleType: + +The Phoenix type for doubles. This class adds the following features to the [PHXSimpleType](PHXSimpleType.md): + - **value**: double -- **valueStr**: the source string for the value, - useful for error checking when the value is NaN +- **valueStr**: the source string for the value, useful for error checking when the value is NaN - **hasUpperValue**: boolean - **upperValue**: double - **hasLowerValue**: boolean - **lowerValue**: double - **enumValues**: double[] - **enumValues**: string[] -If the variable has an upper or lower bound and an attempt - is made to store an invalid value, then an exception will - be thrown. -**Author:** -: Woyak -**See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary - -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 + +If the variable has an upper or lower bound and an attempt is made to store an invalid value, then an exception will be thrown. + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface [IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXDouble()`initializes value to zero without upper or lower bounds | -| `PHXDouble(double value)`Initializes value to specified value without upper or lower bounds. | -| `PHXDouble(PHXDoubleother)`Clone another PHXDouble's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------------| +| `PHXDouble()`
Initializes value to zero without upper or lower bounds | +| `PHXDouble(double value)`
Initializes value to specified value without upper or lower bounds. | +| `PHXDouble(PHXDouble other)`
Clone another PHXDouble's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_copyMetadataFromOther(PHXDoubleother)`Clone another PHXDouble's metadata. | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `static java.lang.String` | `arrayToString(double[] sa)` | -| `PHXDouble` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | -| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | -| `void` | `fromString3(java.lang.String value, - java.util.function.ToDoubleFunction converter)`converts a String representation to the internal value using specified converter | -| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | -| `double[]` | `getEnumValues()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a - comma separated string | -| `java.lang.String` | `getFormat()`Get the format string for the variable | -| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | -| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | -| `double` | `getLowerBound()`retrieves the current lower bound value | -| `double` | `getUpperBound()`retrieves the current upper bound value | -| `double` | `getValue()`retrieves the current value of the variable | -| `java.lang.String` | `getValueStr()`retrieves the string value of this variable as passed into the - last call to fromString(). | -| `boolean` | `hasFormat()`Whether or not the variable has a format | -| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration aliases list with values. | -| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | -| `void` | `setEnumValues(double[] values)`Sets the enumeration list of valid values. | -| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration List with values. | -| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | -| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | -| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | -| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`indicates whether the object should accept bad values in the - fromString() method without throwning an exception. | -| `void` | `setLowerBound(double value)`sets the lower bound. | -| `void` | `setLowerBound(java.lang.String value)` | -| `void` | `setUpperBound(double value)`sets the upper bound. | -| `void` | `setUpperBound(java.lang.String value)` | -| `void` | `setValue(double v)`sets the value for the variable | -| `java.lang.String` | `toString()`converts the variable to a string | -| `java.lang.String` | `toString(int width)`Converts the value to a string with the best possible formatting, e.g. | -| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXDouble - -```java -public PHXDouble() -``` -initializes value to zero without upper or lower bounds - -- #### PHXDouble - -```java -public PHXDouble(double value) +|-------------------|----------------------| +| `protected void` | `_copyMetadataFromOther(PHXDouble other)`
Clone another PHXDouble's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `static java.lang.String` | `arrayToString(double[] sa)` | +| `PHXDouble` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleType toCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
Converts a String representation to the internal value. | +| `void` | `fromString2(PHXStringBuffer value)`
Converts a PHXStringBuffer representation to the internal value. | +| `void` | `fromString3(java.lang.String value, java.util.function.ToDoubleFunction converter)`
Converts a String representation to the internal value using specified converter. | +| `java.lang.String[]` | `getEnumAliases()`
An interface function for the enumeration array. | +| `java.lang.String` | `getEnumAliasesStr()`
An interface function for the enumeration array. | +| `double[]` | `getEnumValues()`
An interface function for the enumeration array. | +| `java.lang.String` | `getEnumValuesStr()`
Interface function to pass out the enumeration array as a comma separated string. | +| `java.lang.String` | `getFormat()`
Get the format string for the variable. | +| `boolean` | `getHasLowerBound()`
Retrieves the `hasLowerBound` flag. | +| `boolean` | `getHasUpperBound()`
Retrieves the `hasUpperBound` flag. | +| `double` | `getLowerBound()`
Retrieves the current lower bound value. | +| `double` | `getUpperBound()`
Retrieves the current upper bound value. | +| `double` | `getValue()`
Retrieves the current value of the variable. | +| `java.lang.String` | `getValueStr()`
Retrieves the string value of this variable as passed into the last call to `fromString()`. | +| `boolean` | `hasFormat()`
Whether or not the variable has a format. | +| `void` | `setEnumAliases(java.lang.String values)`
Takes a comma separated string of values and fills the enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`
Sets the enumeration aliases list. | +| `void` | `setEnumValues(double[] values)`
Sets the enumeration list of valid values. | +| `void` | `setEnumValues(java.lang.String values)`
Takes a comma separated string of values and fills the enumeration List with values. | +| `void` | `setFormat(java.lang.String format)`
Set the format string for the variable. | +| `void` | `setHasLowerBound(boolean value)`
Sets the `hasLowerBound` flag. | +| `void` | `setHasUpperBound(boolean value)`
Sets the `hasUpperBound` flag. | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`
Indicates whether the object should accept bad values in the `fromString()` method without throwing an exception. | +| `void` | `setLowerBound(double value)`
Sets the lower bound. | +| `void` | `setLowerBound(java.lang.String value)` | +| `void` | `setUpperBound(double value)`
Sets the upper bound. | +| `void` | `setUpperBound(java.lang.String value)` | +| `void` | `setValue(double v)`
Sets the value for the variable. | +| `java.lang.String` | `toString()`
Converts the variable to a string. | +| `java.lang.String` | `toString(int width)`
Converts the value to a string with the best possible formatting, e.g. scientific or absolute values based on the width available. | +| `PHXStringBuffer` | `toString2()`
Converts the variable to a PHXStringBuffer. | + +### Methods inherited from class [PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXDouble + +```java +public PHXDouble() +``` +Initializes value to zero without upper or lower bounds. + +### PHXDouble + +```java +public PHXDouble(double value) ``` -Initializes value to specified value without upper or lower bounds. + **Parameters:** -: `value`- +- `value` - -- #### PHXDouble +Initializes value to specified value without upper or lower bounds. + +### PHXDouble ```java -public PHXDouble(PHXDouble other) +public PHXDouble(PHXDouble other) ``` -Clone another PHXDouble's value and metadata. + **Parameters:** -: `other`- the other PHXDouble to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other` - the other PHXDouble to clone. + +Clone another PHXDouble's value and metadata. + +## Method Detail -- #### _copyMetadataFromOther +### _copyMetadataFromOther ```java -protected final void _copyMetadataFromOther(PHXDouble other) +protected final void _copyMetadataFromOther(PHXDouble other) ``` -Clone another PHXDouble's metadata. + **Parameters:** -: `other`- the other PHXDouble +- `other` - the other PHXDouble + +Clone another PHXDouble's metadata. -- #### getValue +### getValue ```java -public double getValue() +public double getValue() ``` -retrieves the current value of the variable + +Retrieves the current value of the variable. + **Returns:** -: the value of the variable +- the value of the variable -- #### getValueStr +### getValueStr ```java -public java.lang.String getValueStr() +public java.lang.String getValueStr() ``` -retrieves the string value of this variable as passed into the - last call to fromString(). This may not be equivalent to the current - value of the variable. + +Retrieves the string value of this variable as passed into the last call to `fromString()`. This may not be equivalent to the current value of the variable. + **Returns:** -: the string last used to set the variable +- the string last used to set the variable -- #### setValue +### setValue ```java -public void setValue(double v) +public void setValue(double v) ``` -sets the value for the variable + **Parameters:** -: `v`- the value +- `v` - the value -- #### setUpperBound +Sets the value for the variable. + +### setUpperBound ```java -public void setUpperBound(double value) +public void setUpperBound(double value) ``` -sets the upper bound. The hasUpperBound value is set to true + **Parameters:** -: `value`- the upper bound +- `value` - the upper bound -- #### setUpperBound +Sets the upper bound. The hasUpperBound value is set to true. + +### setUpperBound ```java -public void setUpperBound(java.lang.String value) +public void setUpperBound(java.lang.String value) ``` -- #### getUpperBound +### getUpperBound ```java -public double getUpperBound() +public double getUpperBound() ``` -retrieves the current upper bound value + +Retrieves the current upper bound value. + **Returns:** -: the upper bound +- the upper bound -- #### setLowerBound +### setLowerBound ```java -public void setLowerBound(double value) +public void setLowerBound(double value) ``` -sets the lower bound. The hasLowerBound value is set to true + **Parameters:** -: `value`- the lower bound +- `value` - the lower bound -- #### setLowerBound +Sets the lower bound. The `hasLowerBound` value is set to true. + +### setLowerBound ```java -public void setLowerBound(java.lang.String value) +public void setLowerBound(java.lang.String value) ``` -- #### getLowerBound +### getLowerBound ```java -public double getLowerBound() +public double getLowerBound() ``` -retrieves the current lower bound value + +Retrieves the current lower bound value. + **Returns:** -: the lower bound +- the lower bound -- #### setHasUpperBound +### setHasUpperBound ```java -public void setHasUpperBound(boolean value) +public void setHasUpperBound(boolean value) ``` -sets the hasUpperBound flag + **Parameters:** -: `value`- true or false +- `value` - true or false + +Sets the `hasUpperBound` flag. -- #### getHasUpperBound +### getHasUpperBound ```java -public boolean getHasUpperBound() +public boolean getHasUpperBound() ``` -retrieves the hasUpperBound flag + +Retrieves the `hasUpperBound` flag. + **Returns:** -: true or false +- true or false -- #### setHasLowerBound +### setHasLowerBound ```java -public void setHasLowerBound(boolean value) +public void setHasLowerBound(boolean value) ``` -sets the hasLowerBound flag + **Parameters:** -: `value`- true or false +- `value` - true or false + +Sets the `hasLowerBound` flag. -- #### getHasLowerBound +### getHasLowerBound ```java -public boolean getHasLowerBound() +public boolean getHasLowerBound() ``` -retrieves the hasLowerBound flag + +Retrieves the `hasLowerBound` flag. + **Returns:** -: true or false +- true or false -- #### toString2 +### toString2 ```java -public PHXStringBuffer toString2() +public PHXStringBuffer toString2() ``` -converts the variable to a PHXStringBuffer + +Converts the variable to a PHXStringBuffer. + **Specified by:** -: `toString2`in interface`IPHXType2` +- `toString2` in interface [IPHXType2](IPHXType2.md) + **Returns:** -: the PHXStringBuffer representation of the variable +- the PHXStringBuffer representation of the variable -- #### toString +### toString ```java -public java.lang.String toString() +public java.lang.String toString() ``` -converts the variable to a string + +Converts the variable to a string. + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [IPHXType](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString2 +### fromString2 ```java -public void fromString2(PHXStringBuffer value) +public void fromString2(PHXStringBuffer value) ``` -converts a PHXStringBuffer representation to the internal value + +Converts a PHXStringBuffer representation to the internal value. + **Specified by:** -: `fromString2`in interface`IPHXType2` +- `fromString2` in interface [IPHXType2](IPHXType2.md) + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### fromString3 +### fromString3 ```java -public void fromString3(java.lang.String value, - java.util.function.ToDoubleFunction converter) +public void fromString3(java.lang.String value, java.util.function.ToDoubleFunction converter) ``` -converts a String representation to the internal value using specified converter + +Converts a String representation to the internal value using specified converter. + **Parameters:** -: `value`- the value to convert -: `converter`- functional interface used to convert String value to a double +- `value` - the value to convert +- `converter` - functional interface used to convert String value to a double -- #### fromString +### fromString ```java -public void fromString(java.lang.String value) +public void fromString(java.lang.String value) ``` -converts a String representation to the internal value + +Converts a String representation to the internal value. + **Specified by:** -: `fromString`in interface`IPHXType` +- `fromString` in interface [IPHXType](IPHXType.md) + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### toString +### toString ```java -public java.lang.String toString(int width) - throws PHXNumberFormatException +public java.lang.String toString(int width) + throws PHXNumberFormatException ``` -Converts the value to a string with the best possible formatting, e.g. - scientific or absolute values based on the width available. + +Converts the value to a string with the best possible formatting, e.g. scientific or absolute values based on the width available. + **Parameters:** -: `width`- the number of characters print to +- `width` - the number of characters print to + **Returns:** -: the formatted string value +- the formatted string value + **Throws:** -: `PHXNumberFormatException` +- [PHXNumberFormatException](PHXNumberFormatException.md) -- #### setIgnoreConversionErrors +### setIgnoreConversionErrors ```java -public void setIgnoreConversionErrors(boolean ignoreConversionErrors) +public void setIgnoreConversionErrors(boolean ignoreConversionErrors) ``` -indicates whether the object should accept bad values in the - fromString() method without throwning an exception. The raw - values is stored in property valueStr regardless. + +Indicates whether the object should accept bad values in the `fromString()` method without throwing an exception. The raw value is stored in property valueStr regardless. + **Parameters:** -: `ignoreConversionErrors`- true if errors should be ignored +- `ignoreConversionErrors` - true if errors should be ignored -- #### setEnumValues +### setEnumValues ```java -public void setEnumValues(java.lang.String values) +public void setEnumValues(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration List with values. + +Takes a comma separated string of values and fills the enumeration List with values. + **Parameters:** -: `values`- A comma seperrated string of enumeration values +- `values` - A comma separated string of enumeration values -- #### setEnumValues +### setEnumValues ```java -public void setEnumValues(double[] values) +public void setEnumValues(double[] values) ``` + Sets the enumeration list of valid values. + **Parameters:** -: `values`- An array of double values +- `values` - An array of double values -- #### getEnumValues +### getEnumValues ```java -public double[] getEnumValues() +public double[] getEnumValues() ``` -An interface function for the enumeration array + +An interface function for the enumeration array. + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumValuesStr +### getEnumValuesStr ```java -public java.lang.String getEnumValuesStr() +public java.lang.String getEnumValuesStr() ``` -Interface function to pass out the enumeration array as a - comma separated string + +Interface function to pass out the enumeration array as a comma separated string. + **Returns:** -: comma separated string of the possible values of the list +- comma separated string of the possible values of the list -- #### setEnumAliases +### setEnumAliases ```java -public void setEnumAliases(java.lang.String values) +public void setEnumAliases(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration aliases list with values. + +Takes a comma separated string of values and fills the enumeration aliases list with values. + **Parameters:** -: `values`- A comma seperated string of enumeration aliases +- `values` - A comma separated string of enumeration aliases -- #### setEnumAliases +### setEnumAliases ```java -public void setEnumAliases(java.lang.String[] values) +public void setEnumAliases(java.lang.String[] values) ``` -Sets the enumeration aliases list + +Sets the enumeration aliases list. + **Parameters:** -: `values`- An array of strings +- `values` - An array of strings -- #### getEnumAliases +### getEnumAliases ```java -public java.lang.String[] getEnumAliases() +public java.lang.String[] getEnumAliases() ``` -An interface function for the enumeration array + +An interface function for the enumeration array. + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumAliasesStr +### getEnumAliasesStr ```java -public java.lang.String getEnumAliasesStr() +public java.lang.String getEnumAliasesStr() ``` -An interface function for the enumeration array + +An interface function for the enumeration array. + **Returns:** -: an comma separated string of the possible values of the list +- a comma separated string of the possible values of the list -- #### setFormat +### setFormat ```java -public void setFormat(java.lang.String format) +public void setFormat(java.lang.String format) ``` -Set the format string for the variable + +Set the format string for the variable. + **Specified by:** -: `setFormat`in interface`IPHXFormat` +- `setFormat` in interface [IPHXFormat](IPHXFormat.md) + **Parameters:** -: `format`- format string +- `format` - format string -- #### getFormat +### getFormat ```java -public java.lang.String getFormat() +public java.lang.String getFormat() ``` -Get the format string for the variable + +Get the format string for the variable. + **Specified by:** -: `getFormat`in interface`IPHXFormat` +- `getFormat` in interface [IPHXFormat](IPHXFormat.md) + **Returns:** -: format string +- format string -- #### hasFormat +### hasFormat ```java -public boolean hasFormat() +public boolean hasFormat() ``` -Whether or not the variable has a format + +Whether or not the variable has a format. + **Specified by:** -: `hasFormat`in interface`IPHXFormat` +- `hasFormat` in interface [IPHXFormat](IPHXFormat.md) + **Returns:** -: true if variable has a format +- true if variable has a format -- #### arrayToString +### arrayToString ```java -public static java.lang.String arrayToString(double[] sa) +public static java.lang.String arrayToString(double[] sa) ``` -- #### equalsNatural +### equalsNatural ```java -public boolean equalsNatural(PHXSimpleType toCompare) - throws PHXTypeMismatchException +public boolean equalsNatural(PHXSimpleType toCompare) + throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. - NOTE: two PHXDoubles are considered naturally equal if they are the same to within 5 significant figures. The - equals natural algorithm uses a relative error or epsilon comparison for equality. This should NOT be confused - with a true double equality comparison and should not be used as such! It is only intended to verify that values - specified in PACJ configurations are roughly equal to instantiated component values. +Compare this [PHXSimpleType](PHXSimpleType.md) to another [PHXSimpleType](PHXSimpleType.md). This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + +NOTE: two PHXDoubles are considered naturally equal if they are the same to within 5 significant figures. The equals natural algorithm uses a relative error or epsilon comparison for equality. This should NOT be confused with a true double equality comparison and should not be used as such! It is only intended to verify that values specified in PACJ configurations are roughly equal to instantiated component values. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [PHXSimpleType](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare` - + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than toCompare, a positive number if this object is greater than to compare, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- [PHXTypeMismatchException](PHXTypeMismatchException.md) - if the given [PHXSimpleType](PHXSimpleType.md) cannot be compared with this object. -- #### fromObject +### fromObject ```java -public void fromObject(java.lang.Object toRead) - throws PHXInvalidTypeException +public void fromObject(java.lang.Object toRead) + throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). + +NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an array of java.lang.(Type), that is not currently supported. You MUST use the PHX string array formatting style. + **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [PHXSimpleType](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [PHXInvalidTypeException](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java -public  T Accept(IPHXType2.IVisitor visitor) +public T Accept(IPHXType2.IVisitor visitor) ``` + Accept a Visitor. + **Specified by:** -: `Accept`in interface`IPHXType2` +- `Accept` in interface [IPHXType2](IPHXType2.md) + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java -public PHXDouble createCopy() +public PHXDouble createCopy() ``` + Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [PHXSimpleType](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md index a4798d35bc..0da9296244 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXDoubleArray.md @@ -1,537 +1,601 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXDoubleArray -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html)> -- - com.phoenix_int.aserver.types.PHXDoubleArray -- **All Implemented Interfaces:** -: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html)> +# Class: PHXDoubleArray ---- +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ [PHXSimpleType](PHXSimpleType.md) + ↳ [PHXSimpleArray](PHXSimpleArray.md)<[PHXDouble](PHXDouble.md)> + ↳ PHXDoubleArray +``` + +**Implemented Interfaces** + +- [IPHXFormat](IPHXFormat.md), [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md), java.lang.Iterable<[PHXDouble](PHXDouble.md)> + +--- + +**Declaration** ```java public class PHXDoubleArray extends PHXSimpleArray implements IPHXFormat ``` -Class wraps an array of PHXDouble variables - for the ScriptWrapper utility. -**Version:** -: May 2002 -**Author:** -: Nathan P Sharp -**See Also:** -: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary - -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 + +Class wraps an array of [PHXDouble](PHXDouble.md) variables for the ScriptWrapper utility. + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface [IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -=========== FIELD SUMMARY =========== -- ### Field Summary -- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_data,_lockDims,_lockResize` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +## Field Summary + +### Fields inherited from class [PHXSimpleArray](PHXSimpleArray.md) +`_data`, `_lockDims`, `_lockResize` + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------------| | `PHXDoubleArray()` | -| `PHXDoubleArray(java.lang.Object data)` | -| `PHXDoubleArray(PHXDoubleArrayother)`Clone another PHXDoubleArray's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXDoubleArray(java.lang.Object data)` | +| `PHXDoubleArray(PHXDoubleArray other)`
Clone another PHXDoubleArray's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. | -| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data - in this object. | -| `void` | `_sort(PHXDoubleArrayarray, - boolean ascend)` | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | -| `PHXDoubleArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified - class is acceptable as an array element component type. | -| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +|-------------------|----------------------| +| `protected void` | `_getMetaData([PHXSimpleType](PHXSimpleType.md) v2)`
Worker which takes the meta data from an instance of [PHXSimpleType](PHXSimpleType.md) and sets it into our meta data. | +| `protected void` | `_setMetaData([PHXSimpleType](PHXSimpleType.md) v2)`
Sets a simple type's meta data based on the meta data in this object. | +| `void` | `_sort(PHXDoubleArray array`, `boolean ascend)` | +| ` T` | `Accept([IPHXType2](IPHXType2.md).IVisitor visitor)`
Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`
Allocates a single element in a default state. | +| `PHXDoubleArray` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`
Must override this function and return true if the specified class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`
Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | | `double` | `getAvg()` | -| `double` | `getDoubleValue(int index)`Gets an element as a double | -| `double` | `getDoubleValue(int[] index)`Gets an element as a double | -| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | -| `double[]` | `getEnumValues()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a - comma separated string | -| `java.lang.String` | `getFormat()`Get the format string for the variable | -| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | -| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | -| `double` | `getLowerBound()`retrieves the current lower bound value | +| `double` | `getDoubleValue(int index)`
Gets an element as a double. | +| `double` | `getDoubleValue(int[] index)`
Gets an element as a double. | +| `java.lang.String[]` | `getEnumAliases()`
An interface function for the enumeration array. | +| `java.lang.String` | `getEnumAliasesStr()`
An interface function for the enumeration array. | +| `double[]` | `getEnumValues()`
An interface function for the enumeration array. | +| `java.lang.String` | `getEnumValuesStr()`
Interface function to pass out the enumeration array as a comma separated string. | +| `java.lang.String` | `getFormat()`
Get the format string for the variable. | +| `boolean` | `getHasLowerBound()`
Retrieves the `hasLowerBound` flag. | +| `boolean` | `getHasUpperBound()`
Retrieves the `hasUpperBound` flag. | +| `double` | `getLowerBound()`
Retrieves the current lower bound value. | | `double` | `getMax()` | | `double` | `getMin()` | -| `double` | `getUpperBound()`retrieves the current upper bound value | -| `PHXDouble` | `getValue(int[] index)`gets an element as a PHXDouble object | -| `boolean` | `hasFormat()`Whether or not the variable has a format | -| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration aliases list with values. | -| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | -| `void` | `setEnumValues(double[] values)`Sets the enumeration list of valid values. | -| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration List with values. | -| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | -| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | -| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | -| `void` | `setLowerBound(double value)`sets the lower bound. | -| `void` | `setUpperBound(double value)`sets the upper bound. | -| `void` | `setValue(int[] index, - double val)`sets an element as a double | -| `void` | `setValue(int[] index,PHXDoubleval)`sets an element as a PHXDouble object | -| `void` | `setValue(int index, - double val)`sets an element as a double | +| `double` | `getUpperBound()`
Retrieves the current upper bound value. | +| `PHXDouble` | `getValue(int[] index)`
Gets an element as a [PHXDouble](PHXDouble.md) object. | +| `boolean` | `hasFormat()`
Whether or not the variable has a format. | +| `void` | `setEnumAliases(java.lang.String values)`
Takes a comma separated string of values and fills the enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`
Sets the enumeration aliases list. | +| `void` | `setEnumValues(double[] values)`
Sets the enumeration list of valid values. | +| `void` | `setEnumValues(java.lang.String values)`
Takes a comma separated string of values and fills the enumeration List with values. | +| `void` | `setFormat(java.lang.String format)`
Set the format string for the variable. | +| `void` | `setHasLowerBound(boolean value)`
Sets the `hasLowerBound` flag. | +| `void` | `setHasUpperBound(boolean value)`
Sets the `hasUpperBound` flag. | +| `void` | `setLowerBound(double value)`
Sets the lower bound. | +| `void` | `setUpperBound(double value)`
Sets the upper bound. | +| `void` | `setValue(int[] index`, `double val)`
Sets an element as a double. | +| `void` | `setValue(int[] index`, `PHXDouble val)`
Sets an element as a [PHXDouble](PHXDouble.md) object. | +| `void` | `setValue(int index`, `double val)`
Sets an element as a double. | | `void` | `sort()` | | `void` | `sortReverse()` | -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_getMetaData,_setMetaData,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` +### Methods inherited from class [PHXSimpleArray](PHXSimpleArray.md) +`_getMetaData`, `_setMetaData`, `checkRectangular`, `copy`, `equalsNatural`, `fromString`, `fromString`, `fromString`, `fromString`, `fromString2`, `generateFor`, `generateFor`, `getArray`, `getArrayElement`, `getArrayElement`, `getComponentType`, `getComponentType`, `getDimensions`, `getDimensions`, `getFirst`, `getLength`, `getLength`, `getLockResize`, `getnDIndex`, `getNumDimensions`, `getNumDimensions`, `getSelf`, `getValue`, `incrementIndex`, `iterator`, `lockDimensions`, `newIndex`, `parseIndex`, `resize`, `setArray`, `setArrayElement`, `setArrayElement`, `setDimensions`, `setFirst`, `setLength`, `setLength`, `setLockResize`, `setValue`, `toString`, `toString`, `toString`, `toString`, `toString2`, `toString2`, `toString2`, `validElement` -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` +### Methods inherited from class [PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- ### Methods inherited from interface java.lang.Iterable -`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from interface java.lang.Iterable +`forEach`, `spliterator` -- #### PHXDoubleArray +## Constructor Detail + +### PHXDoubleArray ```java -public PHXDoubleArray() +public PHXDoubleArray() ``` -- #### PHXDoubleArray +### PHXDoubleArray ```java -public PHXDoubleArray(java.lang.Object data) +public PHXDoubleArray(java.lang.Object data) ``` -- #### PHXDoubleArray +### PHXDoubleArray ```java -public PHXDoubleArray(PHXDoubleArray other) +public PHXDoubleArray(PHXDoubleArray other) ``` -Clone another PHXDoubleArray's value and metadata. + **Parameters:** -: `other`- the other PHXDoubleArray to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other` - the other PHXDoubleArray to clone. + +Clone another PHXDoubleArray's value and metadata. -- #### dataTypeOK +## Method Detail + +### dataTypeOK ```java -protected boolean dataTypeOK(java.lang.Class c) +protected boolean dataTypeOK(java.lang.Class c) ``` -Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified - class is acceptable as an array element component type. + +Description copied from class: [PHXSimpleArray](PHXSimpleArray.md) + +Must override this function and return true if the specified class is acceptable as an array element component type. + **Specified by:** -: `dataTypeOK`in class`PHXSimpleArray` +- `dataTypeOK` in class [PHXSimpleArray](PHXSimpleArray.md) -- #### allocateElement +### allocateElement ```java -protected java.lang.Object allocateElement(java.lang.Class elementClass) - throws java.lang.IllegalAccessException, - java.lang.InstantiationException +protected java.lang.Object allocateElement(java.lang.Class elementClass) + throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. - If the class type in question has a default constructor, - there is no need to override this. + +Description copied from class: [PHXSimpleArray](PHXSimpleArray.md) + +Allocates a single element in a default state. If the class type in question has a default constructor, there is no need to override this. + **Overrides:** -: `allocateElement`in class`PHXSimpleArray` +- `allocateElement` in class [PHXSimpleArray](PHXSimpleArray.md) + **Throws:** -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### setUpperBound +### setUpperBound ```java -public void setUpperBound(double value) +public void setUpperBound(double value) ``` -sets the upper bound. The hasUpperBound value is set to true + **Parameters:** -: `value`- the upper bound +- `value` - the upper bound -- #### getUpperBound +Sets the upper bound. The `hasUpperBound` value is set to true. + +### getUpperBound ```java -public double getUpperBound() +public double getUpperBound() ``` -retrieves the current upper bound value + +Retrieves the current upper bound value. + **Returns:** -: the upper bound +- the upper bound + **Throws:** -: `java.lang.IllegalStateException`- Thrown if - there is no upper bound defined. +- `java.lang.IllegalStateException` - Thrown if there is no upper bound defined. -- #### setLowerBound +### setLowerBound ```java -public void setLowerBound(double value) +public void setLowerBound(double value) ``` -sets the lower bound. The hasLowerBound value is set to true + **Parameters:** -: `value`- the lower bound +- `value` - the lower bound -- #### getLowerBound +Sets the lower bound. The `hasLowerBound` value is set to true. + +### getLowerBound ```java -public double getLowerBound() +public double getLowerBound() ``` -retrieves the current lower bound value + +Retrieves the current lower bound value. + **Returns:** -: the lower bound +- the lower bound -- #### setHasUpperBound +### setHasUpperBound ```java -public void setHasUpperBound(boolean value) +public void setHasUpperBound(boolean value) ``` -sets the hasUpperBound flag + **Parameters:** -: `value`- true or false +- `value` - true or false -- #### getHasUpperBound +Sets the `hasUpperBound` flag. + +### getHasUpperBound ```java -public boolean getHasUpperBound() +public boolean getHasUpperBound() ``` -retrieves the hasUpperBound flag + +Retrieves the `hasUpperBound` flag. + **Returns:** -: true or false +- true or false -- #### setHasLowerBound +### setHasLowerBound ```java -public void setHasLowerBound(boolean value) +public void setHasLowerBound(boolean value) ``` -sets the hasLowerBound flag + **Parameters:** -: `value`- true or false +- `value` - true or false + +Sets the `hasLowerBound` flag. -- #### getHasLowerBound +### getHasLowerBound ```java -public boolean getHasLowerBound() +public boolean getHasLowerBound() ``` -retrieves the hasLowerBound flag + +Retrieves the `hasLowerBound` flag. + **Returns:** -: true or false +- true or false -- #### setEnumValues +### setEnumValues ```java -public void setEnumValues(java.lang.String values) +public void setEnumValues(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration List with values. + +Takes a comma separated string of values and fills the enumeration List with values. + **Parameters:** -: `values`- A comma seperrated string of enumeration values +- `values` - A comma separated string of enumeration values -- #### setEnumValues +### setEnumValues ```java -public void setEnumValues(double[] values) +public void setEnumValues(double[] values) ``` + Sets the enumeration list of valid values. + **Parameters:** -: `values`- An array of double values +- `values` - An array of double values -- #### getEnumValues +### getEnumValues ```java -public double[] getEnumValues() +public double[] getEnumValues() ``` -An interface function for the enumeration array + +An interface function for the enumeration array. + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumValuesStr +### getEnumValuesStr ```java -public java.lang.String getEnumValuesStr() +public java.lang.String getEnumValuesStr() ``` -Interface function to pass out the enumeration array as a - comma separated string + +Interface function to pass out the enumeration array as a comma separated string. + **Returns:** -: comma separated string of the possible values of the list +- comma separated string of the possible values of the list -- #### setEnumAliases +### setEnumAliases ```java -public void setEnumAliases(java.lang.String values) +public void setEnumAliases(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration aliases list with values. + +Takes a comma separated string of values and fills the enumeration aliases list with values. + **Parameters:** -: `values`- A comma seperated string of enumeration aliases +- `values` - A comma separated string of enumeration aliases -- #### setEnumAliases +### setEnumAliases ```java -public void setEnumAliases(java.lang.String[] values) +public void setEnumAliases(java.lang.String[] values) ``` -Sets the enumeration aliases list + +Sets the enumeration aliases list. + **Parameters:** -: `values`- An array of strings +- `values` - An array of strings -- #### getEnumAliases +### getEnumAliases ```java -public java.lang.String[] getEnumAliases() +public java.lang.String[] getEnumAliases() ``` -An interface function for the enumeration array + +An interface function for the enumeration array. + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumAliasesStr +### getEnumAliasesStr ```java -public java.lang.String getEnumAliasesStr() +public java.lang.String getEnumAliasesStr() ``` -An interface function for the enumeration array + +An interface function for the enumeration array. + **Returns:** -: an comma separated string of the possible values of the list +- a comma separated string of the possible values of the list -- #### setFormat +### setFormat ```java -public void setFormat(java.lang.String format) +public void setFormat(java.lang.String format) ``` -Set the format string for the variable + +Set the format string for the variable. + **Specified by:** -: `setFormat`in interface`IPHXFormat` +- `setFormat` in interface [IPHXFormat](IPHXFormat.md) + **Parameters:** -: `format`- format string +- `format` - format string -- #### getFormat +### getFormat ```java -public java.lang.String getFormat() +public java.lang.String getFormat() ``` -Get the format string for the variable + +Get the format string for the variable. + **Specified by:** -: `getFormat`in interface`IPHXFormat` +- `getFormat` in interface [IPHXFormat](IPHXFormat.md) + **Returns:** -: format string +- format string -- #### hasFormat +### hasFormat ```java -public boolean hasFormat() +public boolean hasFormat() ``` -Whether or not the variable has a format + +Whether or not the variable has a format. + **Specified by:** -: `hasFormat`in interface`IPHXFormat` +- `hasFormat` in interface [IPHXFormat](IPHXFormat.md) + **Returns:** -: true if variable has a format +- true if variable has a format -- #### _setMetaData +### _setMetaData ```java -protected void _setMetaData(PHXSimpleType v2) +protected void _setMetaData(PHXSimpleType v2) ``` -Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data - in this object. Override this to set additional - information in sub-classes. Be sure to call - super._setMetaData(PHXSimpleType) + +Description copied from class: [PHXSimpleArray](PHXSimpleArray.md) + +Sets a simple type's meta data based on the meta data in this object. Override this to set additional information in sub-classes. Be sure to call `super._setMetaData(PHXSimpleType)`. + **Overrides:** -: `_setMetaData`in class`PHXSimpleArray` +- `_setMetaData` in class [PHXSimpleArray](PHXSimpleArray.md) -- #### _getMetaData +### _getMetaData ```java -protected void _getMetaData(PHXSimpleType v2) +protected void _getMetaData([PHXSimpleType](PHXSimpleType.md) v2) ``` -Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. Override this in order to add - more custom meta data in sub-classes. Be sure to cal - super._getMetaData(PHXSimpleType), though! + +Description copied from class: [PHXSimpleArray](PHXSimpleArray.md) + +Worker which takes the meta data from an instance of [PHXSimpleType](PHXSimpleType.md) and sets it into our meta data. Override this in order to add more custom meta data in sub-classes. Be sure to call `super._getMetaData(PHXSimpleType)`, though! + **Overrides:** -: `_getMetaData`in class`PHXSimpleArray` +- `_getMetaData` in class [PHXSimpleArray](PHXSimpleArray.md) -- #### getValue +### getValue ```java -public PHXDouble getValue(int[] index) +public PHXDouble getValue(int[] index) ``` -gets an element as a PHXDouble object + +Gets an element as a [PHXDouble](PHXDouble.md) object. + **Specified by:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class [PHXSimpleArray](PHXSimpleArray.md) + **Parameters:** -: `index`- nD array index +- `index` - nD array index + **Returns:** -: referenced array value +- referenced array value -- #### getDoubleValue +### getDoubleValue ```java -public double getDoubleValue(int index) +public double getDoubleValue(int index) ``` -Gets an element as a double + +Gets an element as a double. + **Parameters:** -: `index`- 1D array index +- `index` - 1D array index + **Returns:** -: referenced array value +- referenced array value + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException` - thrown if called on non-1D array -- #### getDoubleValue +### getDoubleValue ```java -public double getDoubleValue(int[] index) +public double getDoubleValue(int[] index) ``` -Gets an element as a double + +Gets an element as a double. + **Parameters:** -: `index`- nD array index +- `index` - nD array index + **Returns:** -: referenced array value +- referenced array value -- #### setValue +### setValue ```java -public void setValue(int[] index, - PHXDouble val) +public void setValue(int[] index, + PHXDouble val) ``` -sets an element as a PHXDouble object + +Sets an element as a [PHXDouble](PHXDouble.md) object. + **Specified by:** -: `setValue`in class`PHXSimpleArray` +- `setValue` in class [PHXSimpleArray](PHXSimpleArray.md) + **Parameters:** -: `index`- nD array index -: `val`- value to set +- `index` - nD array index +- `val` - value to set -- #### setValue +### setValue ```java -public void setValue(int index, - double val) +public void setValue(int index, + double val) ``` -sets an element as a double + +Sets an element as a double. + **Parameters:** -: `index`- 1D array index -: `val`- value to set +- `index` - 1D array index +- `val` - value to set -- #### setValue +### setValue ```java -public void setValue(int[] index, - double val) +public void setValue(int[] index, + double val) ``` -sets an element as a double + +Sets an element as a double. + **Parameters:** -: `index`- nD array index -: `val`- value to set +- `index` - nD array index +- `val` - value to set -- #### elementFromString +### elementFromString ```java -protected java.lang.Object elementFromString(java.lang.String val) +protected java.lang.Object elementFromString(java.lang.String val) ``` -Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. This is only used when the element type does not - implement IPHXType or IPHXType2. For primitives, return - the wrapper objects. + +Description copied from class: [PHXSimpleArray](PHXSimpleArray.md) + +Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. This is only used when the element type does not implement [IPHXType](IPHXType.md) or [IPHXType2](IPHXType2.md). For primitives, return the wrapper objects. + **Specified by:** -: `elementFromString`in class`PHXSimpleArray` +- `elementFromString` in class [PHXSimpleArray](PHXSimpleArray.md) -- #### getMax +### getMax ```java -public double getMax() +public double getMax() ``` -- #### getMin +### getMin ```java -public double getMin() +public double getMin() ``` -- #### getAvg +### getAvg ```java -public double getAvg() +public double getAvg() ``` -- #### sortReverse +### sortReverse ```java -public void sortReverse() +public void sortReverse() ``` -- #### sort +### sort ```java -public void sort() +public void sort() ``` -- #### _sort +### _sort ```java -public void _sort(PHXDoubleArray array, - boolean ascend) +public void _sort(PHXDoubleArray array, + boolean ascend) ``` -- #### fromObject +### fromObject ```java -public void fromObject(java.lang.Object toRead) +public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. + **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [PHXSimpleType](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [PHXInvalidTypeException](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java -public  T Accept(IPHXType2.IVisitor visitor) +public T Accept([IPHXType2](IPHXType2.md).IVisitor visitor) ``` + Accept a Visitor. + **Specified by:** -: `Accept`in interface`IPHXType2` +- `Accept` in interface [IPHXType2](IPHXType2.md) + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java -public PHXDoubleArray createCopy() +public PHXDoubleArray createCopy() ``` + Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [PHXSimpleType](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md index 0b1e8ce7fa..30bf50b4cb 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXFile.md @@ -1,289 +1,321 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXFile -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXFile -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class: PHXFile + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ [PHXSimpleType](PHXSimpleType.md) + ↳ PHXFile +``` + +**Implemented Interfaces** + +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md) --- -Deprecated. + +**Declaration** ```java @Deprecated public class PHXFile extends PHXSimpleType ``` -Internal data type used for certain types of files. End - users should use PHXRawFile to implement file variables - in their custom components. + +Deprecated. + +Internal data type used for certain types of files. End users should use [PHXRawFile](PHXRawFile.md) to implement file variables in their custom components. + - **name**: String - **contents**: String -**Author:** -: Woyak, 6/98 -**See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +## Nested Class Summary + +### Nested classes/interfaces inherited from interface [IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXFile()`Deprecated. | -| `PHXFile(PHXFileother)`Deprecated.Clone another PHXFile's value and metadata. | -| `PHXFile(java.lang.String fileName)`Deprecated. | -| `PHXFile(java.lang.String baseName, - java.lang.String name)`Deprecated. | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------------| +| `PHXFile()`
Deprecated. | +| `PHXFile(PHXFile other)`
Deprecated. Clone another PHXFile's value and metadata. | +| `PHXFile(java.lang.String fileName)`
Deprecated. | +| `PHXFile(java.lang.String baseName, java.lang.String name)`
Deprecated. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Deprecated.Accept a Visitor. | -| `PHXFile` | `createCopy()`Deprecated.Create a copy of this instance, including the value and metadata. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Deprecated.Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromObject(java.lang.Object toRead)`Deprecated.Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`Deprecated.converts a String representation to the internal value | -| `void` | `fromString2(PHXStringBuffervalue)`Deprecated.converts a PHXStringBuffer representation to the internal value | -| `java.lang.String` | `getContents()`Deprecated.retrieves the contents of the file | -| `java.lang.String` | `getName()`Deprecated.retrieves the name of the file | -| `java.lang.String` | `getNameCoded()`Deprecated.retrieves the name of the file in coded form (without $variables - replaced) | -| `boolean` | `hasChanged()`Deprecated.checks to see if the file has changed since the last time - getContents() was called | -| `void` | `markAsRead()`Deprecated.call this function after you manually get the contents of the - file. | -| `void` | `setBaseName(java.lang.String v)`Deprecated.sets the base name of the file | -| `void` | `setName(java.lang.String v)`Deprecated.sets the name of the file | -| `void` | `setStringReplacer(PHXStringReplacerr)`Deprecated.specifies a PHXStringReplacer object for use in forming the - full file name. | -| `java.lang.String` | `toString()`Deprecated.converts the variable to a string | -| `PHXStringBuffer` | `toString2()`Deprecated.converts the variable to a string | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXFile +|-------------------|----------------------| +| ` T` | `Accept([IPHXType2](IPHXType2.md).IVisitor visitor)`
Deprecated. Accept a Visitor. | +| `PHXFile` | `createCopy()`
Deprecated. Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural([PHXSimpleType](PHXSimpleType.md) toCompare)`
Deprecated. Compare this [PHXSimpleType](PHXSimpleType.md) to another [PHXSimpleType](PHXSimpleType.md). | +| `void` | `fromObject(java.lang.Object toRead)`
Deprecated. Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
Deprecated. Converts a String representation to the internal value. | +| `void` | `fromString2(PHXStringBuffer value)`
Deprecated. Converts a PHXStringBuffer representation to the internal value. | +| `java.lang.String` | `getContents()`
Deprecated. Retrieves the contents of the file. | +| `java.lang.String` | `getName()`
Deprecated. Retrieves the name of the file. | +| `java.lang.String` | `getNameCoded()`
Deprecated. Retrieves the name of the file in coded form (without $variables replaced). | +| `boolean` | `hasChanged()`
Deprecated. Checks to see if the file has changed since the last time getContents() was called. | +| `void` | `markAsRead()`
Deprecated. Call this function after you manually get the contents of the file. | +| `void` | `setBaseName(java.lang.String v)`
Deprecated. Sets the base name of the file. | +| `void` | `setName(java.lang.String v)`
Deprecated. Sets the name of the file. | +| `void` | `setStringReplacer(PHXStringReplacer r)`
Deprecated. Specifies a PHXStringReplacer object for use in forming the full file name. | +| `java.lang.String` | `toString()`
Deprecated. Converts the variable to a string. | +| `PHXStringBuffer` | `toString2()`
Deprecated. Converts the variable to a string. | + +### Methods inherited from class [PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXFile ```java -public PHXFile() +public PHXFile() ``` Deprecated. -- #### PHXFile +### PHXFile ```java -public PHXFile(java.lang.String fileName) +public PHXFile(java.lang.String fileName) ``` Deprecated. -- #### PHXFile +### PHXFile ```java -public PHXFile(java.lang.String baseName, - java.lang.String name) +public PHXFile(java.lang.String baseName, + java.lang.String name) ``` Deprecated. -- #### PHXFile +### PHXFile ```java -public PHXFile(PHXFile other) +public PHXFile(PHXFile other) ``` -Deprecated.Clone another PHXFile's value and metadata. + **Parameters:** -: `other`- the other PHXFile to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other` - the other PHXFile to clone. + +Deprecated. Clone another PHXFile's value and metadata. -- #### getName +## Method Detail + +### getName ```java -public java.lang.String getName() +public java.lang.String getName() ``` -Deprecated.retrieves the name of the file + +Deprecated. Retrieves the name of the file. + **Returns:** -: the name of the file +- the name of the file -- #### getNameCoded +### getNameCoded ```java -public java.lang.String getNameCoded() +public java.lang.String getNameCoded() ``` -Deprecated.retrieves the name of the file in coded form (without $variables - replaced) + +Deprecated. Retrieves the name of the file in coded form (without `$variables` replaced). + **Returns:** -: the name of the file in coded form +- the name of the file in coded form -- #### setName +### setName ```java -public void setName(java.lang.String v) +public void setName(java.lang.String v) ``` -Deprecated.sets the name of the file + **Parameters:** -: `v`- the name +- `v` - the name -- #### setBaseName +Deprecated. Sets the name of the file. + +### setBaseName ```java -public void setBaseName(java.lang.String v) +public void setBaseName(java.lang.String v) ``` -Deprecated.sets the base name of the file + **Parameters:** -: `v`- the name +- `v` - the name -- #### setStringReplacer +Deprecated. Sets the base name of the file. + +### setStringReplacer ```java -public void setStringReplacer(PHXStringReplacer r) +public void setStringReplacer(PHXStringReplacer r) ``` -Deprecated.specifies a PHXStringReplacer object for use in forming the - full file name. + **Parameters:** -: `r`- the string replacer object +- `r` - the string replacer object -- #### getContents +Deprecated. Specifies a `PHXStringReplacer` object for use in forming the full file name. + +### getContents ```java -public java.lang.String getContents() +public java.lang.String getContents() throws java.io.IOException ``` -Deprecated.retrieves the contents of the file + +Deprecated. Retrieves the contents of the file. + **Returns:** -: the contents of the file +- the contents of the file + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### markAsRead +### markAsRead ```java -public void markAsRead() +public void markAsRead() ``` -Deprecated.call this function after you manually get the contents of the - file. The function records it's name and timestamp for use with - the hasChanged() function -- #### hasChanged +Deprecated. Call this function after you manually get the contents of the file. The function records its name and timestamp for use with the `hasChanged()` function. + +### hasChanged ```java -public boolean hasChanged() +public boolean hasChanged() ``` -Deprecated.checks to see if the file has changed since the last time - getContents() was called + +Deprecated. Checks to see if the file has changed since the last time `getContents()` was called. + **Returns:** -: true if the timestamp of the file is new, or if the - file name has changed +- `true` if the timestamp of the file is new, or if the file name has changed -- #### toString2 +### toString2 ```java -public PHXStringBuffer toString2() +public PHXStringBuffer toString2() ``` -Deprecated.converts the variable to a string + +Deprecated. Converts the variable to a string. + **Returns:** -: a PHXStringBuffer representation of the variable +- a PHXStringBuffer representation of the variable -- #### toString +### toString ```java -public java.lang.String toString() +public java.lang.String toString() ``` -Deprecated.converts the variable to a string + +Deprecated. Converts the variable to a string. + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [IPHXType](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class java.lang.Object + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString2 +### fromString2 ```java -public void fromString2(PHXStringBuffer value) +public void fromString2(PHXStringBuffer value) ``` -Deprecated.converts a PHXStringBuffer representation to the internal value + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### fromString +Deprecated. Converts a PHXStringBuffer representation to the internal value. + +### fromString ```java -public void fromString(java.lang.String value) +public void fromString(java.lang.String value) ``` -Deprecated.converts a String representation to the internal value + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### equalsNatural +Deprecated. Converts a String representation to the internal value. + +### equalsNatural ```java -public boolean equalsNatural(PHXSimpleType toCompare) +public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Deprecated.Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. + +Deprecated. Compare this [PHXSimpleType](PHXSimpleType.md) to another [PHXSimpleType](PHXSimpleType.md). This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [PHXSimpleType](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare` - + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than toCompare, a positive number if this object is greater than to compare, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- [PHXTypeMismatchException](PHXTypeMismatchException.md) - if the given [PHXSimpleType](PHXSimpleType.md) cannot be compared with this object. -- #### fromObject +### fromObject ```java -public void fromObject(java.lang.Object toRead) +public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Deprecated.Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. +Deprecated. Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. + **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [PHXSimpleType](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [PHXInvalidTypeException](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java -public  T Accept(IPHXType2.IVisitor visitor) +public T Accept(IPHXType2.IVisitor visitor) ``` -Deprecated.Accept a Visitor. + +Deprecated. Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java -public PHXFile createCopy() +public PHXFile createCopy() ``` -Deprecated.Description copied from class:`PHXSimpleType`Create a copy of this instance, including the value and metadata. + +Deprecated. Description copied from class: [PHXSimpleType](PHXSimpleType.md). Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [PHXSimpleType](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md index 08bfb224bb..dc81a19dcf 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeomInfo.md @@ -1,83 +1,79 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXGeomInfo -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXGeomInfo -- --- +# Class: PHXGeomInfo + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXGeomInfo +``` + +--- +**Declaration** ```java public class PHXGeomInfo extends java.lang.Object ``` -this is a utility class that mirrors the structures in ModelCenter. If you - want to calculate values for certain geometry information such as CGs, - instantiate this class and set the values for the desired parameters. - ModelCenter will then use these parameters instead of letting the user - specify values or calculating them itself. -**Author:** -: Woyak 10/98- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +this is a utility class that mirrors the structures in ModelCenter. If you want to calculate values for certain geometry information such as CGs, instantiate this class and set the values for the desired parameters. ModelCenter will then use these parameters instead of letting the user specify values or calculating them itself. + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------| | `PHXGeomInfo()` | -| `PHXGeomInfo(boolean hasRotation, - boolean hasTranslation, - boolean hasColor, - boolean hasCentroid, - boolean hasVolume, - boolean hasSurfaceArea, - boolean hasMass)` | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXGeomInfo(boolean hasRotation, boolean hasTranslation, boolean hasColor, boolean hasCentroid, boolean hasVolume, boolean hasSurfaceArea, boolean hasMass)` | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | +|-------------------|----------------------| | `PHXAppearance` | `getAppearance()` | | `PHXMassProperties` | `getMassProperties()` | | `PHXOrientation` | `getOrientation()` | -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` -- #### PHXGeomInfo +## Constructor Detail + +### PHXGeomInfo ```java -public PHXGeomInfo() +public PHXGeomInfo() ``` -- #### PHXGeomInfo +### PHXGeomInfo ```java -public PHXGeomInfo(boolean hasRotation, - boolean hasTranslation, - boolean hasColor, - boolean hasCentroid, - boolean hasVolume, - boolean hasSurfaceArea, - boolean hasMass) +public PHXGeomInfo(boolean hasRotation, + boolean hasTranslation, + boolean hasColor, + boolean hasCentroid, + boolean hasVolume, + boolean hasSurfaceArea, + boolean hasMass) ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### getOrientation +## Method Detail + +### getOrientation ```java -public PHXOrientation getOrientation() +public PHXOrientation getOrientation() ``` -- #### getAppearance +### getAppearance ```java -public PHXAppearance getAppearance() +public PHXAppearance getAppearance() ``` -- #### getMassProperties +### getMassProperties ```java -public PHXMassProperties getMassProperties() -``` -========= END OF CLASS DATA ========= \ No newline at end of file +public PHXMassProperties getMassProperties() +``` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md index 73970f098e..212fa0ed14 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXGeometry.md @@ -1,51 +1,65 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXGeometry -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXGeometry -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class: PHXGeometry ---- +**Package:[`PHXSimpleType`](../../| `| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. |T> T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. |./../com/phoenix_int/aserver/types/PHXSimpleType.html) + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +`IPHXType2.IVisitor` + +## Constructor Summary.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXGeometry +``` + +**Implemented Interfaces** + +- `IPHXType`, `IPHXType2`, `IPHXUnits` + +--- +**Declaration** ```java public class PHXGeometry extends PHXSimpleType ``` -The Phoenix type for geometry. This class has the following - properties: + +The ModelCenter type for geometry. This class has the following properties: + - **data**: String - a String representation of the data - **format**: String - the type of data - **description**: String -If the variable has an upper or lower bound and an attempt - is made to store an invalid value, then an exception will - be thrown. -**Author:** -: Woyak + +If the variable has an upper or lower bound and an attempt is made to store an invalid value, then an exception will be thrown. + **See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +[`PHXSimpleType`](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | +|---------------------| | `PHXGeometry()` | -| `PHXGeometry(PHXGeometryother)`Clone another PHXGeometry's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXGeometry(PHXGeometry other)`
Clone another PHXGeometry's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | +|-------------------|----------------------| | ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `PHXGeometry` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | +| `PHXGeometry` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleType toCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | | `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | | `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | | `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | @@ -58,192 +72,218 @@ If the variable has an upper or lower bound and an attempt | `java.lang.String` | `toString()`converts the variable to a string | | `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setHasChanged,setUnits` +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getEnumTokens`, `getHasChanged`, `getUnits`,`removePropertyChangeListener`, `setHasChanged`, `setUnits` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- #### PHXGeometry + +## Constructor Detail + +### PHXGeometry ```java public PHXGeometry() ``` -- #### PHXGeometry +### PHXGeometry ```java public PHXGeometry(PHXGeometry other) ``` Clone another PHXGeometry's value and metadata. + **Parameters:** -: `other`- the other PHXGeometry to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other`- the other PHXGeometry to clone. -- #### getData + +## Method Detail + +### getData ```java public java.lang.String getData() ``` retrieves the current value for the geometry data + **Returns:** -: the geometry data +- the geometry data -- #### setData +### setData ```java public void setData(java.lang.String d) ``` sets the value for the variable + **Parameters:** -: `d`- the value +- `d`- the value -- #### getFormat +### getFormat ```java public java.lang.String getFormat() ``` retrieves the format for the geometry data + **Returns:** -: the format of the geometry data +- the format of the geometry data -- #### setFormat +### setFormat ```java public void setFormat(java.lang.String d) throws PHXInvalidTypeException ``` -sets the format for the variable. The format is a String description of the representation of the data - - specifying a new format only stores a new value for the format +sets the format for the variable. The format is a String description of the representation of the data - specifying a new format only stores a new value for the format + **Parameters:** -: `d`- the value +- `d`- the value + **Throws:** -: `PHXInvalidTypeException` +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) -- #### getDescription +### getDescription ```java public java.lang.String getDescription() ``` retrieves the description of the variable + **Overrides:** -: `getDescription`in class`PHXSimpleType` +: `getDescription` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a description geometry data +- a description geometry data -- #### setDescription +### setDescription ```java public void setDescription(java.lang.String d) ``` -sets the description for the variable. This should be a short, - one-line description. +sets the description for the variable. This should be a short, one-line description. + **Overrides:** -: `setDescription`in class`PHXSimpleType` +: `setDescription` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `d`- the description +- `d`- the description -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2() ``` converts the variable to a PHXStringBuffer + **Returns:** -: a PHXStringBuffer representation of the variable +- a PHXStringBuffer representation of the variable -- #### toString +### toString ```java public java.lang.String toString() ``` converts the variable to a string + **Specified by:** -: `toString`in interface`IPHXType` +- +: `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +: `toString` in class `java.lang.Object` + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString2 +### fromString2 ```java public void fromString2(PHXStringBuffer value) ``` converts a PHXStringBuffer representation to the internal value + **Parameters:** -: `value`- the value to convert +- `value`- the value to convert -- #### fromString +### fromString ```java public void fromString(java.lang.String value) ``` converts a String representation to the internal value + **Parameters:** -: `value`- the value to convert +- `value`- the value to convert -- #### equalsNatural +### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- +: `equalsNatural` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare`- + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md) + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- +: `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md)- if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Type Parameters:** : `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java public PHXGeometry createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- +: `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md index 1da480532a..00482e00a9 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInteger.md @@ -1,14 +1,21 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXInteger -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXInteger -- **All Implemented Interfaces:** -: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class: PHXInteger ---- -Deprecated. +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXInteger +``` + +**Implemented Interfaces** + +- [`IPHXFormat`](IPHXFormat.md), [`IPHXType`](IPHXType.md), [`IPHXType2`](IPHXType2.md), [`IPHXUnits`](IPHXUnits.md) + +--- +**Declaration** ```java @Deprecated @@ -16,472 +23,505 @@ public class PHXInteger extends PHXSimpleType implements IPHXFormat ``` + **THIS CLASS IS DEPRECATED IN FAVOR OF PHXLong** -The Phoenix type for integers. This class adds the following - features to the PHXSimpleType: + +The Phoenix type for integers. This class adds the following features to the PHXSimpleType: - **value**: int -- **valueStr**: the source string for the value, - useful for error checking when the value is NaN +- **valueStr**: the source string for the value, useful for error checking when the value is NaN - **hasUpperValue**: boolean - **upperValue**: int - **hasLowerValue**: boolean - **lowerValue**: int - **enumValues**: int[] - **enumAliases**: String[] -If the variable has an upper or lower bound and an attempt - is made to store an invalid value, then an exception will - be thrown. -**Author:** -: Woyak + +If the variable has an upper or lower bound and an attempt is made to store an invalid value, then an exception will be thrown. + **See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 -`IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +[`PHXSimpleType`](PHXSimpleType.md) + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) +[`IPHXType2.IVisitor`](IPHXType2.IVisitor.md) + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXInteger()`Deprecated. | -| `PHXInteger(PHXIntegerother)`Deprecated.Clone another PHXInteger's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------| +| `PHXInteger()`
**Deprecated.**| +| `PHXInteger(PHXInteger other)`
**Deprecated.**
Clone another PHXInteger's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_copyMetadataFromOther(PHXIntegerother)`Deprecated.Clone another PHXInteger's metadata. | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Deprecated.Accept a Visitor. | -| `static java.lang.String` | `arrayToString(int[] sa)`Deprecated. | -| `PHXInteger` | `createCopy()`Deprecated.Create a copy of this instance, including the value and metadata. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Deprecated.Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromObject(java.lang.Object toRead)`Deprecated.Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`Deprecated.converts a String representation to the internal value | -| `void` | `fromString2(PHXStringBuffervalue)`Deprecated.converts a String representation to the internal value | -| `java.lang.String[]` | `getEnumAliases()`Deprecated.An interface function for the enumeration array | -| `java.lang.String` | `getEnumAliasesStr()`Deprecated.An interface function for the enumeration array | -| `int[]` | `getEnumValues()`Deprecated.Interface function to pass out the enumeration array | -| `java.lang.String` | `getEnumValuesStr()`Deprecated.Interface function to pass out the enumeration array as a - comma separated string | -| `java.lang.String` | `getFormat()`Deprecated.Get the format string for the variable | -| `boolean` | `getHasFormat()`Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXInteger.html#hasFormat--) | -| `boolean` | `getHasLowerBound()`Deprecated.retrieves the hasLowerBound flag | -| `boolean` | `getHasUpperBound()`Deprecated.retrieves the hasUpperBound flag | -| `int` | `getLowerBound()`Deprecated.retrieves the current lower bound value | -| `int` | `getUpperBound()`Deprecated.retrieves the current upper bound value | -| `int` | `getValue()`Deprecated.retrieves the current value of the variable | -| `java.lang.String` | `getValueStr()`Deprecated.retrieves the string value of this variable as passed into the - last call to fromString(). | -| `boolean` | `hasFormat()`Deprecated.Whether or not the variable has a format | -| `void` | `setEnumAliases(java.lang.String values)`Deprecated.takes a comma seperated string of values and fills the - enumeration aliases list with values. | -| `void` | `setEnumAliases(java.lang.String[] values)`Deprecated.Sets the enumeration aliases list | -| `void` | `setEnumValues(int[] values)`Deprecated.Sets the enumeration list of valid values. | -| `void` | `setEnumValues(java.lang.String strEnumList)`Deprecated.sets the possible values a variable may be | -| `void` | `setFormat(java.lang.String format)`Deprecated.Set the format string for the variable | -| `void` | `setHasLowerBound(boolean value)`Deprecated.sets the hasLowerBound flag | -| `void` | `setHasUpperBound(boolean value)`Deprecated.sets the hasUpperBound flag | -| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`Deprecated.indicates whether the object should accept bad values in the - fromString() method without throwning an exception. | -| `void` | `setLowerBound(int value)`Deprecated.sets the lower bound. | -| `void` | `setLowerBound(java.lang.String value)`Deprecated. | -| `void` | `setUpperBound(int value)`Deprecated.sets the upper bound. | -| `void` | `setUpperBound(java.lang.String value)`Deprecated. | -| `void` | `setValue(int v)`Deprecated.sets the value for the variable | -| `java.lang.String` | `toString()`Deprecated.converts the variable to a string | -| `PHXStringBuffer` | `toString2()`Deprecated.converts the variable to a PHXStringBuffer | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXInteger - -```java -public PHXInteger() -``` -Deprecated. - -- #### PHXInteger - -```java -public PHXInteger(PHXInteger other) -``` -Deprecated.Clone another PHXInteger's value and metadata. +|-------------------|----------------------| +| `protected void` | `_copyMetadataFromOther(PHXInteger other)`
**Deprecated.**
Clone another PHXInteger's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
**Deprecated.**
Accept a Visitor. | +| `static java.lang.String` | `arrayToString(int[] sa)`
**Deprecated.**
| +| `PHXInteger` | `createCopy()`
**Deprecated.**
Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleType toCompare)`
**Deprecated.**
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`
**Deprecated.**
Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
**Deprecated.**
converts a String representation to the internal value | +| `void` | `fromString2(`[`PHXStringBuffer`](../util/PHXStringBuffer.md)` value)`
**Deprecated.**
converts a String representation to the internal value | +| `java.lang.String[]` | `getEnumAliases()`
**Deprecated.**
An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`
**Deprecated.**
An interface function for the enumeration array | +| `int[]` | `getEnumValues()`
**Deprecated.**
Interface function to pass out the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`
**Deprecated.**
Interface function to pass out the enumeration array as a comma separated string | +| `java.lang.String` | `getFormat()`
**Deprecated.**
Get the format string for the variable | +| `boolean` | `getHasFormat()`
**Deprecated.**
in favor of `hasFormat()` | +| `boolean` | `getHasLowerBound()`
**Deprecated.**
retrieves the `hasLowerBound` flag | +| `boolean` | `getHasUpperBound()`
**Deprecated.**
retrieves the `hasUpperBound` flag | +| `int` | `getLowerBound()`
**Deprecated.**
retrieves the current lower bound value | +| `int` | `getUpperBound()`
**Deprecated.**
retrieves the current upper bound value | +| `int` | `getValue()`
**Deprecated.**
retrieves the current value of the variable | +| `java.lang.String` | `getValueStr()`
**Deprecated.**
retrieves the string value of this variable as passed into the last call to `fromString()`. | +| `boolean` | `hasFormat()`
**Deprecated.**
Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`
**Deprecated.**
takes a comma seperated string of values and fills the enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`
**Deprecated.**
Sets the enumeration aliases list | +| `void` | `setEnumValues(int[] values)`
**Deprecated.**
Sets the enumeration list of valid values. | +| `void` | `setEnumValues(java.lang.String strEnumList)`
**Deprecated.**
sets the possible values a variable may be | +| `void` | `setFormat(java.lang.String format)`
**Deprecated.**
Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`
**Deprecated.**
sets the `hasLowerBound` flag | +| `void` | `setHasUpperBound(boolean value)`
**Deprecated.**
sets the `hasUpperBound` flag | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`
**Deprecated.**
indicates whether the object should accept bad values in the `fromString()` method without throwning an exception. | +| `void` | `setLowerBound(int value)`
**Deprecated.**
sets the lower bound. | +| `void` | `setLowerBound(java.lang.String value)`
**Deprecated.**
| +| `void` | `setUpperBound(int value)`
**Deprecated.**
sets the upper bound. | +| `void` | `setUpperBound(java.lang.String value)`
**Deprecated.**
| +| `void` | `setValue(int v)`
**Deprecated.**
sets the value for the variable | +| `java.lang.String` | `toString()`
**Deprecated.**
converts the variable to a string | +| [`PHXStringBuffer`](../util/PHXStringBuffer.md) | `toString2()`
**Deprecated.**
converts the variable to a PHXStringBuffer | + +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) + +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object + +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXInteger + +```java +public PHXInteger() +``` +**Deprecated.** + +### PHXInteger + +```java +public PHXInteger(PHXInteger other) +``` +**Deprecated.** Clone another PHXInteger's value and metadata. + **Parameters:** -: `other`- the other PHXInteger to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other` - the other PHXInteger to clone. + +## Method Detail -- #### _copyMetadataFromOther +### _copyMetadataFromOther ```java -protected final void _copyMetadataFromOther(PHXInteger other) +protected final void _copyMetadataFromOther(PHXInteger other) ``` -Deprecated.Clone another PHXInteger's metadata. +**Deprecated.** Clone another PHXInteger's metadata. + **Parameters:** -: `other`- the other PHXInteger +- `other` - the other PHXInteger -- #### getValue +### getValue ```java -public int getValue() +public int getValue() ``` -Deprecated.retrieves the current value of the variable +**Deprecated.** retrieves the current value of the variable + **Returns:** -: the value of the variable +- the value of the variable -- #### getValueStr +### getValueStr ```java -public java.lang.String getValueStr() +public java.lang.String getValueStr() ``` -Deprecated.retrieves the string value of this variable as passed into the - last call to fromString(). This may not be equivalent to the current - value of the variable. +**Deprecated.** retrieves the string value of this variable as passed into the last call to `fromString()`. This may not be equivalent to the current value of the variable. + **Returns:** -: the string last used to set the variable +- the string last used to set the variable -- #### setValue +### setValue ```java -public void setValue(int v) +public void setValue(int v) ``` -Deprecated.sets the value for the variable +**Deprecated.** sets the value for the variable + **Parameters:** -: `v`- the value +- `v` - the value -- #### setUpperBound +### setUpperBound ```java -public void setUpperBound(int value) +public void setUpperBound(int value) ``` -Deprecated.sets the upper bound. The hasUpperBound value is set to true +**Deprecated.** sets the upper bound. The `hasUpperBound` value is set to `true` + **Parameters:** -: `value`- the upper bound +- `value` - the upper bound -- #### setUpperBound +### setUpperBound ```java -public void setUpperBound(java.lang.String value) +public void setUpperBound(java.lang.String value) ``` -Deprecated. +**Deprecated.** -- #### getUpperBound +### getUpperBound ```java -public int getUpperBound() +public int getUpperBound() ``` -Deprecated.retrieves the current upper bound value +**Deprecated.** retrieves the current upper bound value + **Returns:** -: the upper bound +- the upper bound -- #### setLowerBound +### setLowerBound ```java -public void setLowerBound(int value) +public void setLowerBound(int value) ``` -Deprecated.sets the lower bound. The hasLowerBound value is set to true +**Deprecated.** sets the lower bound. The `hasLowerBound` value is set to true + **Parameters:** -: `value`- the lower bound +- `value` - the lower bound -- #### setLowerBound +### setLowerBound ```java -public void setLowerBound(java.lang.String value) +public void setLowerBound(java.lang.String value) ``` -Deprecated. +**Deprecated.** -- #### getLowerBound +### getLowerBound ```java -public int getLowerBound() +public int getLowerBound() ``` -Deprecated.retrieves the current lower bound value +**Deprecated.** retrieves the current lower bound value + **Returns:** -: the lower bound +- the lower bound -- #### setHasUpperBound +### setHasUpperBound ```java -public void setHasUpperBound(boolean value) +public void setHasUpperBound(boolean value) ``` -Deprecated.sets the hasUpperBound flag +**Deprecated.** sets the `hasUpperBound` flag + **Parameters:** -: `value`- true or false +- `value` - true or false -- #### getHasUpperBound +### getHasUpperBound ```java -public boolean getHasUpperBound() +public boolean getHasUpperBound() ``` -Deprecated.retrieves the hasUpperBound flag +**Deprecated.** retrieves the `hasUpperBound` flag + **Returns:** -: true or false +- true or false -- #### setHasLowerBound +### setHasLowerBound ```java -public void setHasLowerBound(boolean value) +public void setHasLowerBound(boolean value) ``` -Deprecated.sets the hasLowerBound flag +**Deprecated.** sets the `hasLowerBound` flag + **Parameters:** -: `value`- true or false +- `value` - true or false -- #### getHasLowerBound +### getHasLowerBound ```java -public boolean getHasLowerBound() +public boolean getHasLowerBound() ``` -Deprecated.retrieves the hasLowerBound flag +**Deprecated.** retrieves the `hasLowerBound` flag + **Returns:** -: true or false +- true or false -- #### toString2 +### toString2 ```java -public PHXStringBuffer toString2() +public PHXStringBuffer toString2() ``` -Deprecated.converts the variable to a PHXStringBuffer +**Deprecated.** converts the variable to a [PHXStringBuffer](../util/PHXStringBuffer.md) + **Specified by:** -: `toString2`in interface`IPHXType2` +- `toString2` in interface [`IPHXType2`](IPHXType2.md) + **Returns:** -: a PHXStringBuffer representation of the variable +- a PHXStringBuffer representation of the variable -- #### toString +### toString ```java -public java.lang.String toString() +public java.lang.String toString() ``` -Deprecated.converts the variable to a string +**Deprecated.** converts the variable to a string + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString2 +### fromString2 ```java -public void fromString2(PHXStringBuffer value) +public void fromString2(PHXStringBuffer value) ``` -Deprecated.converts a String representation to the internal value +**Deprecated.**converts a String representation to the internal value + **Specified by:** -: `fromString2`in interface`IPHXType2` +- `fromString2` in interface [`IPHXType2`](IPHXType2.md) + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### fromString +### fromString ```java -public void fromString(java.lang.String value) +public void fromString(java.lang.String value) ``` -Deprecated.converts a String representation to the internal value +**Deprecated.** converts a String representation to the internal value + **Specified by:** -: `fromString`in interface`IPHXType` +- `fromString` in interface [`IPHXType`](IPHXType.md) + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### setIgnoreConversionErrors +### setIgnoreConversionErrors ```java -public void setIgnoreConversionErrors(boolean ignoreConversionErrors) +public void setIgnoreConversionErrors(boolean ignoreConversionErrors) ``` -Deprecated.indicates whether the object should accept bad values in the - fromString() method without throwning an exception. The raw - values is stored in property valueStr regardless. +**Deprecated.** indicates whether the object should accept bad values in the `fromString()` method without throwning an exception. The raw values is stored in property `valueStr` regardless. + **Parameters:** -: `ignoreConversionErrors`- true if errors should be ignored +- `ignoreConversionErrors` - `true` if errors should be ignored -- #### setEnumValues +### setEnumValues ```java -public void setEnumValues(java.lang.String strEnumList) +public void setEnumValues(java.lang.String strEnumList) ``` -Deprecated.sets the possible values a variable may be +**Deprecated.** sets the possible values a variable may be + **Parameters:** -: `strEnumList`- the comma sepperated list to convert to values +- `strEnumList` - the comma sepperated list to convert to values -- #### setEnumValues +### setEnumValues ```java -public void setEnumValues(int[] values) +public void setEnumValues(int[] values) ``` -Deprecated.Sets the enumeration list of valid values. +**Deprecated.** Sets the enumeration list of valid values. + **Parameters:** -: `values`- An array of double values +- `values` - An array of double values -- #### getEnumValues +### getEnumValues ```java -public int[] getEnumValues() +public int[] getEnumValues() ``` -Deprecated.Interface function to pass out the enumeration array +**Deprecated.** Interface function to pass out the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumValuesStr +### getEnumValuesStr ```java -public java.lang.String getEnumValuesStr() +public java.lang.String getEnumValuesStr() ``` -Deprecated.Interface function to pass out the enumeration array as a - comma separated string +**Deprecated.** Interface function to pass out the enumeration array as a comma separated string + **Returns:** -: comma separated string of the possible values of the list +- comma separated string of the possible values of the list -- #### setEnumAliases +### setEnumAliases ```java -public void setEnumAliases(java.lang.String values) +public void setEnumAliases(java.lang.String values) ``` -Deprecated.takes a comma seperated string of values and fills the - enumeration aliases list with values. +**Deprecated.** takes a comma seperated string of values and fills the enumeration aliases list with values. + **Parameters:** -: `values`- A comma seperated string of enumeration aliases +- `values` - A comma seperated string of enumeration aliases -- #### setEnumAliases +### setEnumAliases ```java -public void setEnumAliases(java.lang.String[] values) +public void setEnumAliases(java.lang.String[] values) ``` -Deprecated.Sets the enumeration aliases list +**Deprecated.** Sets the enumeration aliases list + **Parameters:** -: `values`- An array of strings +- `values` - An array of strings -- #### getEnumAliases +### getEnumAliases ```java -public java.lang.String[] getEnumAliases() +public java.lang.String[] getEnumAliases() ``` -Deprecated.An interface function for the enumeration array +**Deprecated.** An interface function for the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumAliasesStr +### getEnumAliasesStr ```java -public java.lang.String getEnumAliasesStr() +public java.lang.String getEnumAliasesStr() ``` -Deprecated.An interface function for the enumeration array +**Deprecated.** An interface function for the enumeration array + **Returns:** -: an comma separated string of the possible values of the list +- an comma separated string of the possible values of the list -- #### getHasFormat +### getHasFormat ```java @Deprecated -public boolean getHasFormat() +public boolean getHasFormat() ``` -Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXInteger.html#hasFormat--) +**Deprecated.** in favor of `hasFormat()` -- #### hasFormat +### hasFormat ```java -public boolean hasFormat() +public boolean hasFormat() ``` -Deprecated.Whether or not the variable has a format +**Deprecated.** Whether or not the variable has a format + **Specified by:** -: `hasFormat`in interface`IPHXFormat` +- `hasFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Returns:** -: true if variable has a format +- true if variable has a format -- #### setFormat +### setFormat ```java -public void setFormat(java.lang.String format) +public void setFormat(java.lang.String format) ``` -Deprecated.Set the format string for the variable +**Deprecated.** Set the format string for the variable + **Specified by:** -: `setFormat`in interface`IPHXFormat` +- `setFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Parameters:** -: `format`- format string +- `format` - format string -- #### getFormat +### getFormat ```java -public java.lang.String getFormat() +public java.lang.String getFormat() ``` -Deprecated.Get the format string for the variable +**Deprecated.** Get the format string for the variable + **Specified by:** -: `getFormat`in interface`IPHXFormat` +- `getFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Returns:** -: format string +- format string -- #### arrayToString +### arrayToString ```java -public static java.lang.String arrayToString(int[] sa) +public static java.lang.String arrayToString(int[] sa) ``` -Deprecated. +**Deprecated.** -- #### equalsNatural +### equalsNatural ```java -public boolean equalsNatural(PHXSimpleType toCompare) +public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Deprecated.Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +**Deprecated.** Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toCompare`- -**Returns:** +- `toCompare` - + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) - if the given PHXSimpleType cannot be compared with this object. -- #### fromObject +### fromObject ```java -public void fromObject(java.lang.Object toRead) +public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Deprecated.Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +**Deprecated.** Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java -public  T Accept(IPHXType2.IVisitor visitor) +public T Accept(IPHXType2.IVisitor visitor) ``` -Deprecated.Accept a Visitor. +**Deprecated.** Accept a Visitor. + **Specified by:** -: `Accept`in interface`IPHXType2` +- `Accept` in interface [`IPHXType2`](IPHXType2.md) + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java -public PHXInteger createCopy() +public PHXInteger createCopy() ``` -Deprecated.Create a copy of this instance, including the value and metadata. +**Deprecated.** Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md index 50689b3ab7..5d2184546e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXInvalidTypeException.md @@ -1,57 +1,71 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXInvalidTypeException -- java.lang.Object -- - java.lang.Throwable -- - java.lang.Exception -- - com.phoenix_int.aserver.types.PHXInvalidTypeException -- **All Implemented Interfaces:** -: java.io.Serializable - ---- +# Class: PHXInvalidTypeException + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.types.PHXInvalidTypeException +``` + +**Implemented Interfaces** + +- `java.io.Serializable` + +--- +**Declaration** ```java public class PHXInvalidTypeException extends java.lang.Exception ``` + An exception that is thrown when trying to use a bad type + **See Also:** -: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.types.PHXInvalidTypeException)- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +[`Serialized Form`](../../../../serialized-form.md) + +## Constructor Summary | Constructor and Description | -| --- | -| Constructor and Description | -| `PHXInvalidTypeException(java.lang.String type)`Create an invalid type exception | -| `PHXInvalidTypeException(java.lang.String type, - java.lang.Throwable cause)`Create an invalid type exception with a cause | -========== METHOD SUMMARY =========== -- ### Method Summary +|---------------------| +| `PHXInvalidTypeException(java.lang.String type)`
Create an invalid type exception | +| `PHXInvalidTypeException(java.lang.String type, java.lang.Throwable cause)`
Create an invalid type exception with a cause | + +## Method Summary + +### Methods inherited from class java.lang.Throwable -- ### Methods inherited from class java.lang.Throwable -`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object -- #### PHXInvalidTypeException +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXInvalidTypeException ```java -public PHXInvalidTypeException(java.lang.String type) +public PHXInvalidTypeException(java.lang.String type) ``` Create an invalid type exception + **Parameters:** -: `type`- the bad type +- `type` - the bad type -- #### PHXInvalidTypeException +### PHXInvalidTypeException ```java -public PHXInvalidTypeException(java.lang.String type, - java.lang.Throwable cause) +public PHXInvalidTypeException(java.lang.String type, + java.lang.Throwable cause) ``` Create an invalid type exception with a cause + **Parameters:** -: `type`- the bad type -: `cause`- the exception that caused this exception -========= END OF CLASS DATA ========= \ No newline at end of file +- `type` - the bad type +- `cause` - the exception that caused this exception \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md index a02ae930f0..b05bc32eaf 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLong.md @@ -1,387 +1,415 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXLong -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXLong -- **All Implemented Interfaces:** -: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class: PHXLong ---- +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXLong +``` + +**Implemented Interfaces** + +- [`IPHXFormat`](IPHXFormat.md), [`IPHXType`](IPHXType.md), [`IPHXType2`](IPHXType2.md), [`IPHXUnits`](IPHXUnits.md) + +--- +**Declaration** ```java public class PHXLong extends PHXSimpleType implements IPHXFormat ``` -The Phoenix type for longs. This class adds the following - features to the PHXSimpleType: + +The Phoenix type for longs. This class adds the following features to the [`PHXSimpleType`](PHXSimpleType.md): + - **value**: long -- **valueStr**: the source string for the value, - useful for error checking when the value is NaN +- **valueStr**: the source string for the value, useful for error checking when the value is NaN - **hasUpperValue**: boolean - **upperValue**: long - **hasLowerValue**: boolean - **lowerValue**: long - **enumValues**: long[] - **enumAliases**: String[] -If the variable has an upper or lower bound and an attempt - is made to store an invalid value, then an exception will - be thrown. -**Author:** -: Woyak + +If the variable has an upper or lower bound and an attempt is made to store an invalid value, then an exception will be thrown. + **See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +- [`PHXSimpleType`](PHXSimpleType.md) + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXLong()`Initializes value to 0. | -| `PHXLong(long value)`Initializes value to the specified value | -| `PHXLong(PHXLongother)`Clone another PHXLong's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXLong()`
Initializes value to 0. | +| `PHXLong(long value)`
Initializes value to the specified value | +| `PHXLong(PHXLongother)`
Clone another PHXLong's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | -| --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_copyMetadataFromOther(PHXLongother)`Clone another PHXLong's metadata. | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | +|-------------------|----------------------| +| `protected void` | `_copyMetadataFromOther(PHXLongother)`
Clone another PHXLong's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | | `static java.lang.String` | `arrayToString(long[] sa)` | -| `PHXLong` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | -| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | -| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | -| `long[]` | `getEnumValues()`Interface function to pass out the enumeration array | -| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a - comma separated string | -| `java.lang.String` | `getFormat()`Get the format string for the variable | -| `boolean` | `getHasFormat()`Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXLong.html#hasFormat--) | -| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | -| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | -| `long` | `getLowerBound()`retrieves the current lower bound value | -| `long` | `getUpperBound()`retrieves the current upper bound value | -| `long` | `getValue()`retrieves the current value of the variable | -| `java.lang.String` | `getValueStr()`retrieves the string value of this variable as passed into the - last call to fromString(). | -| `boolean` | `hasFormat()`Whether or not the variable has a format | -| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration aliases list with values. | -| `void` | `setEnumAliases(java.lang.String[] values)`Takes an array of strings which represent aliases for - the enumValues. | -| `void` | `setEnumValues(long[] values)`sets the possible values a variable may be | -| `void` | `setEnumValues(java.lang.String strEnumList)`sets the possible values a variable may be | -| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | -| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | -| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | -| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`indicates whether the object should accept bad values in the - fromString() method without throwning an exception. | -| `void` | `setLowerBound(long value)`sets the lower bound. | +| `PHXLong` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`
converts a [`PHXStringBuffer`](../util/PHXStringBuffer.md) representation to the internal value | +| `java.lang.String[]` | `getEnumAliases()`
An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`
An interface function for the enumeration array | +| `long[]` | `getEnumValues()`
Interface function to pass out the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`
Interface function to pass out the enumeration array as a comma separated string | +| `java.lang.String` | `getFormat()`
Get the format string for the variable | +| `boolean` | `getHasFormat()`
Deprecated.in favor of [`hasFormat()`](../../../../com/phoenix_int/aserver/types/PHXLong.html#hasFormat--) | +| `boolean` | `getHasLowerBound()`
retrieves the `hasLowerBound` flag | +| `boolean` | `getHasUpperBound()`
retrieves the `hasUpperBound` flag | +| `long` | `getLowerBound()`
retrieves the current lower bound value | +| `long` | `getUpperBound()`
retrieves the current upper bound value | +| `long` | `getValue()`
retrieves the current value of the variable | +| `java.lang.String` | `getValueStr()`
retrieves the string value of this variable as passed into the last call to `fromString()`. | +| `boolean` | `hasFormat()`
Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`
takes a comma seperated string of values and fills the enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`
Takes an array of strings which represent aliases for the enumValues. | +| `void` | `setEnumValues(long[] values)`
sets the possible values a variable may be | +| `void` | `setEnumValues(java.lang.String strEnumList)`
sets the possible values a variable may be | +| `void` | `setFormat(java.lang.String format)`
Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`
sets the `hasLowerBound` flag | +| `void` | `setHasUpperBound(boolean value)`
sets the `hasUpperBound` flag | +| `void` | `setIgnoreConversionErrors(boolean ignoreConversionErrors)`
indicates whether the object should accept bad values in the `fromString()` method without throwning an exception. | +| `void` | `setLowerBound(long value)`
sets the lower bound. | | `void` | `setLowerBound(java.lang.String value)` | -| `void` | `setUpperBound(long value)`sets the upper bound. | +| `void` | `setUpperBound(long value)`
sets the upper bound. | | `void` | `setUpperBound(java.lang.String value)` | -| `void` | `setValue(long v)`sets the value for the variable | -| `java.lang.String` | `toString()`converts the variable to a string | -| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | +| `void` | `setValue(long v)`
sets the value for the variable | +| `java.lang.String` | `toString()`
converts the variable to a string | +| `PHXStringBuffer` | `toString2()`
converts the variable to a [`PHXStringBuffer`](../util/PHXStringBuffer.md) | + +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther`,`addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +## Constructor Detail -- #### PHXLong +### PHXLong ```java public PHXLong() ``` Initializes value to 0. -- #### PHXLong +#### PHXLong ```java public PHXLong(long value) ``` Initializes value to the specified value + **Parameters:** : `value`- the value to use -- #### PHXLong +#### PHXLong ```java public PHXLong(PHXLong other) ``` Clone another PHXLong's value and metadata. + **Parameters:** -: `other`- the other PHXLong to clone. -============ METHOD DETAIL ========== -- ### Method Detail -- #### _copyMetadataFromOther +- `other` - the other PHXLong to clone. + +## Method Detail + +### _copyMetadataFromOther ```java protected final void _copyMetadataFromOther(PHXLong other) ``` -Clone another PHXLong's metadata. +Clone another [`PHXLong`](PHXLong.md)'s metadata. + **Parameters:** -: `other`- the other PHXLong +- `other` - the other [`PHXLong`](PHXLong.md) -- #### getValue +### getValue ```java public long getValue() ``` retrieves the current value of the variable + **Returns:** -: the value of the variable +- the value of the variable -- #### getValueStr +### getValueStr ```java public java.lang.String getValueStr() ``` -retrieves the string value of this variable as passed into the - last call to fromString(). This may not be equivalent to the current - value of the variable. +retrieves the string value of this variable as passed into the last call to `fromString()`. This may not be equivalent to the current value of the variable. + **Returns:** -: the string last used to set the variable +- the string last used to set the variable -- #### setValue +### setValue ```java public void setValue(long v) ``` sets the value for the variable + **Parameters:** -: `v`- the value +- `v` - the value -- #### setUpperBound +### setUpperBound ```java public void setUpperBound(long value) ``` -sets the upper bound. The hasUpperBound value is set to true +sets the upper bound. The `hasUpperBound` value is set to true + **Parameters:** -: `value`- the upper bound +- `value` - the upper bound -- #### setUpperBound +### setUpperBound ```java public void setUpperBound(java.lang.String value) ``` -- #### getUpperBound +### getUpperBound ```java public long getUpperBound() ``` retrieves the current upper bound value + **Returns:** -: the upper bound +- the upper bound -- #### setLowerBound +### setLowerBound ```java public void setLowerBound(long value) ``` -sets the lower bound. The hasLowerBound value is set to true +sets the lower bound. The `hasLowerBound` value is set to true + **Parameters:** -: `value`- the lower bound +- `value` - the lower bound -- #### setLowerBound +### setLowerBound ```java public void setLowerBound(java.lang.String value) ``` -- #### getLowerBound +### getLowerBound ```java public long getLowerBound() ``` retrieves the current lower bound value + **Returns:** -: the lower bound +- the lower bound -- #### setHasUpperBound +### setHasUpperBound ```java public void setHasUpperBound(boolean value) ``` -sets the hasUpperBound flag +sets the `hasUpperBound` flag + **Parameters:** -: `value`- true or false +- `value` - true or false -- #### getHasUpperBound +### getHasUpperBound ```java public boolean getHasUpperBound() ``` -retrieves the hasUpperBound flag +retrieves the `hasUpperBound` flag + **Returns:** -: true or false +- true or false -- #### setHasLowerBound +### setHasLowerBound ```java public void setHasLowerBound(boolean value) ``` -sets the hasLowerBound flag +sets the `hasLowerBound` flag + **Parameters:** -: `value`- true or false +- `value` - true or false -- #### getHasLowerBound +### getHasLowerBound ```java public boolean getHasLowerBound() ``` -retrieves the hasLowerBound flag +retrieves the `hasLowerBound` flag + **Returns:** -: true or false +- true or false -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2() ``` -converts the variable to a PHXStringBuffer +converts the variable to a [`PHXStringBuffer`](../util/PHXStringBuffer.md) + **Specified by:** -: `toString2`in interface`IPHXType2` +- `toString2` in interface [`IPHXType2`](IPHXType2.md) + **Returns:** -: a PHXStringBuffer representation of the variable +- a [`PHXStringBuffer`](../util/PHXStringBuffer.md) representation of the variable -- #### toString +### toString ```java public java.lang.String toString() ``` converts the variable to a string + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString2 +### fromString2 ```java public void fromString2(PHXStringBuffer value) ``` -converts a PHXStringBuffer representation to the internal value +converts a [`PHXStringBuffer`](../util/PHXStringBuffer.md) representation to the internal value + **Specified by:** -: `fromString2`in interface`IPHXType2` +- `fromString2` in interface [`IPHXType2`](IPHXType2.md) + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### fromString +### fromString ```java public void fromString(java.lang.String value) ``` converts a String representation to the internal value + **Specified by:** -: `fromString`in interface`IPHXType` +- `fromString` in interface [`IPHXType`](IPHXType.md) + **Parameters:** -: `value`- the value to convert +- `value` - the value to convert -- #### setIgnoreConversionErrors +### setIgnoreConversionErrors ```java public void setIgnoreConversionErrors(boolean ignoreConversionErrors) ``` -indicates whether the object should accept bad values in the - fromString() method without throwning an exception. The raw - values is stored in property valueStr regardless. +indicates whether the object should accept bad values in the `fromString()` method without throwning an exception. The raw values is stored in property valueStr regardless. + **Parameters:** -: `ignoreConversionErrors`- true if errors should be ignored +- `ignoreConversionErrors` - true if errors should be ignored -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String strEnumList) ``` sets the possible values a variable may be + **Parameters:** -: `strEnumList`- the comma sepperated list to convert to values +- `strEnumList` - the comma sepperated list to convert to values -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(long[] values) ``` sets the possible values a variable may be + **Parameters:** -: `values`- Array of longs which represents valid values +- `values` - Array of longs which represents valid values -- #### getEnumValues +### getEnumValues ```java public long[] getEnumValues() ``` Interface function to pass out the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumValuesStr +### getEnumValuesStr ```java public java.lang.String getEnumValuesStr() ``` -Interface function to pass out the enumeration array as a - comma separated string +Interface function to pass out the enumeration array as a comma separated string + **Returns:** -: comma separated string of the possible values of the list +- comma separated string of the possible values of the list -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String[] values) ``` -Takes an array of strings which represent aliases for - the enumValues. +Takes an array of strings which represent aliases for the enumValues. + **Parameters:** -: `values`- A String array of enumeration aliases +- `values` - A String array of enumeration aliases -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration aliases list with values. +takes a comma seperated string of values and fills the enumeration aliases list with values. + **Parameters:** -: `values`- A comma seperated string of enumeration aliases +- `values` - A comma seperated string of enumeration aliases -- #### getEnumAliases +### getEnumAliases ```java public java.lang.String[] getEnumAliases() ``` An interface function for the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumAliasesStr +### getEnumAliasesStr ```java public java.lang.String getEnumAliasesStr() ``` An interface function for the enumeration array + **Returns:** -: an comma separated string of the possible values of the list +- an comma separated string of the possible values of the list -- #### getHasFormat +### getHasFormat ```java @Deprecated @@ -389,104 +417,117 @@ public boolean getHasFormat() ``` Deprecated.in favor of[hasFormat()](../../../../com/phoenix_int/aserver/types/PHXLong.html#hasFormat--) -- #### hasFormat +### hasFormat ```java public boolean hasFormat() ``` Whether or not the variable has a format + **Specified by:** -: `hasFormat`in interface`IPHXFormat` +- `hasFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Returns:** -: true if variable has a format +- `true` if variable has a format -- #### setFormat +### setFormat ```java public void setFormat(java.lang.String format) ``` Set the format string for the variable + **Specified by:** -: `setFormat`in interface`IPHXFormat` +- `setFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Parameters:** -: `format`- format string +- `format` - format string -- #### getFormat +### getFormat ```java public java.lang.String getFormat() ``` Get the format string for the variable + **Specified by:** -: `getFormat`in interface`IPHXFormat` +- `getFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Returns:** -: format string +- format string -- #### arrayToString +### arrayToString ```java public static java.lang.String arrayToString(long[] sa) ``` -- #### equalsNatural +### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this [`PHXSimpleType`](PHXSimpleType.md) to another [`PHXSimpleType`](PHXSimpleType.md). This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare` - + **Returns:** + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) - if the given [`PHXSimpleType`](PHXSimpleType.md) cannot be compared with this object. -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md) + +NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an array of java.lang.(Type), that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Specified by:** -: `Accept`in interface`IPHXType2` +- `Accept` in interface [`IPHXType2`](IPHXType2.md) + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java public PHXLong createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md index a687c4bb2c..ca4c49192c 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXLongArray.md @@ -1,12 +1,16 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXLongArray -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html)> -- - com.phoenix_int.aserver.types.PHXLongArray -- **All Implemented Interfaces:** -: [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html)> +# Class PHXLongArray + +**Package:** `com.phoenix_int.aserver.types` + +**Class Hierarchy** +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXSimpleArray + ↳ com.phoenix_int.aserver.types.PHXLongArray +``` +**All Implemented Interfaces:** +- [`IPHXFormat`](IPHXFormat.md), [`IPHXType`](IPHXType.md), [`IPHXType2`](IPHXType2.md), [`IPHXUnits`](IPHXUnits.md), java.lang.Iterable<[`PHXLong`](PHXLong.md)> --- @@ -15,547 +19,582 @@ public class PHXLongArray extends PHXSimpleArray implements IPHXFormat ``` -Class wraps an array of PHXLong variables - for the ScriptWrapper utility. -**Version:** -: May 2002 -**Author:** -: Nathan P Sharp +Class wraps an array of [`PHXLong`](PHXLong.md) variables for the ScriptWrapper utility. + **See Also:** -: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +- [`PHXSimpleArray`](PHXSimpleArray.md) -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -=========== FIELD SUMMARY =========== -- ### Field Summary -- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_data,_lockDims,_lockResize` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.types.[PHXSimpleArray](PHXSimpleArray.md) +`_data`, `_lockDims`, `_lockResize` + +## Constructor Summary | Constructor and Description | | --- | | Constructor and Description | | `PHXLongArray()` | | `PHXLongArray(java.lang.Object data)` | -| `PHXLongArray(PHXLongArrayother)`Clone another PHXLongArray's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXLongArray(PHXLongArrayother)`
Clone another PHXLongArray's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. | -| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data - in this object. | -| `void` | `_sort(PHXLongArrayarray, - boolean ascend)` | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | -| `PHXLongArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified - class is acceptable as an array element component type. | -| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `protected void` | `_getMetaData(PHXSimpleTypev2)`
Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. | +| `protected void` | `_setMetaData(PHXSimpleTypev2)`
Sets a simple type's meta data based on the meta data in this object. | +| `void` | `_sort(PHXLongArrayarray, boolean ascend)` | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`
Allocates a single element in a default state. | +| `PHXLongArray` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)
`Must override this function and return true if the specified class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`
Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | | `double` | `getAvg()` | -| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | -| `long[]` | `getEnumValues()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a - comma separated string | -| `java.lang.String` | `getFormat()`Get the format string for the variable | -| `boolean` | `getHasLowerBound()`retrieves the hasLowerBound flag | -| `boolean` | `getHasUpperBound()`retrieves the hasUpperBound flag | -| `long` | `getLongValue(int index)`Gets the value of an element as a long | -| `long` | `getLongValue(int[] index)`Gets the value of an element as a long | -| `long` | `getLowerBound()`retrieves the current lower bound value | +| `java.lang.String[]` | `getEnumAliases()`
An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`
An interface function for the enumeration array | +| `long[]` | `getEnumValues()`
An interface function for the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`
Interface function to pass out the enumeration array as a comma separated string | +| `java.lang.String` | `getFormat()`
Get the format string for the variable | +| `boolean` | `getHasLowerBound()`
retrieves the hasLowerBound flag | +| `boolean` | `getHasUpperBound()`
retrieves the hasUpperBound flag | +| `long` | `getLongValue(int index)`
Gets the value of an element as a long | +| `long` | `getLongValue(int[] index)`
Gets the value of an element as a long | +| `long` | `getLowerBound()`
retrieves the current lower bound value | | `long` | `getMax()` | | `long` | `getMin()` | -| `long` | `getUpperBound()`retrieves the current upper bound value | -| `PHXLong` | `getValue(int index)`Gets the value of an element as a PHXLong object | -| `PHXLong` | `getValue(int[] index)`Gets the value of an element as a PHXLong object | -| `boolean` | `hasFormat()`Whether or not the variable has a format | -| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration aliases list with values. | -| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | -| `void` | `setEnumValues(long[] values)`sets the possible values a variable may be | -| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration List with values. | -| `void` | `setFormat(java.lang.String format)`Set the format string for the variable | -| `void` | `setHasLowerBound(boolean value)`sets the hasLowerBound flag | -| `void` | `setHasUpperBound(boolean value)`sets the hasUpperBound flag | -| `void` | `setLowerBound(long value)`sets the lower bound. | -| `void` | `setUpperBound(long value)`sets the upper bound. | -| `void` | `setValue(int[] index, - long val)`Sets the value of an element as a PHXLong object | -| `void` | `setValue(int[] index,PHXLongval)`Sets the value of an element as a PHXLong object | -| `void` | `setValue(int index, - long val)`Sets the value of an element as a PHXLong object | +| `long` | `getUpperBound()`
retrieves the current upper bound value | +| `PHXLong` | `getValue(int index)`
Gets the value of an element as a PHXLong object | +| `PHXLong` | `getValue(int[] index)`
Gets the value of an element as a PHXLong object | +| `boolean` | `hasFormat()`
Whether or not the variable has a format | +| `void` | `setEnumAliases(java.lang.String values)`
takes a comma seperated string of values and fills the enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`
Sets the enumeration aliases list | +| `void` | `setEnumValues(long[] values)`
sets the possible values a variable may be | +| `void` | `setEnumValues(java.lang.String values)`
takes a comma seperated string of values and fills the enumeration List with values. | +| `void` | `setFormat(java.lang.String format)`
Set the format string for the variable | +| `void` | `setHasLowerBound(boolean value)`
sets the hasLowerBound flag | +| `void` | `setHasUpperBound(boolean value)`
sets the hasUpperBound flag | +| `void` | `setLowerBound(long value)`
sets the lower bound. | +| `void` | `setUpperBound(long value)`
sets the upper bound. | +| `void` | `setValue(int[] index, long val)`
Sets the value of an element as a PHXLong object | +| `void` | `setValue(int[] index,PHXLongval)`
Sets the value of an element as a PHXLong object | +| `void` | `setValue(int index,long val)`
Sets the value of an element as a PHXLong object | | `void` | `sort()` | | `void` | `sortReverse()` | -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_getMetaData,_setMetaData,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData`, `_setMetaData`, `checkRectangular`, `copy`, `equalsNatural`, `fromString`, `fromString`, `fromString`, `fromString`, `fromString2`, `generateFor`, `generateFor`, `getArray`, `getArrayElement`, `getArrayElement`, `getComponentType`, `getComponentType`, `getDimensions`, `getDimensions`, `getFirst`, `getLength`, `getLength`, `getLockResize`, `getnDIndex`, `getNumDimensions`, `getNumDimensions`, `getSelf`, `incrementIndex`, `iterator`, `lockDimensions`, `newIndex`, `parseIndex`, `resize`, `setArray`, `setArrayElement`, `setArrayElement`, `setDimensions`, `setFirst`, `setLength`, `setLength`, `setLockResize`, `setValue`, `toString`, `toString`, `toString`, `toString`, `toString2`, `toString2`, `toString2`, `validElement`` -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- ### Methods inherited from interface java.lang.Iterable -`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from interface java.lang.Iterable +`forEach`, `spliterator` -- #### PHXLongArray +## Constructor Detail + +### PHXLongArray ```java public PHXLongArray() ``` -- #### PHXLongArray +### PHXLongArray ```java public PHXLongArray(java.lang.Object data) ``` -- #### PHXLongArray +### PHXLongArray ```java public PHXLongArray(PHXLongArray other) ``` -Clone another PHXLongArray's value and metadata. +Clone another [`PHXLongArray`](PHXLongArray.md)'s value and metadata. + **Parameters:** -: `other`- the other PHXLongArray to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other`- the other [`PHXLongArray`](PHXLongArray.md) to clone. + +## Method Detail -- #### dataTypeOK +### dataTypeOK ```java protected boolean dataTypeOK(java.lang.Class c) ``` -Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified - class is acceptable as an array element component type. +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Must override this function and return true if the specified class is acceptable as an array element component type. + **Specified by:** -: `dataTypeOK`in class`PHXSimpleArray` +- `dataTypeOK` in class `PHXSimpleArray` -- #### allocateElement +### allocateElement ```java protected java.lang.Object allocateElement(java.lang.Class elementClass) throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. - If the class type in question has a default constructor, - there is no need to override this. +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Allocates a single element in a default state. If the class type in question has a default constructor, there is no need to override this. + **Overrides:** -: `allocateElement`in class`PHXSimpleArray` +- `allocateElement` in class [`PHXSimpleArray`](PHXSimpleArray.md)`<`[`PHXLong`](PHXLong.md)`>` + **Throws:** -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### setUpperBound +### setUpperBound ```java public void setUpperBound(long value) ``` -sets the upper bound. The hasUpperBound value is set to true +sets the upper bound. The `hasUpperBound` value is set to `true` + **Parameters:** -: `value`- the upper bound +- `value`- the upper bound -- #### getUpperBound +### getUpperBound ```java public long getUpperBound() ``` retrieves the current upper bound value + **Returns:** -: the upper bound +- the upper bound + **Throws:** -: `java.lang.IllegalStateException`- Thrown if - there is no upper bound defined. +- `java.lang.IllegalStateException`- Thrown if there is no upper bound defined. -- #### setLowerBound +### setLowerBound ```java public void setLowerBound(long value) ``` -sets the lower bound. The hasLowerBound value is set to true +sets the lower bound. The `hasLowerBound` value is set to `true` + **Parameters:** -: `value`- the lower bound +- `value`- the lower bound -- #### getLowerBound +### getLowerBound ```java public long getLowerBound() ``` retrieves the current lower bound value + **Returns:** -: the lower bound +- the lower bound -- #### setHasUpperBound +### setHasUpperBound ```java public void setHasUpperBound(boolean value) ``` -sets the hasUpperBound flag +sets the `hasUpperBound` flag + **Parameters:** -: `value`- true or false +- `value`- true or false -- #### getHasUpperBound +### getHasUpperBound ```java public boolean getHasUpperBound() ``` -retrieves the hasUpperBound flag +retrieves the `hasUpperBound` flag + **Returns:** -: true or false +- true or false -- #### setHasLowerBound +### setHasLowerBound ```java public void setHasLowerBound(boolean value) ``` -sets the hasLowerBound flag +sets the `hasLowerBound` flag + **Parameters:** -: `value`- true or false +- `value`- true or false -- #### getHasLowerBound +### getHasLowerBound ```java public boolean getHasLowerBound() ``` -retrieves the hasLowerBound flag +retrieves the `hasLowerBound` flag + **Returns:** -: true or false +- true or false -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration List with values. +takes a comma seperated string of values and fills the enumeration List with values. + **Parameters:** -: `values`- A comma seperrated string of enumeration values +- `values`- A comma seperated string of enumeration values -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(long[] values) ``` sets the possible values a variable may be + **Parameters:** -: `values`- Array of longs which represents valid values +- `values`- Array of longs which represents valid values -- #### getEnumValues +### getEnumValues ```java public long[] getEnumValues() ``` An interface function for the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumValuesStr +### getEnumValuesStr ```java public java.lang.String getEnumValuesStr() ``` -Interface function to pass out the enumeration array as a - comma separated string +Interface function to pass out the enumeration array as a comma separated string + **Returns:** -: comma separated string of the possible values of the list +- comma separated string of the possible values of the list -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration aliases list with values. +takes a comma seperated string of values and fills the enumeration aliases list with values. + **Parameters:** -: `values`- A comma seperated string of enumeration aliases +- `values`- A comma seperated string of enumeration aliases -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String[] values) ``` Sets the enumeration aliases list + **Parameters:** -: `values`- An array of strings +- `values`- An array of strings -- #### getEnumAliases +### getEnumAliases ```java public java.lang.String[] getEnumAliases() ``` An interface function for the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumAliasesStr +### getEnumAliasesStr ```java public java.lang.String getEnumAliasesStr() ``` An interface function for the enumeration array + **Returns:** -: an comma separated string of the possible values of the list +- an comma separated string of the possible values of the list -- #### setFormat +### setFormat ```java public void setFormat(java.lang.String format) ``` Set the format string for the variable + **Specified by:** -: `setFormat`in interface`IPHXFormat` +- `setFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Parameters:** -: `format`- format string +- `format`- format string -- #### getFormat +### getFormat ```java public java.lang.String getFormat() ``` Get the format string for the variable + **Specified by:** -: `getFormat`in interface`IPHXFormat` +- `getFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Returns:** -: format string +- format string -- #### hasFormat +### hasFormat ```java public boolean hasFormat() ``` -Description copied from interface:`IPHXFormat`Whether or not the variable has a format +Description copied from interface: [`IPHXFormat`](IPHXFormat.md) + +Whether or not the variable has a format + **Specified by:** -: `hasFormat`in interface`IPHXFormat` +- `hasFormat` in interface [`IPHXFormat`](IPHXFormat.md) + **Returns:** -: true if variable has a format +- `true` if variable has a format -- #### _setMetaData +### _setMetaData ```java protected void _setMetaData(PHXSimpleType v2) ``` -Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data - in this object. Override this to set additional - information in sub-classes. Be sure to call - super._setMetaData(PHXSimpleType) +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Sets a simple type's meta data based on the meta data in this object. Override this to set additional information in sub-classes. Be sure to call `super._setMetaData(PHXSimpleType)`. + **Overrides:** -: `_setMetaData`in class`PHXSimpleArray` +- `_setMetaData` in class [`PHXSimpleArray`](PHXSimpleArray.md)`<`[`PHXLong`](PHXLong.md)`>` -- #### _getMetaData +### _getMetaData ```java protected void _getMetaData(PHXSimpleType v2) ``` -Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. Override this in order to add - more custom meta data in sub-classes. Be sure to cal - super._getMetaData(PHXSimpleType), though! +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. Override this in order to add more custom meta data in sub-classes. Be sure to call `super._getMetaData(PHXSimpleType)`, though! + **Overrides:** -: `_getMetaData`in class`PHXSimpleArray` +- `_getMetaData` in class [`PHXSimpleArray`](PHXSimpleArray.md)`<`[`PHXLong`](PHXLong.md)`>` -- #### getValue +### getValue ```java public PHXLong getValue(int index) ``` -Gets the value of an element as a PHXLong object +Gets the value of an element as a [`PHXLong`](PHXLong.md) object + **Overrides:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class [`PHXSimpleArray`](PHXSimpleArray.md)`<`[`PHXLong`](PHXLong.md)`>` + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index + **Returns:** -: referenced array value +- referenced array value + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### getValue +### getValue ```java public PHXLong getValue(int[] index) ``` -Gets the value of an element as a PHXLong object +Gets the value of an element as a [`PHXLong`](PHXLong.md) object + **Specified by:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class [`PHXSimpleArray`](PHXSimpleArray.md)`<`[`PHXLong`](PHXLong.md)`>` + **Parameters:** -: `index`- nD array index +- `index`- nD array index + **Returns:** -: referenced array value +- referenced array value -- #### getLongValue +### getLongValue ```java public long getLongValue(int index) ``` Gets the value of an element as a long + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index + **Returns:** -: referenced array value +- referenced array value + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### getLongValue +### getLongValue ```java public long getLongValue(int[] index) ``` Gets the value of an element as a long + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index + **Returns:** -: referenced array value +- referenced array value + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### setValue +### setValue ```java public void setValue(int[] index, PHXLong val) ``` -Sets the value of an element as a PHXLong object +Sets the value of an element as a [`PHXLong`](PHXLong.md) object + **Specified by:** -: `setValue`in class`PHXSimpleArray` +- `setValue` in class [`PHXSimpleArray`](PHXSimpleArray.md)`<`[`PHXLong`](PHXLong.md)`>` + **Parameters:** -: `index`- 1D array index -: `val`- value to set +- `index`- 1D array index +- `val`- value to set + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### setValue +### setValue ```java public void setValue(int index, long val) ``` Sets the value of an element as a PHXLong object + **Parameters:** -: `index`- 1D array index -: `val`- value to set +- `index`- 1D array index +- `val`- value to set + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### setValue +### setValue ```java public void setValue(int[] index, long val) ``` Sets the value of an element as a PHXLong object + **Parameters:** -: `index`- 1D array index -: `val`- value to set +- `index`- 1D array index +- `val`- value to set + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### elementFromString +### elementFromString ```java protected java.lang.Object elementFromString(java.lang.String val) ``` -Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. This is only used when the element type does not - implement IPHXType or IPHXType2. For primitives, return - the wrapper objects. +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. This is only used when the element type does not implement IPHXType or IPHXType2. For primitives, return the wrapper objects. + **Specified by:** -: `elementFromString`in class`PHXSimpleArray` +- `elementFromString` in class [`PHXSimpleArray`](PHXSimpleArray.md)`<`[`PHXLong`](PHXLong.md)`>` -- #### getMax +### getMax ```java public long getMax() ``` -- #### getMin +### getMin ```java public long getMin() ``` -- #### getAvg +### getAvg ```java public double getAvg() ``` -- #### sortReverse +### sortReverse ```java public void sortReverse() ``` -- #### sort +### sort ```java public void sort() ``` -- #### _sort +### _sort ```java public void _sort(PHXLongArray array, boolean ascend) ``` -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md) + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md)- if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Specified by:** -: `Accept`in interface`IPHXType2` +- `Accept` in interface [`IPHXType2`](IPHXType2.md) + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java public PHXLongArray createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md index 63838a59ba..de2e81cd6d 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXMassProperties.md @@ -1,33 +1,29 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXMassProperties -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXMassProperties -- --- +# Class PHXMassProperties + +**Packages:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXMassProperties +``` +--- ```java public class PHXMassProperties extends java.lang.Object ``` -This is a utility class for holding mass property information. The - class is used by the PHXGeomInfo class -**Author:** -: Woyak, 10/98- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +This is a utility class for holding mass property information. The class is used by the PHXGeomInfo class. + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXMassProperties(boolean hasCG, - boolean hasVolume, - boolean hasSurfaceArea, - boolean hasMass)` | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXMassProperties(boolean hasCG, boolean hasVolume, boolean hasSurfaceArea, boolean hasMass)` | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | | `java.lang.String` | `getCG()` | | `double` | `getcgX()` | | `double` | `getcgY()` | @@ -39,9 +35,7 @@ This is a utility class for holding mass property information. The | `double` | `getMass()` | | `double` | `getSurfaceArea()` | | `double` | `getVolume()` | -| `void` | `setCG(double x, - double y, - double z)` | +| `void` | `setCG(double x, double y, double z)` | | `void` | `setcgX(double v)` | | `void` | `setcgY(double v)` | | `void` | `setcgZ(double v)` | @@ -49,11 +43,12 @@ This is a utility class for holding mass property information. The | `void` | `setSurfaceArea(double v)` | | `void` | `setVolume(double v)` | -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object +`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` -- #### PHXMassProperties +## Constructor Detail + +### PHXMassProperties ```java public PHXMassProperties(boolean hasCG, @@ -61,106 +56,106 @@ public PHXMassProperties(boolean hasCG, boolean hasSurfaceArea, boolean hasMass) ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### getcgX +## Method Detail + +### getcgX ```java public double getcgX() ``` -- #### getcgY +### getcgY ```java public double getcgY() ``` -- #### getcgZ +### getcgZ ```java public double getcgZ() ``` -- #### getVolume +### getVolume ```java public double getVolume() ``` -- #### getSurfaceArea +### getSurfaceArea ```java public double getSurfaceArea() ``` -- #### getMass +### getMass ```java public double getMass() ``` -- #### getHasCG +### getHasCG ```java public boolean getHasCG() ``` -- #### getHasVolume +### getHasVolume ```java public boolean getHasVolume() ``` -- #### getHasSurfaceArea +### getHasSurfaceArea ```java public boolean getHasSurfaceArea() ``` -- #### getHasMass +### getHasMass ```java public boolean getHasMass() ``` -- #### setcgX +### setcgX ```java public void setcgX(double v) ``` -- #### setcgY +### setcgY ```java public void setcgY(double v) ``` -- #### setcgZ +### setcgZ ```java public void setcgZ(double v) ``` -- #### setVolume +### setVolume ```java public void setVolume(double v) ``` -- #### setSurfaceArea +### setSurfaceArea ```java public void setSurfaceArea(double v) ``` -- #### setMass +### setMass ```java public void setMass(double v) ``` -- #### setCG +### setCG ```java public void setCG(double x, @@ -168,9 +163,8 @@ public void setCG(double x, double z) ``` -- #### getCG +### getCG ```java public java.lang.String getCG() ``` -========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md index 801b3d4d7f..c549d4bd4b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXNumberFormatException.md @@ -1,44 +1,47 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXNumberFormatException -- java.lang.Object -- - java.lang.Throwable -- - java.lang.Exception -- - com.phoenix_int.aserver.types.PHXNumberFormatException -- **All Implemented Interfaces:** -: java.io.Serializable +# Class PHXNumberFormatException ---- +**Packages:** com.phoenix_int.aserver.types +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.types.PHXNumberFormatException +``` +**All Implemented Interfaces:** +- java.io.Serializable + +--- +**Declaration:** ```java public class PHXNumberFormatException extends java.lang.Exception ``` -Like a NumberFormatException except that it isn't a runtime exception - and must be caught -**Author:** -: Scott Woyak, 10-09 + +Like a `NumberFormatException` except that it isn't a runtime exception and must be caught + **See Also:** -: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.types.PHXNumberFormatException)- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +- [Serialized Form](../../../../serialized-form.md) + +### Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXNumberFormatException(java.lang.String msg)` | -========== METHOD SUMMARY =========== -- ### Method Summary -- ### Methods inherited from class java.lang.Throwable -`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +## Constructor Detail -- #### PHXNumberFormatException +### PHXNumberFormatException ```java public PHXNumberFormatException(java.lang.String msg) ``` -========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md index 4a377dab44..05aab77a18 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXObjectArray.md @@ -1,12 +1,18 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXObjectArray -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) -- - com.phoenix_int.aserver.types.PHXObjectArray -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable +# Class PHXObjectArray + + +**Packages:** `com.phoenix_int.aserver.types` + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXSimpleArray + ↳ com.phoenix_int.aserver.types.PHXObjectArray +``` + + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md), java.lang.Iterable --- @@ -14,222 +20,222 @@ com.phoenix_int.aserver.types public class PHXObjectArray extends PHXSimpleArray ``` -Placeholder for an array of any random Java Object. - This class is useful to keep the system from choking on - random array types, but not designed for customer use. -**Version:** -: Oct 2002 -**Author:** -: Nathan P Sharp + +Placeholder for an array of any random Java Object. This class is useful to keep the system from choking on random array types, but not designed for customer use. + + **See Also:** -: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +- [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) + +## Nested Class Summary -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +## Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 `IPHXType2.IVisitor` -=========== FIELD SUMMARY =========== -- ### Field Summary -- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_data,_lockDims,_lockResize` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_data`, `_lockDims`, `_lockResize` + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXObjectArray()` | | `PHXObjectArray(java.lang.Object data)` | -| `PHXObjectArray(PHXObjectArrayother)`Clone another PHXObjectArray's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXObjectArray(PHXObjectArrayother)`
Clone another PHXObjectArray's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | -| `PHXObjectArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified - class is acceptable as an array element component type. | -| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `PHXSimpleType` | `getValue(int[] index)`Gets the value of an element as an object of the appropriate subtype - Must be overridden in subclasses | -| `void` | `setValue(int[] index,PHXSimpleTypeval)`Sets an element as an object of the appropriate PHXSimpleType - Must be overridden in subclasses | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_getMetaData,_getMetaData,_setMetaData,_setMetaData,checkRectangular,copy,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` - -- ### Methods inherited from interface java.lang.Iterable -`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXObjectArray +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`
Allocates a single element in a default state. | +| `PHXObjectArray` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`
Must override this function and return true if the specified class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`
Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `PHXSimpleType` | `getValue(int[] index)`
Gets the value of an element as an object of the appropriate subtype. Must be overridden in subclasses | +| `void` | `setValue(int[] index,PHXSimpleTypeval)`
Sets an element as an object of the appropriate PHXSimpleType. Must be overridden in subclasses | + +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData`, `_getMetaData`, `_setMetaData`, `_setMetaData`, `checkRectangular`, `copy`, `fromString`, `fromString`, `fromString`, `fromString`, `fromString2`, `generateFor`, `generateFor`, `getArray`, `getArrayElement`, `getArrayElement`, `getComponentType`, `getComponentType`, `getDimensions`, `getDimensions`, `getFirst`, `getLength`, `getLength`, `getLockResize`, `getnDIndex`, `getNumDimensions`, `getNumDimensions`, `getSelf`, `getValue`, `incrementIndex`, `iterator`, `lockDimensions`, `newIndex`, `parseIndex`, `resize`, `setArray`, `setArrayElement`, `setArrayElement`, `setDimensions`, `setFirst`, `setLength`, `setLength`, `setLockResize`, `setValue`, `toString`, `toString`, `toString`, `toString`, `toString2`, `toString2`, `toString2`, `validElement` + +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +### Methods inherited from interface java.lang.Iterable +`forEach`, `spliterator` + +## Constructor Detail + +### PHXObjectArray ```java public PHXObjectArray() ``` -- #### PHXObjectArray +### PHXObjectArray ```java public PHXObjectArray(java.lang.Object data) ``` -- #### PHXObjectArray +### PHXObjectArray ```java public PHXObjectArray(PHXObjectArray other) ``` Clone another PHXObjectArray's value and metadata. + **Parameters:** -: `other`- the other PHXObjectArray to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other`- the other PHXObjectArray to clone. + +## Method Detail -- #### dataTypeOK +### dataTypeOK ```java protected boolean dataTypeOK(java.lang.Class c) ``` -Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified - class is acceptable as an array element component type. +Description copied from class: `PHXSimpleArray`. Must override this function and return true if the specified class is acceptable as an array element component type. + **Specified by:** -: `dataTypeOK`in class`PHXSimpleArray` +- `dataTypeOK` in class `PHXSimpleArray` -- #### allocateElement +### allocateElement ```java protected java.lang.Object allocateElement(java.lang.Class elementClass) throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Description copied from class:`PHXSimpleArray`Allocates a single element in a default state. - If the class type in question has a default constructor, - there is no need to override this. +Description copied from class: `PHXSimpleArray`. Allocates a single element in a default state. If the class type in question has a default constructor, there is no need to override this. + **Overrides:** -: `allocateElement`in class`PHXSimpleArray` +- `allocateElement` in class `PHXSimpleArray` + **Throws:** -: `java.lang.IllegalAccessException` +- `java.lang.IllegalAccessException` : `java.lang.InstantiationException` -- #### elementFromString +### elementFromString ```java protected java.lang.Object elementFromString(java.lang.String val) ``` -Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. This is only used when the element type does not - implement IPHXType or IPHXType2. For primitives, return - the wrapper objects. +Description copied from class: `PHXSimpleArray`. Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. This is only used when the element type does not implement [IPHXType](IPHXType.md) or [IPHXType2](IPHXType2). For primitives, return the wrapper objects. + **Specified by:** -: `elementFromString`in class`PHXSimpleArray` +- `elementFromString` in class `PHXSimpleArray` -- #### equalsNatural +### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. Array comparison is handled as follows: + 1) Compare the number of dimensions between the two arrays 2) Compare the length of dimensions between the two arrays 3) Compare the values in each of the two arrays - Iff these three conditions are met, the two arrays are considered naturally equal. + + If these three conditions are met, the two arrays are considered naturally equal. + **Overrides:** -: `equalsNatural`in class`PHXSimpleArray` +- `equalsNatural` in class `PHXSimpleArray` + **Parameters:** -: `toCompare`- +- `toCompare`- + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than toCompare, a positive number if this object is greater than to compare, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [PHXInvalidTypeException](PHXInvalidTypeException.md) + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class `PHXSimpleType` + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md)- if the specified object is of an invalid type or there is an error in conversion. -- #### getValue +### getValue ```java public PHXSimpleType getValue(int[] index) ``` -Gets the value of an element as an object of the appropriate subtype - Must be overridden in subclasses +Gets the value of an element as an object of the appropriate subtype. Must be overridden in subclasses + **Specified by:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class `PHXSimpleArray` + **Parameters:** -: `index`- nD array index +- `index`- nD array index + **Returns:** -: referenced array value +- referenced array value -- #### setValue +### setValue ```java public void setValue(int[] index, PHXSimpleType val) ``` -Sets an element as an object of the appropriate PHXSimpleType - Must be overridden in subclasses +Sets an element as an object of the appropriate [PHXSimpleType](PHXSimpleType.md). Must be overridden in subclasses + **Specified by:** -: `setValue`in class`PHXSimpleArray` +- `setValue` in class `PHXSimpleArray` + **Parameters:** -: `index`- nD array index +- `index`- nD array index : `val`- value to set -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java public PHXObjectArray createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class `PHXSimpleType` + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md index 4694e2fb6f..eb31efa0ab 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXOrientation.md @@ -1,31 +1,32 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXOrientation -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXOrientation -- --- +# Class PHXOrientation + +**Packages:** `com.phoenix_int.aserver.types` + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXOrientation +``` +--- + +**Declaration:** ```java public class PHXOrientation extends java.lang.Object ``` -This is a utility class for holding orientation information. The - class is used as one of the parts of the PHXGeomInfo class -**Author:** -: Woyak, 10/98- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +This is a utility class for holding orientation information. The class is used as one of the parts of the [PHXGeomInfo](PHXGeomInfo.md) class + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXOrientation(boolean hasRotation, - boolean hasTranslation)` | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXOrientation(boolean hasRotation, boolean hasTranslation)` | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | | `boolean` | `getHasRotation()` | | `boolean` | `getHasTranslation()` | | `double` | `getRotX()` | @@ -41,11 +42,12 @@ This is a utility class for holding orientation information. The | `void` | `setTransY(double v)` | | `void` | `setTransZ(double v)` | -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` -- #### PHXOrientation +## Constructor Detail + +### PHXOrientation ```java public PHXOrientation(boolean hasRotation, @@ -53,92 +55,91 @@ public PHXOrientation(boolean hasRotation, ``` **Parameters:** -: `hasRotation`- true if the object uses the rotation variables -: `hasTranslation`- true if the object uses the translation variables -============ METHOD DETAIL ========== -- ### Method Detail +- `hasRotation`- true if the object uses the rotation variables +- `hasTranslation`- true if the object uses the translation variables + +## Method Detail -- #### getRotX +### getRotX ```java public double getRotX() ``` -- #### getRotY +### getRotY ```java public double getRotY() ``` -- #### getRotZ +### getRotZ ```java public double getRotZ() ``` -- #### getHasRotation +### getHasRotation ```java public boolean getHasRotation() ``` -- #### getTransX +### getTransX ```java public double getTransX() ``` -- #### getTransY +### getTransY ```java public double getTransY() ``` -- #### getTransZ +### getTransZ ```java public double getTransZ() ``` -- #### getHasTranslation +### getHasTranslation ```java public boolean getHasTranslation() ``` -- #### setRotX +### setRotX ```java public void setRotX(double v) ``` -- #### setRotY +### setRotY ```java public void setRotY(double v) ``` -- #### setRotZ +### setRotZ ```java public void setRotZ(double v) ``` -- #### setTransX +### setTransX ```java public void setTransX(double v) ``` -- #### setTransY +### setTransY ```java public void setTransY(double v) ``` -- #### setTransZ +### setTransZ ```java public void setTransZ(double v) ``` -========= END OF CLASS DATA ========= \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md index 5fb6cf7453..adc3e1a1cb 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFile.md @@ -1,11 +1,15 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXRawFile +# Class PHXRawFile + + +**Packages:** `com.phoenix_int.aserver.types` +``` - java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) +- - com.phoenix_int.aserver.types.PHXSimpleType - - com.phoenix_int.aserver.types.PHXRawFile -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.AutoCloseable +``` + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md), java.lang.AutoCloseable --- @@ -14,389 +18,352 @@ public class PHXRawFile extends PHXSimpleType implements IPHXType2, java.lang.AutoCloseable ``` -The Phoenix type for Files. The working contents of the file are kept in a temporary file on - disk, where changes are made before they are manually synced to the actual file. Read the - documentation for each method to make sure it is doing what you expect it to. +The ModelCenter type for Files. The working contents of the file are kept in a temporary file on disk, where changes are made before they are manually synced to the actual file. Read the documentation for each method to make sure it is doing what you expect it to. - The temporary file containing the contents can optionally be maintained by calling[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--). +The temporary file containing the contents can optionally be maintained by calling `unmanageTempFile()`. - In that case, calling code becomes responsible for deleting the contents of the file. -**Author:** -: Woyak, 9/98- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +In that case, calling code becomes responsible for deleting the contents of the file. + +## Nested Class Summary -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXRawFile()` | -| `PHXRawFile(PHXRawFileother)`Clone another PHXRawFile's value and metadata. | +| `PHXRawFile(PHXRawFileother)`
Clone another PHXRawFile's value and metadata. | | `PHXRawFile(java.lang.String fileName)` | -| `PHXRawFile(java.lang.String baseName, - java.lang.String name)` | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXRawFile(java.lang.String baseName, java.lang.String name)` | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | | `protected void` | `_setContentFromOther(PHXRawFilevariable)` | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `void` | `addMonitor(PHXFileMonitorfm)`PHXFileMonitor is used to monitor changes to a file - as it is being created as in the UNIX 'tail -f' - command. | -| `void` | `backupFile()`Backup the actual file on disk. | -| `void` | `backupFile(java.lang.String fileName)`Backup the actual file on disk. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `void` | `addMonitor(PHXFileMonitorfm)`
PHXFileMonitor is used to monitor changes to a file as it is being created as in the UNIX `tail -f` command. | +| `void` | `backupFile()`
Backup the actual file on disk. | +| `void` | `backupFile(java.lang.String fileName)`
Backup the actual file on disk. | | `void` | `close()` | -| `PHXRawFile` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `void` | `deleteContents()`Releases the handle to the temporary file. | -| `void` | `deleteFile()`Deletes the actual file from disk. | -| `void` | `deleteFile(java.lang.String fileName)`Deletes the actual file from disk. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `protected void` | `finalize()`Although close should be called manually before garbage collection, do so here as a backup. | -| `void` | `fromAPIObject(java.util.Map object, - com.phoenix_int.functional.FunctionThrows fileStore)`Populate this instance from a string-string map. | -| `void` | `fromFile()`Loads the contents of the actual file on disk into the temporary file. | -| `void` | `fromFile(java.lang.String filename)`Sets the filename and then loads the contents of the actual file on disk into the temporary - file. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`Sets the file temporary file contents to the value of the string. | -| `void` | `fromString2(PHXStringBuffernewContents)`Sets the file temporary file contents to the value of the PHXStringBuffer. | -| `java.lang.String` | `getBaseName()`gets the base name of the file | -| `java.lang.String` | `getContents()`Retrieves the contents of the temporary file. | -| `java.nio.charset.Charset` | `getEncoding()`Get the encoding of the contents. | +| `PHXRawFile` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `void` | `deleteContents()`
Releases the handle to the temporary file. | +| `void` | `deleteFile()`
Deletes the actual file from disk. | +| `void` | `deleteFile(java.lang.String fileName)`
Deletes the actual file from disk. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `protected void` | `finalize()`
Although close should be called manually before garbage collection, do so here as a backup. | +| `void` | `fromAPIObject(java.util.Map object, com.phoenix_int.functional.FunctionThrows fileStore)`
Populate this instance from a string-string map. | +| `void` | `fromFile()`
Loads the contents of the actual file on disk into the temporary file. | +| `void` | `fromFile(java.lang.String filename)`
Sets the filename and then loads the contents of the actual file on disk into the temporary file. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
Sets the file temporary file contents to the value of the string. | +| `void` | `fromString2(PHXStringBuffernewContents)`
Sets the file temporary file contents to the value of the PHXStringBuffer. | +| `java.lang.String` | `getBaseName()`
gets the base name of the file | +| `java.lang.String` | `getContents()`
Retrieves the contents of the temporary file. | +| `java.nio.charset.Charset` | `getEncoding()`
Get the encoding of the contents. | | `java.lang.String` | `getFileExtension()`Returns the extension of the file that this object represents | -| `java.util.UUID` | `getID()`Get the ID set on this file when the contents were set. | -| `boolean` | `getIsBinary()`Tells whether or not the the file is binary. | +| `java.util.UUID` | `getID()`
Get the ID set on this file when the contents were set. | +| `boolean` | `getIsBinary()`
Tells whether or not the the file is binary. | | `java.lang.String` | `getMimeType()` | -| `java.lang.String` | `getName()`retrieves the name of the file | -| `java.lang.String` | `getNameCoded()`retrieves the name of the file in coded form (without $variables - replaced) | -| `java.io.File` | `getTemporaryFile()`Get the current temporary file; if _needRead is true this will load the contents from the - actual file into the temporary. | -| `com.phoenix_int.util.ManagedFileHandle` | `getTemporaryFileHandle()`Get an additional reference to the temporary file containing the current value, or null if there is no temp file currently. | -| `java.lang.String` | `getURL()`Tells whether the file is meant to be transferred by proxy | -| `java.io.InputStream` | `getValueStream()`Deprecated.using toString2().getInputStream() is prefered. | -| `long` | `getValueStreamLen()`Gets the length of a stream to the temporary file contents. | -| `boolean` | `hasChanged()`Checks to see if the actual file has changed since the last time getContents() was called. | -| `void` | `markAsRead()`Call this function after you manually get the contents of the actual file. | -| `void` | `readFile()`Loads the contents of the actual file on disk into the temporary file. | -| `void` | `readFile(boolean useDFT)`Loads the contents of the actual file on disk into the temporary file. | -| `void` | `readFile(java.lang.String filename)`Sets the filename and then loads the contents of the actual file on disk into the temporary - file. | -| `void` | `removeMonitor(PHXFileMonitorfm)`Removes a file monitor from our list | -| `void` | `setBaseName(java.lang.String v)`sets the base name of the file | -| `void` | `setContents(java.io.File tempFile)`Sets the contents of the temporary file to an existing file. | -| `void` | `setContents(java.io.File tempFile, - java.util.UUID newId, - java.lang.String mimeType, - java.nio.charset.Charset encoding)`Sets the contents of the temporary file to an existing file. | -| `void` | `setContents(com.phoenix_int.util.ManagedFileHandle tempFile, - java.util.UUID newId, - java.lang.String mimeType, - java.nio.charset.Charset encoding)`Sets the contents of the temporary file to an existing ManagedFileHandle. | -| `void` | `setContents(PHXStringBuffercontents)`Sets the contents of the temporary file. | -| `void` | `setContents(java.lang.String contents)`Sets the contents of the temporary file. | -| `void` | `setFileExtension(java.lang.String extension)`Sets the extension of the file that this object represents. | -| `void` | `setIsBinary(boolean m)`Forces this file to be binary or not. | +| `java.lang.String` | `getName()`
retrieves the name of the file | +| `java.lang.String` | `getNameCoded()`
retrieves the name of the file in coded form (without `$variables` replaced) | +| `java.io.File` | `getTemporaryFile()`
Get the current temporary file; if `_needRead` is `true` this will load the contents from the actual file into the temporary. | +| `com.phoenix_int.util.ManagedFileHandle` | `getTemporaryFileHandle()`
Get an additional reference to the temporary file containing the current value, or null if there is no temp file currently. | +| `java.lang.String` | `getURL()`
Tells whether the file is meant to be transferred by proxy | +| `java.io.InputStream` | `getValueStream()`
**Deprecated.** using `toString2().getInputStream()` is prefered. | +| `long` | `getValueStreamLen()`
Gets the length of a stream to the temporary file contents. | +| `boolean` | `hasChanged()`
Checks to see if the actual file has changed since the last time getContents() was called. | +| `void` | `markAsRead()`
Call this function after you manually get the contents of the actual file. | +| `void` | `readFile()`
Loads the contents of the actual file on disk into the temporary file. | +| `void` | `readFile(boolean useDFT)`
Loads the contents of the actual file on disk into the temporary file. | +| `void` | `readFile(java.lang.String filename)`
Sets the filename and then loads the contents of the actual file on disk into the temporary file. | +| `void` | `removeMonitor(PHXFileMonitorfm)`
Removes a file monitor from our list | +| `void` | `setBaseName(java.lang.String v)`
sets the base name of the file | +| `void` | `setContents(java.io.File tempFile)`
Sets the contents of the temporary file to an existing file. | +| `void` | `setContents(java.io.File tempFile, java.util.UUID newId, java.lang.String mimeType, java.nio.charset.Charset encoding)`
Sets the contents of the temporary file to an existing file. | +| `void` | `setContents(com.phoenix_int.util.ManagedFileHandle tempFile, java.util.UUID newId, java.lang.String mimeType, java.nio.charset.Charset encoding)`
Sets the contents of the temporary file to an existing ManagedFileHandle. | +| `void` | `setContents(PHXStringBuffercontents)`
Sets the contents of the temporary file. | +| `void` | `setContents(java.lang.String contents)`
Sets the contents of the temporary file. | +| `void` | `setFileExtension(java.lang.String extension)`
Sets the extension of the file that this object represents. | +| `void` | `setIsBinary(boolean m)`
Forces this file to be binary or not. | | `void` | `setMetaData(PHXRawFilemetaData)` | | `void` | `setMimeType(java.lang.String m)` | -| `void` | `setName(java.lang.String v)`sets the name of the file | +| `void` | `setName(java.lang.String v)`
sets the name of the file | | `void` | `setNeedWrite(boolean needWrite)` | -| `void` | `setStringReplacer(PHXStringReplacerr)`specifies a PHXStringReplacer object for use in forming the - full file name. | -| `void` | `setURL(java.lang.String url)`sets whether the file is meant to be transferred by proxy or not | -| `boolean` | `synched()`Is this file variable's value consistent with the actual file on disk? | -| `java.util.Map` | `toAPIObject(com.phoenix_int.functional.FunctionThrows fileStore)`Convert this instance to a string-string map appropriate for serialization. | -| `void` | `toFile()`Writes from the temp file to the actual file. | -| `void` | `toFile(java.lang.String fileName)`Sets the filename and then writes from the temp file to the actual file. | -| `java.lang.String` | `toString()`converts the variable to a string | -| `PHXStringBuffer` | `toString2()`Gets a PHXStringBuffer representation of the contents of the temporary file. | -| `void` | `unmanageTempFile()`Ensure that the file containing the current contents is not deleted when the last handle to it is released. | -| `void` | `writeFile()`Writes from the temp file to the actual file. | -| `void` | `writeFile(java.lang.String fileName)`Sets the filename and then writes from the temp file to the actual file. | +| `void` | `setStringReplacer(PHXStringReplacerr)`
specifies a PHXStringReplacer object for use in forming the full file name. | +| `void` | `setURL(java.lang.String url)`
sets whether the file is meant to be transferred by proxy or not | +| `boolean` | `synched()`
Is this file variable's value consistent with the actual file on disk? | +| `java.util.Map` | `toAPIObject(com.phoenix_int.functional.FunctionThrows fileStore)`
Convert this instance to a string-string map appropriate for serialization. | +| `void` | `toFile()`
Writes from the temp file to the actual file. | +| `void` | `toFile(java.lang.String fileName)`
Sets the filename and then writes from the temp file to the actual file. | +| `java.lang.String` | `toString()`
converts the variable to a string | +| `PHXStringBuffer` | `toString2()`
Gets a PHXStringBuffer representation of the contents of the temporary file. | +| `void` | `unmanageTempFile()`
Ensure that the file containing the current contents is not deleted when the last handle to it is released. | +| `void` | `writeFile()`
Writes from the temp file to the actual file. | +| `void` | `writeFile(java.lang.String fileName)`
Sets the filename and then writes from the temp file to the actual file. | + +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` +### Methods inherited from class java.lang.Object +`clone`, `equals`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- ### Methods inherited from class java.lang.Object -`clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Constructor Detail -- #### PHXRawFile +### PHXRawFile ```java public PHXRawFile() ``` -- #### PHXRawFile +### PHXRawFile ```java public PHXRawFile(java.lang.String fileName) ``` -- #### PHXRawFile +### PHXRawFile ```java public PHXRawFile(java.lang.String baseName, java.lang.String name) ``` -- #### PHXRawFile +### PHXRawFile ```java public PHXRawFile(PHXRawFile other) ``` Clone another PHXRawFile's value and metadata. + **Parameters:** -: `other`- the other PHXRawFile to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other` - the other PHXRawFile to clone. -- #### getName +### Method Detail + +### getName ```java public java.lang.String getName() ``` retrieves the name of the file + **Returns:** -: the name of the file +- the name of the file -- #### getID +### getID ```java public java.util.UUID getID() ``` -Get the ID set on this file when the contents were set. - Reading the same contents does not guarantee that the ID will be the same. +Get the ID set on this file when the contents were set. Reading the same contents does not guarantee that the ID will be the same. + **Returns:** -: the ID +- the ID -- #### addMonitor +### addMonitor ```java public void addMonitor(PHXFileMonitor fm) ``` -PHXFileMonitor is used to monitor changes to a file - as it is being created as in the UNIX 'tail -f' - command. Unfortunately in Windows, this creates - a file lock which prevents deleting the file. - Therefore, we keep a list of all the monitors - currently monitoring us, and we signal them - anytime that our filename or base name changes - so they can stop monitoring. +PHXFileMonitor is used to monitor changes to a file as it is being created as in the UNIX `tail -f` command. Unfortunately in Windows, this creates a file lock which prevents deleting the file. Therefore, we keep a list of all the monitors currently monitoring us, and we signal them anytime that our filename or base name changes so they can stop monitoring. -- #### removeMonitor +### removeMonitor ```java public void removeMonitor(PHXFileMonitor fm) ``` Removes a file monitor from our list -- #### synched +### synched ```java public boolean synched() ``` Is this file variable's value consistent with the actual file on disk? -- #### setNeedWrite +### setNeedWrite ```java public void setNeedWrite(boolean needWrite) ``` -- #### setURL +### setURL ```java public void setURL(java.lang.String url) ``` sets whether the file is meant to be transferred by proxy or not + **Parameters:** -: `url`- the new URL +- `url` - the new URL -- #### getNameCoded +### getNameCoded ```java public java.lang.String getNameCoded() ``` -retrieves the name of the file in coded form (without $variables - replaced) +retrieves the name of the file in coded form (without `$variables` replaced) + **Returns:** -: the name of the file in coded form +- the name of the file in coded form -- #### getFileExtension +### getFileExtension ```java public java.lang.String getFileExtension() ``` Returns the extension of the file that this object represents -- #### unmanageTempFile +### unmanageTempFile ```java public void unmanageTempFile() ``` -Ensure that the file containing the current contents is not deleted when the last handle to it is released. - Note that the contents can be reset by[setContents(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setContents-java.lang.String-),[setName(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setName-java.lang.String-)and[readFile(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#readFile-java.lang.String-)= - overloads. This function affects only the current contents. Once the contents are changed, they are stored in a different temp file. - That file will receive separate tracking and may be deleted unless this function is called again. +Ensure that the file containing the current contents is not deleted when the last handle to it is released. Note that the contents can be reset by `setContents(java.lang.String)`, `setName(java.lang.String)` and `readFile(java.lang.String)` = overloads. This function affects only the current contents. Once the contents are changed, they are stored in a different temp file. That file will receive separate tracking and may be deleted unless this function is called again. -- #### setFileExtension +### setFileExtension ```java public void setFileExtension(java.lang.String extension) throws java.io.IOException ``` -Sets the extension of the file that this object represents. -It is preferred that you use setName() and let the system automatically - figure out the extension based on what you pass in. Then, you can - use readFile() and writeFile() without passing filenames to those - calls. This allows for progress monitoring to work correctly in - all cases. +Sets the extension of the file that this object represents. It is preferred that you use `setName()` and let the system automatically figure out the extension based on what you pass in. Then, you can use `readFile()` and `writeFile()` without passing filenames to those calls. This allows for progress monitoring to work correctly in all cases. + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setName +### setName ```java public void setName(java.lang.String v) throws java.io.IOException ``` sets the name of the file + **Parameters:** -: `v`- the name +- `v` - the name + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setBaseName +### setBaseName ```java public void setBaseName(java.lang.String v) throws java.io.IOException ``` sets the base name of the file + **Parameters:** -: `v`- the name +- `v` - the name + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### getBaseName +### getBaseName ```java public java.lang.String getBaseName() ``` gets the base name of the file + **Returns:** -: the name +- the name -- #### setStringReplacer +### setStringReplacer ```java public void setStringReplacer(PHXStringReplacer r) ``` -specifies a PHXStringReplacer object for use in forming the - full file name. +specifies a PHXStringReplacer object for use in forming the full file name. + **Parameters:** -: `r`- the string replacer object +- `r` - the string replacer object -- #### getIsBinary +### getIsBinary ```java public boolean getIsBinary() ``` -Tells whether or not the the file is binary. - Simply switches on whether or not the mime type starts - with text. +Tells whether or not the the file is binary. Simply switches on whether or not the mime type starts with text. -- #### getURL +### getURL ```java public java.lang.String getURL() ``` Tells whether the file is meant to be transferred by proxy -- #### setIsBinary +### setIsBinary ```java public void setIsBinary(boolean m) ``` -Forces this file to be binary or not. - If this causes the mode to change, will set the - mime type to text/plain or application/octet-stream +Forces this file to be binary or not. If this causes the mode to change, will set the mime type to `text/plain` or `application/octet-stream` as appropriate. -- #### getMimeType +### getMimeType ```java public java.lang.String getMimeType() ``` -- #### setMimeType +### setMimeType ```java public void setMimeType(java.lang.String m) ``` -- #### setContents +### setContents ```java public void setContents(java.lang.String contents) throws java.io.IOException ``` -Sets the contents of the temporary file. The actual file is not modified until the - writeFile() method is issued. Remember that when dealing with text files, setContents - handles Java style strings, which must be in bare LF, or Unix style newline format. - In binary format, setContents should be the base64 encoded data. +Sets the contents of the temporary file. The actual file is not modified until the `writeFile()` method is issued. Remember that when dealing with text files, `setContents` handles Java style strings, which must be in bare LF, or Unix style newline format. In binary format, `setContents` should be the base64 encoded data. - The handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +The handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. + **Parameters:** -: `contents`- the contents of the file +- `contents` - the contents of the file + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setContents +### setContents ```java public void setContents(PHXStringBuffer contents) throws java.io.IOException ``` -Sets the contents of the temporary file. The actual file is not modified until the - writeFile() method is issued. Remember that when dealing with text files, setContents - handles Java style strings, which must be in bare LF, or Unix style newline format. - In binary format, setContents should be the base64 encoded data. +Sets the contents of the temporary file. The actual file is not modified until the `writeFile()` method is issued. Remember that when dealing with text files, `setContents` handles Java style strings, which must be in bare LF, or Unix style newline format. In binary format, `setContents` should be the base64 encoded data. - The handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. + The handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. + **Parameters:** -: `contents`- the contents of the file +- `contents` - the contents of the file + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setContents +### setContents ```java public void setContents(java.io.File tempFile) ``` -Sets the contents of the temporary file to an existing file. The actual file is not modified - until the writeFile() method is issued. +Sets the contents of the temporary file to an existing file. The actual file is not modified until the `writeFile()` method is issued. - The specified file is placed into a new`ManagedFileHandle`. +The specified file is placed into a new `ManagedFileHandle`. - The handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +The handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. + **Parameters:** -: `tempFile`- the temp file holding with the desired contents already on disk +- `tempFile` - the temp file holding with the desired contents already on disk -- #### setContents +### setContents ```java public void setContents(java.io.File tempFile, @@ -404,22 +371,19 @@ public void setContents(java.io.File tempFile, java.lang.String mimeType, java.nio.charset.Charset encoding) ``` -Sets the contents of the temporary file to an existing file. The actual file is not modified - until the writeFile() method is issued. +Sets the contents of the temporary file to an existing file. The actual file is not modified until the `writeFile()` method is issued. - The specified file is placed into a new`ManagedFileHandle`. +The specified file is placed into a new`ManagedFileHandle`. - The handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +The handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. + **Parameters:** -: `tempFile`- the temp file holding with the desired contents already on disk -: `newId`- the new ID to set. - This will typically be a new UUID (you may use[setContents(java.io.File)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setContents-java.io.File-)for convenience) -: `mimeType`- the mimetype of the contents, if known (may be null) -: `encoding`- the encoding of the file, if known +- `tempFile` - the temp file holding with the desired contents already on disk +- `newId` - the new ID to set. This will typically be a new UUID (you may use `setContents(java.io.File)` for convenience) +- `mimeType` - the mimetype of the contents, if known (may be null) +- `encoding` - the encoding of the file, if known -- #### setContents +### setContents ```java public void setContents(com.phoenix_int.util.ManagedFileHandle tempFile, @@ -427,182 +391,169 @@ public void setContents(com.phoenix_int.util.ManagedFileHandle tempFile, java.lang.String mimeType, java.nio.charset.Charset encoding) ``` -Sets the contents of the temporary file to an existing ManagedFileHandle. The actual file is not modified - until the writeFile() method is issued. +Sets the contents of the temporary file to an existing ManagedFileHandle. The actual file is not modified until the `writeFile()` method is issued. - A new reference to the specified`ManagedFileHandle`is created. The reference is released when the instance - is closed,[deleteContents()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#deleteContents--)is called, or the contents are replaced by another[setContents(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#setContents-java.lang.String-)overload. +A new reference to the specified `ManagedFileHandle` is created. The reference is released when the instance is closed, `deleteContents()` is called, or the contents are replaced by another `setContents(java.lang.String)` overload. + **Parameters:** -: `tempFile`- a handle to a temporary file containing the value for the variable. - This may be null for files with no contents. -: `newId`- the new ID to set. This will typically be a new random UUID, unless these contents are being - transferred from another PHXRawFile or similar structure which has maintained the ID. -: `mimeType`- the mimetype of the contents, if known (may be null) -: `encoding`- the encoding of the contents, if known (may be null if unknown or the file is not text) +- `tempFile` - a handle to a temporary file containing the value for the variable. This may be null for files with no contents. +- `newId` - the new ID to set. This will typically be a new random UUID, unless these contents are being transferred from another PHXRawFile or similar structure which has maintained the ID. +- `mimeType` - the mimetype of the contents, if known (may be null) +- `encoding` - the encoding of the contents, if known (may be null if unknown or the file is not text) -- #### getEncoding +### getEncoding ```java public java.nio.charset.Charset getEncoding() ``` -Get the encoding of the contents. - This function may return null if the encoding of the contents is unknown, - or if the contents are binary and not text-based. +Get the encoding of the contents. This function may return null if the encoding of the contents is unknown, or if the contents are binary and not text-based. + **Returns:** -: the encoding of the contents, if applicable and known +- the encoding of the contents, if applicable and known -- #### getContents +### getContents ```java public java.lang.String getContents() throws java.io.IOException ``` -Retrieves the contents of the temporary file. If _needRead is true this will load the - contents from the actual file into the temporary file. +Retrieves the contents of the temporary file. If `_needRead` is `true`, this will load the contents from the actual file into the temporary file. + **Returns:** -: the contents of the file, or an empty string if no file exists. +- the contents of the file, or an empty string if no file exists. + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### getTemporaryFile +### getTemporaryFile ```java public java.io.File getTemporaryFile() throws java.io.IOException ``` -Get the current temporary file; if _needRead is true this will load the contents from the - actual file into the temporary. +Get the current temporary file; if `_needRead` is `true` this will load the contents from the actual file into the temporary. + **Returns:** -: the file, or null if there are no contents +- the file, or null if there are no contents + **Throws:** -: `java.io.IOException`- on error +- `java.io.IOException` - on error -- #### getTemporaryFileHandle +### getTemporaryFileHandle ```java public com.phoenix_int.util.ManagedFileHandle getTemporaryFileHandle() ``` -Get an additional reference to the temporary file containing the current value, or null if there is no temp file currently. - Note that, according to the convention for`ManagedFileHandle`, the caller receives the results of`ManagedFileHandle.createNewReference()`, and is responsible for calling`ManagedFileHandle.close()`. +Get an additional reference to the temporary file containing the current value, or null if there is no temp file currently. Note that, according to the convention for `ManagedFileHandle`, the caller receives the results of `ManagedFileHandle.createNewReference()`, and is responsible for calling `ManagedFileHandle.close()`. + **Returns:** -: an additional reference to the temporary file handle, or null if no temporary file is in use +- an additional reference to the temporary file handle, or null if no temporary file is in use -- #### fromFile +### fromFile ```java public void fromFile(java.lang.String filename) throws java.io.IOException ``` -Sets the filename and then loads the contents of the actual file on disk into the temporary - file. It is preferred that you use setName() when you create a PHXRawFile and then - use readFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. +Sets the filename and then loads the contents of the actual file on disk into the temporary file. It is preferred that you use `setName()` when you create a PHXRawFile and then use `readFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + +The handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. - The handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException` - thrown if the file can't be loaded. -- #### readFile +### readFile ```java public void readFile(java.lang.String filename) throws java.io.IOException ``` -Sets the filename and then loads the contents of the actual file on disk into the temporary - file. It is preferred that you use setName() when you create a PHXRawFile and then - use readFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. +Sets the filename and then loads the contents of the actual file on disk into the temporary file. It is preferred that you use `setName()` when you create a PHXRawFile and then use `readFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + +The handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. - The handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException` - thrown if the file can't be loaded. -- #### fromFile +### fromFile ```java public void fromFile() throws java.io.IOException ``` -Loads the contents of the actual file on disk into the temporary file. Functionally equivalent - to readFile(). +Loads the contents of the actual file on disk into the temporary file. Functionally equivalent to `readFile()`. - The handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +The handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException` - thrown if the file can't be loaded. -- #### readFile +### readFile ```java public void readFile(boolean useDFT) throws java.io.IOException ``` Loads the contents of the actual file on disk into the temporary file. + **Parameters:** -: `useDFT`- If true, the file won't really be read but instead its - existence will be verified and a flag set. +- `useDFT` - If true, the file won't really be read but instead its existence will be verified and a flag set. - If the file is read, the handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +If the file is read, the handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException` - thrown if the file can't be loaded. -- #### deleteFile +### deleteFile ```java public void deleteFile(java.lang.String fileName) throws java.io.IOException ``` Deletes the actual file from disk. Does not affect the temporary file. + **Parameters:** -: `fileName`- the file to delete +- `fileName` - the file to delete + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### deleteFile +### deleteFile ```java public void deleteFile() ``` Deletes the actual file from disk. Does not affect the temporary file. -- #### deleteContents +### deleteContents ```java public void deleteContents() ``` -Releases the handle to the temporary file. This may delete the file if nobody else is holding a ManagedFileHandle. +Releases the handle to the temporary file. This may delete the file if nobody else is holding a `ManagedFileHandle`. -- #### backupFile +### backupFile ```java public void backupFile(java.lang.String fileName) throws java.io.IOException ``` -Backup the actual file on disk. File is at the same location with ".bac" - appended to the end. If a file by that name already exists, it is deleted - prior to moving. +Backup the actual file on disk. File is at the same location with ".bac" appended to the end. If a file by that name already exists, it is deleted prior to moving. + **Parameters:** -: `fileName`- the file to backup +- `fileName` - the file to backup + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### backupFile +### backupFile ```java public void backupFile() ``` -Backup the actual file on disk. File is at the same location with ".bac" - appended to the end. If a file by that name already exists, it is deleted - prior to moving. +Backup the actual file on disk. File is at the same location with ".bac" appended to the end. If a file by that name already exists, it is deleted prior to moving. -- #### readFile +### readFile ```java public void readFile() @@ -610,116 +561,121 @@ public void readFile() ``` Loads the contents of the actual file on disk into the temporary file. - If the file is read, the handle to the previous contents is released, - potentially deleting it if no other references are being held. - Because the contents are reset, you may need to call[unmanageTempFile()](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#unmanageTempFile--)again. +If the file is read, the handle to the previous contents is released, potentially deleting it if no other references are being held. Because the contents are reset, you may need to call `unmanageTempFile()` again. + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException` - thrown if the file can't be loaded. -- #### markAsRead +### markAsRead ```java public void markAsRead() ``` -Call this function after you manually get the contents of the actual file. The function - records it's name and timestamp for use with the hasChanged() function. +Call this function after you manually get the contents of the actual file. The function records its name and timestamp for use with the `hasChanged()` function. -- #### hasChanged +### hasChanged ```java public boolean hasChanged() ``` -Checks to see if the actual file has changed since the last time getContents() was called. +Checks to see if the actual file has changed since the last time `getContents()` was called. + **Returns:** -: true if the timestamp of the file is new, or if the file name has changed +- `true` if the timestamp of the file is new, or if the file name has changed -- #### toFile +### toFile ```java public void toFile(java.lang.String fileName) throws java.io.IOException ``` -Sets the filename and then writes from the temp file to the actual file. It is preferred - that you use setName() when you create a PHXRawFile and then - use writeFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. +Sets the filename and then writes from the temp file to the actual file. It is preferred that you use `setName()` when you create a PHXRawFile and then use `writeFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException` - thrown if the file can't be written. -- #### writeFile +### writeFile ```java public void writeFile(java.lang.String fileName) throws java.io.IOException ``` -Sets the filename and then writes from the temp file to the actual file. It is preferred - that you use setName() when you create a PHXRawFile and then - use writeFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. +Sets the filename and then writes from the temp file to the actual file. It is preferred that you use `setName()` when you create a PHXRawFile and then use `writeFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException` - thrown if the file can't be written. -- #### toFile +### toFile ```java public void toFile() throws java.io.IOException ``` Writes from the temp file to the actual file. + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException` - thrown if the file can't be written. -- #### writeFile +### writeFile ```java public void writeFile() throws java.io.IOException ``` Writes from the temp file to the actual file. + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException` - thrown if the file can't be written. -- #### getValueStreamLen +### getValueStreamLen ```java public long getValueStreamLen() throws java.io.IOException ``` Gets the length of a stream to the temporary file contents. + **Returns:** -: The length of a stream returned by the getValueStream method. +- The length of a stream returned by the `getValueStream` method. + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### getValueStream +### getValueStream ```java @Deprecated public java.io.InputStream getValueStream() throws java.io.IOException ``` -Deprecated.using toString2().getInputStream() is prefered.Gets an InputStream to the working contents of the file. Reads the contents from the actual - file into the temp file if necessary. +**Deprecated.** using `toString2().getInputStream()` is prefered. + +Gets an `InputStream` to the working contents of the file. Reads the contents from the actual file into the temp file if necessary. + **Returns:** -: An InputStream to the file contents, encoded in Base64. +- An `InputStream` to the file contents, encoded in Base64. + **Throws:** -: `java.io.IOException`- thrown if the file can't be read. +- `java.io.IOException` - thrown if the file can't be read. -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2() throws java.io.IOException ``` Gets a PHXStringBuffer representation of the contents of the temporary file. + **Specified by:** -: `toString2`in interface`IPHXType2` +- `toString2` in interface `IPHXType2` + **Returns:** -: PHXStringBuffer representation of the type +- PHXStringBuffer representation of the type + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### fromString2 +### fromString2 ```java public void fromString2(PHXStringBuffer newContents) @@ -727,15 +683,18 @@ public void fromString2(PHXStringBuffer newContents) PHXGetByUrlException ``` Sets the file temporary file contents to the value of the PHXStringBuffer. + **Specified by:** -: `fromString2`in interface`IPHXType2` +- `fromString2` in interface `IPHXType2` + **Parameters:** -: `newContents`- the new contents of the file +- `newContents` - the new contents of the file + **Throws:** -: `java.io.IOException` -: `PHXGetByUrlException` +- `java.io.IOException` +- `PHXGetByUrlException` -- #### toAPIObject +### toAPIObject ```java public  java.util.Map toAPIObject(com.phoenix_int.functional.FunctionThrows fileStore) @@ -743,18 +702,22 @@ public  java.util.Map void fromAPIObject(java.util.Map object, @@ -762,135 +725,146 @@ public  void fromAPIObject(java.util.Map, com.phoenix_int.functional.FunctionThrows)](../../../../com/phoenix_int/aserver/types/PHXRawFile.html#fromAPIObject-java.util.Map-com.phoenix_int.functional.FunctionThrows-)) becomes - responsible for closing the returned handle. +- `object` - the string-string map. +- `fileStore` - a function that can reverse the storage used when the original object was serialized. Note that, according to the convention for `ManagedFileHandle`, this function `(fromAPIObject(java.util.Map, com.phoenix_int.functional.FunctionThrows))` becomes responsible for closing the returned handle. + **Throws:** -: `EX`- when thrown by the file-store function -: `EX extends java.lang.Throwable` +- `EX` - when thrown by the file-store function +- `EX extends java.lang.Throwable` -- #### toString +### toString ```java public java.lang.String toString() ``` converts the variable to a string + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString +### fromString ```java public void fromString(java.lang.String value) ``` Sets the file temporary file contents to the value of the string. + **Specified by:** -: `fromString`in interface`IPHXType` +- `fromString` in interface [`IPHXType`](IPHXType.md) + **Parameters:** -: `value`- the value to use +- `value` - the value to use -- #### setMetaData +### setMetaData ```java public void setMetaData(PHXRawFile metaData) ``` -- #### finalize +### finalize ```java protected void finalize() throws java.lang.Throwable ``` -Although close should be called manually before garbage collection, do so here as a backup. - Note that Java makes no guarantee that any object is ever actually garbage collected; - if the JVM exits without running GC and picking up this object, the finalizer will never be called. - We cannot rely on Java GC as a defense against leaking PHXRawFile objects. +Although close should be called manually before garbage collection, do so here as a backup. Note that Java makes no guarantee that any object is ever actually garbage collected; if the JVM exits without running GC and picking up this object, the finalizer will never be called. We cannot rely on Java GC as a defense against leaking PHXRawFile objects. + **Overrides:** -: `finalize`in class`java.lang.Object` +- `finalize` in class `java.lang.Object` + **Throws:** -: `java.lang.Throwable` +- `java.lang.Throwable` -- #### equalsNatural +### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare` - + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md) + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead` - to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### _setContentFromOther +### _setContentFromOther ```java protected final void _setContentFromOther(PHXRawFile variable) ``` -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Specified by:** -: `Accept`in interface`IPHXType2` +- `Accept` in interface `IPHXType2` + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T` - Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor` - The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### close +### close ```java public void close() ``` + **Specified by:** -: `close`in interface`java.lang.AutoCloseable` +- `close` in interface `java.lang.AutoCloseable` -- #### createCopy +### createCopy ```java public PHXRawFile createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md index a7731dc17b..edd606919a 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRawFileArray.md @@ -1,276 +1,250 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXRawFileArray -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) -- - com.phoenix_int.aserver.types.PHXRawFileArray -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable +# Class PHXRawFileArray + + +**Packages:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXSimpleArray + ↳ com.phoenix_int.aserver.types.PHXRawFileArray +``` + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md), java.lang.Iterable --- +**Declaration:** + ```java public class PHXRawFileArray extends PHXSimpleArray ``` -Wraps an array of PHXRawFile variables - for the ScriptWrapper utility. -**Version:** -: June 23, 2010 -**Author:** -: jdaley +Wraps an array of PHXRawFile variables for the ScriptWrapper utility. + + **See Also:** -: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +- [PHXSimpleArray](PHXSimpleArray.md) + +## Nested Class Summary -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -=========== FIELD SUMMARY =========== -- ### Field Summary -- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray `_data,_lockDims,_lockResize` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXRawFileArray()` | | `PHXRawFileArray(java.lang.Object data)` | -| `PHXRawFileArray(PHXRawFileArrayother)`Clone another PHXRawFileArray's value and metadata. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXRawFileArray(PHXRawFileArrayother)`
Clone another PHXRawFileArray's value and metadata. | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. | -| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data - in this object. | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | -| `PHXRawFileArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified - class is acceptable as an array element component type. | -| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromFile(int index)`loads the file from disk for an element of an 1D array. | -| `void` | `fromFile(int[] index)`loads the file from disk for an element of an array. | -| `void` | `fromFile(int[] index, - java.lang.String fileName)`Sets the filename and then reads from disk for an element of an array. | -| `void` | `fromFile(int index, - java.lang.String fileName)`Sets the filename and then reads from disk for an element of an 1D array. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `void` | `fromString(int[] index, - java.lang.String value)`converts a String representation to the internal value - for an element of an array | -| `void` | `fromString(int index, - java.lang.String value)`converts a String representation to the internal value - for an element of an 1D array | -| `java.lang.String` | `getBaseName()`gets the base name of the files stored in the array | -| `java.lang.String` | `getContents(int index)`retrieves the contents of the file for an element of an 1D array | -| `java.lang.String` | `getContents(int[] index)`retrieves the contents of the file for an element of an array | -| `java.lang.String` | `getFileExtension(int index)`Returns the extension of the file for an element of an 1D array | -| `java.lang.String` | `getFileExtension(int[] index)`Returns the extension of the file for an element of an array | -| `boolean` | `getIsBinary()`Tells whether or not the array contains binary files or not. | -| `java.lang.String` | `getMimeType()`get mime type of the files in the array - Currently all elements of an array should have +| `protected void` | `_getMetaData(PHXSimpleTypev2)`
Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. | +| `protected void` | `_setMetaData(PHXSimpleTypev2)`
Sets a simple type's meta data based on the meta data in this object. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`
Allocates a single element in a default state. | +| `PHXRawFileArray` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`
Must override this function and return true if the specified class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`
Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromFile(int index)`
loads the file from disk for an element of an 1D array. | +| `void` | `fromFile(int[] index)`
loads the file from disk for an element of an array. | +| `void` | `fromFile(int[] index, java.lang.String fileName)`
Sets the filename and then reads from disk for an element of an array. | +| `void` | `fromFile(int index, java.lang.String fileName)`
Sets the filename and then reads from disk for an element of an 1D array. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `void` | `fromString(int[] index, java.lang.String value)`
converts a String representation to the internal value for an element of an array | +| `void` | `fromString(int index, java.lang.String value)`
converts a String representation to the internal value for an element of an 1D array | +| `java.lang.String` | `getBaseName()`
gets the base name of the files stored in the array | +| `java.lang.String` | `getContents(int index()`
retrieves the contents of the file for an element of an 1D array | +| `java.lang.String` | `getContents(int[] index()`
retrieves the contents of the file for an element of an array | +| `java.lang.String` | `getFileExtension(int index()`
Returns the extension of the file for an element of an 1D array | +| `java.lang.String` | `getFileExtension(int[] index()`
Returns the extension of the file for an element of an array | +| `boolean` | `getIsBinary()`
Tells whether or not the array contains binary files or not. | +| `java.lang.String` | `getMimeType()`
get mime type of the files in the array. Currently all elements of an array should have the same mime type. | +| `java.lang.String` | `getName(int index()`
retrieves the name of the file for an element of an 1D array | +| `java.lang.String` | `getName(int[] index()`
retrieves the name of the file for an element of an array | +| `java.lang.String` | `getNameCoded(int index()`
retrieves the name of the file in coded form (without `$variables` replaced) for an element of an 1D array | +| `java.lang.String` | `getNameCoded(int[] index()`
retrieves the name of the file in coded form (without `$variables` replaced) for an element of an array | +| `java.lang.String[]` | `getNames()`
get file names of the elements as an array | +| `java.lang.String[]` | `getNamesCoded()`
get coded file names of the elements as an array | +| `java.lang.String` | `getNamesCodedString()`
get coded file names of the elements as a comma separated string | +| `java.lang.String` | `getNamesString()`
get file names as a comma separated list | +| `java.lang.String[]` | `getURLs()`
get URLs of the elements as an array | +| `java.lang.String` | `getURLsString()`
get URLs of the elements as a comma separated string | +| `PHXRawFile` | `getValue(int index)`
a utility function to return the internal PHXRawFile that represents the array element for the 1D array. | +| `PHXRawFile` | `getValue(int[] index)`
a utility function to return the internal PHXRawFile that represents the array element for the array. | +| `boolean` | `hasChanged(int index)`
checks to see if the file has changed since the last time `getContents()` was called for an element of an 1D array | +| `boolean` | `hasChanged(int[] index)`
checks to see if the file has changed since the last time `getContents()` was called for an element of an array | +| `void` | `markAsRead(int index)`
set `markAsRead` flag for an element for an 1D array call this function after you manually get the contents of the file. | +| `void` | `markAsRead(int[] index)`
set `markAsRead` flag for an element for an array call this function after you manually get the contents of the file. | +| `void` | `readFile(int index)`
loads the file from disk for an element of an 1D array. | +| `void` | `readFile(int[] index)`
loads the file from disk for an element of an array. | +| `void` | `setBaseName(java.lang.String name)`
sets the base name of files for this array | +| `void` | `setContents(int[] index, java.lang.String contents)`
sets the contents of the file for an array element for an array. | +| `void` | `setContents(int index, java.lang.String contents)`
sets the contents of the file for an array element for an 1D array. | +| `void` | `setFileExtension(int[] index, java.lang.String extension)`
Sets the extension of the file for an element of an array | +| `void` | `setFileExtension(int index, java.lang.String extension)`
Sets the extension of the file for an element of an 1D array | +| `void` | `setIsBinary(boolean value)`
Forces elements of this array to be binary or not. | +| `void` | `setMimeType(java.lang.String value)`
Set mime type the array. Currently all elements of an array should have the same mime type. | -| `java.lang.String` | `getName(int index)`retrieves the name of the file for an element of an 1D array | -| `java.lang.String` | `getName(int[] index)`retrieves the name of the file for an element of an array | -| `java.lang.String` | `getNameCoded(int index)`retrieves the name of the file in coded form (without $variables - replaced) for an element of an 1D array | -| `java.lang.String` | `getNameCoded(int[] index)`retrieves the name of the file in coded form (without $variables - replaced) for an element of an array | -| `java.lang.String[]` | `getNames()`get file names of the elements as an array | -| `java.lang.String[]` | `getNamesCoded()`get coded file names of the elements as an array | -| `java.lang.String` | `getNamesCodedString()`get coded file names of the elements as a comma separated string | -| `java.lang.String` | `getNamesString()`get file names as a comma separated list | -| `java.lang.String[]` | `getURLs()`get URLs of the elements as an array | -| `java.lang.String` | `getURLsString()`get URLs of the elements as a comma separated string | -| `PHXRawFile` | `getValue(int index)`a utility function to return the internal PHXRawFile - that represents the array element for the 1D array. | -| `PHXRawFile` | `getValue(int[] index)`a utility function to return the internal PHXRawFile - that represents the array element for the array. | -| `boolean` | `hasChanged(int index)`checks to see if the file has changed since the last time - getContents() was called for an element of an 1D array | -| `boolean` | `hasChanged(int[] index)`checks to see if the file has changed since the last time - getContents() was called for an element of an array | -| `void` | `markAsRead(int index)`set markAsRead flag for an element for an 1D array - call this function after you manually get the contents of the - file. | -| `void` | `markAsRead(int[] index)`set markAsRead flag for an element for an array - call this function after you manually get the contents of the - file. | -| `void` | `readFile(int index)`loads the file from disk for an element of an 1D array. | -| `void` | `readFile(int[] index)`loads the file from disk for an element of an array. | -| `void` | `setBaseName(java.lang.String name)`sets the base name of files for this array | -| `void` | `setContents(int[] index, - java.lang.String contents)`sets the contents of the file for an array element for an array. | -| `void` | `setContents(int index, - java.lang.String contents)`sets the contents of the file for an array element for an 1D array. | -| `void` | `setFileExtension(int[] index, - java.lang.String extension)`Sets the extension of the file for an element of an array | -| `void` | `setFileExtension(int index, - java.lang.String extension)`Sets the extension of the file for an element of an 1D array | -| `void` | `setIsBinary(boolean value)`Forces elements of this array to be binary or not. | -| `void` | `setMimeType(java.lang.String value)`Set mime type the array - Currently all elements of an array should have - the same mime type. | -| `void` | `setName(int[] index, - java.lang.String name)`sets the name of the file for an element of an array | -| `void` | `setName(int index, - java.lang.String name)`sets the name of the file for an element of an 1D array | -| `void` | `setValue(int[] index,PHXRawFileval)`a utility function to set the internal PHXRawFile - that represents the array element for the array. | -| `void` | `setValue(int[] index,PHXSimpleTypeval)`Sets an element as an object of the appropriate PHXSimpleType - Must be overridden in subclasses | -| `void` | `setValue(int[] index, - java.lang.String val)`a utility function to set the value of an array element for the 1D array. | -| `void` | `setValue(int index,PHXRawFileval)`a utility function to set the internal PHXRawFile - that represents the array element for the 1D array. | -| `void` | `setValue(int index, - java.lang.String val)`a utility function to set the value of an array element for the 1D array. | -| `void` | `toFile(int index)`writes the file to disk for an element of an 1D array | -| `void` | `toFile(int[] index)`writes the file to disk for an element of an array | -| `void` | `toFile(int[] index, - java.lang.String fileName)`sets the filename and then writes the file to disk for an element of - an array. | -| `void` | `toFile(int index, - java.lang.String fileName)`sets the filename and then writes the file to disk for an element of - an 1D array. | -| `java.lang.String` | `toString(int index)`converts an element of the 1D array to a string | -| `java.lang.String` | `toString(int[] index)`converts an element of the array to a string | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_getMetaData,_setMetaData,checkRectangular,copy,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString2,toString2,toString2,validElement` - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` - -- ### Methods inherited from interface java.lang.Iterable -`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXRawFileArray +| `void` | `setName(int[] index, java.lang.String name)`
sets the name of the file for an element of an array | +| `void` | `setName(int index, java.lang.String name)`
sets the name of the file for an element of an 1D array | +| `void` | `setValue(int[] index,PHXRawFileval)`
a utility function to set the internal PHXRawFile that represents the array element for the array. | +| `void` | `setValue(int[] index,PHXSimpleTypeval)`
Sets an element as an object of the appropriate PHXSimpleType. Must be overridden in subclasses | +| `void` | `setValue(int[] index, java.lang.String val)`
a utility function to set the value of an array element for the 1D array. | +| `void` | `setValue(int index,PHXRawFileval)`
a utility function to set the internal PHXRawFile that represents the array element for the 1D array. | +| `void` | `setValue(int index, java.lang.String val)`
a utility function to set the value of an array element for the 1D array. | +| `void` | `toFile(int index)`
writes the file to disk for an element of an 1D array | +| `void` | `toFile(int[] index)`
writes the file to disk for an element of an array | +| `void` | `toFile(int[] index, java.lang.String fileName)`
sets the filename and then writes the file to disk for an element of an array. | +| `void` | `toFile(int index, java.lang.String fileName)`
sets the filename and then writes the file to disk for an element of an 1D array. | +| `java.lang.String` | `toString(int index)`
converts an element of the 1D array to a string | +| `java.lang.String` | `toString(int[] index)`
converts an element of the array to a string | + +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +`_getMetaData`, `_setMetaData`, `checkRectangular`, `copy`, `fromString`, `fromString`, `fromString2`, `generateFor`, `generateFor`, `getArray`, `getArrayElement`, `getArrayElement`, `getComponentType`, `getComponentType`, `getDimensions`, `getDimensions`, `getFirst`, `getLength`, `getLength`, `getLockResize`, `getnDIndex`, `getNumDimensions`, `getNumDimensions`, `getSelf`, `incrementIndex`, `iterator`, `lockDimensions`, `newIndex`, `parseIndex`, `resize`, `setArray`, `setArrayElement`, `setArrayElement`, `setDimensions`, `setFirst`, `setLength`, `setLength`, `setLockResize`, `setValue`, `toString`, `toString`, `toString2`, `toString2`, `toString2`, `validElement` + +### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +### Methods inherited from interface java.lang.Iterable +`forEach`, `spliterator` + +## Constructor Detail + +### PHXRawFileArray ```java public PHXRawFileArray() ``` -- #### PHXRawFileArray +### PHXRawFileArray ```java public PHXRawFileArray(java.lang.Object data) ``` -- #### PHXRawFileArray +### PHXRawFileArray ```java public PHXRawFileArray(PHXRawFileArray other) ``` Clone another PHXRawFileArray's value and metadata. + **Parameters:** -: `other`- the other PHXRawFileArray to clone. +- `other`- the other PHXRawFileArray to clone. ============ METHOD DETAIL ========== -- ### Method Detail +### Method Detail -- #### getName +### getName ```java public java.lang.String getName(int index) ``` retrieves the name of the file for an element of an 1D array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: the name of the file +- the name of the file -- #### getName +### getName ```java public java.lang.String getName(int[] index) ``` retrieves the name of the file for an element of an array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: the name of the file +- the name of the file -- #### getNameCoded +### getNameCoded ```java public java.lang.String getNameCoded(int index) ``` -retrieves the name of the file in coded form (without $variables - replaced) for an element of an 1D array +retrieves the name of the file in coded form (without `$variables` replaced) for an element of an 1D array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: the name of the file in coded form +- the name of the file in coded form -- #### getNameCoded +### getNameCoded ```java public java.lang.String getNameCoded(int[] index) ``` -retrieves the name of the file in coded form (without $variables - replaced) for an element of an array +retrieves the name of the file in coded form (without `$variables` replaced) for an element of an array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: the name of the file in coded form +- the name of the file in coded form -- #### getFileExtension +### getFileExtension ```java public java.lang.String getFileExtension(int index) ``` Returns the extension of the file for an element of an 1D array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: extension +- extension -- #### getFileExtension +### getFileExtension ```java public java.lang.String getFileExtension(int[] index) ``` Returns the extension of the file for an element of an array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: extension +- extension -- #### setFileExtension +### setFileExtension ```java public void setFileExtension(int index, java.lang.String extension) throws java.io.IOException ``` -Sets the extension of the file for an element of an 1D array -It is preferred that you use setName() and let the system automatically - figure out the extension based on what you pass in. Then, you can - use readFile() and writeFile() without passing filenames to those - calls. This allows for progress monitoring to work correctly in - all cases. +Sets the extension of the file for an element of an 1D array. + +It is preferred that you use `setName()` and let the system automatically figure out the extension based on what you pass in. Then, you can use `readFile()` and `writeFile()` without passing filenames to those calls. This allows for progress monitoring to work correctly in all cases. + **Parameters:** -: `index`- array index -: `extension`- file extension +- `index`- array index +- `extension`- file extension + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setFileExtension +### setFileExtension ```java public void setFileExtension(int[] index, @@ -278,18 +252,17 @@ public void setFileExtension(int[] index, throws java.io.IOException ``` Sets the extension of the file for an element of an array -It is preferred that you use setName() and let the system automatically - figure out the extension based on what you pass in. Then, you can - use readFile() and writeFile() without passing filenames to those - calls. This allows for progress monitoring to work correctly in - all cases. -**Parameters:** -: `index`- array index -: `extension`- file extension + +It is preferred that you use `setName()` and let the system automatically figure out the extension based on what you pass in. Then, you can use `readFile()` and `writeFile()` without passing filenames to those calls. This allows for progress monitoring to work correctly in all cases. + +**Parameters:** +- `index`- array index +- `extension`- file extension + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setName +### setName ```java public void setName(int index, @@ -297,13 +270,15 @@ public void setName(int index, throws java.io.IOException ``` sets the name of the file for an element of an 1D array + **Parameters:** -: `index`- array index -: `name`- file name +- `index`- array index +- `name`- file name + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setName +### setName ```java public void setName(int[] index, @@ -311,135 +286,147 @@ public void setName(int[] index, throws java.io.IOException ``` sets the name of the file for an element of an array + **Parameters:** -: `index`- array index -: `name`- file name +- `index`- array index +- `name`- file name + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setBaseName +### setBaseName ```java public void setBaseName(java.lang.String name) throws java.io.IOException ``` sets the base name of files for this array + **Parameters:** -: `name`- base name +- `name`- base name + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### getBaseName +### getBaseName ```java public java.lang.String getBaseName() ``` gets the base name of the files stored in the array + **Returns:** -: the name +- the name -- #### getIsBinary +### getIsBinary ```java public boolean getIsBinary() ``` Tells whether or not the array contains binary files or not. - Simply switches on whether or not the mime type starts - with text. Currently all elements of an array should have - the same binaryness. + +Simply switches on whether or not the mime type starts with text. Currently all elements of an array should have the same binaryness. + **Returns:** -: true if the file is binary +- true if the file is binary -- #### setIsBinary +### setIsBinary ```java public void setIsBinary(boolean value) ``` Forces elements of this array to be binary or not. - If this causes the mode to change, will set the - mime type to text/plain or application/octet-stream - as appropriate. Currently all elements of an array should have - the same binaryness. + +If this causes the mode to change, will set the mime type to `text/plain` or `application/octet-stream` as appropriate. Currently all elements of an array should have the same binaryness. + **Parameters:** -: `value`- the value to set +- `value`- the value to set -- #### getMimeType +### getMimeType ```java public java.lang.String getMimeType() ``` get mime type of the files in the array - Currently all elements of an array should have - the same mime type. + +Currently all elements of an array should have the same mime type. + **Returns:** -: mime type +- mime type -- #### setMimeType +### setMimeType ```java public void setMimeType(java.lang.String value) ``` Set mime type the array - Currently all elements of an array should have - the same mime type. + +Currently all elements of an array should have the same mime type. + **Parameters:** -: `value`- the mimeType mime type +- `value`- the mimeType mime type -- #### getNames +### getNames ```java public java.lang.String[] getNames() ``` get file names of the elements as an array + **Returns:** -: list of file names +- list of file names -- #### getNamesString +### getNamesString ```java public java.lang.String getNamesString() ``` get file names as a comma separated list + **Returns:** -: list of file names +- list of file names -- #### getNamesCoded +### getNamesCoded ```java public java.lang.String[] getNamesCoded() ``` get coded file names of the elements as an array + **Returns:** -: list of coded file names +- list of coded file names -- #### getNamesCodedString +### getNamesCodedString ```java public java.lang.String getNamesCodedString() ``` get coded file names of the elements as a comma separated string + **Returns:** -: list of coded file names +- list of coded file names -- #### getURLs +### getURLs ```java public java.lang.String[] getURLs() ``` get URLs of the elements as an array + **Returns:** -: list of file URLs +- list of file URLs -- #### getURLsString +### getURLsString ```java public java.lang.String getURLsString() ``` get URLs of the elements as a comma separated string + **Returns:** -: list of file URLs +- list of file URLs -- #### setContents +### setContents ```java public void setContents(int index, @@ -447,20 +434,19 @@ public void setContents(int index, throws java.io.IOException ``` sets the contents of the file for an array element for an 1D array. - The actual file is not modified until the writeFile() method - is issued. - Remember that when dealing with text files, - setContents handles Java style strings, which - must be in bare LF, or Unix style newline format. - In binary format, setContents should be the - base64 encoded data. -**Parameters:** -: `index`- array index -: `contents`- the contents of the file + +The actual file is not modified until the `writeFile()` method is issued. + +Remember that when dealing with text files, `setContents` handles Java style strings, which must be in bare LF, or Unix style newline format. In binary format, `setContents` should be the base64 encoded data. + +**Parameters:** +- `index`- array index +- `contents`- the contents of the file + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setContents +### setContents ```java public void setContents(int[] index, @@ -468,96 +454,109 @@ public void setContents(int[] index, throws java.io.IOException ``` sets the contents of the file for an array element for an array. - The actual file is not modified until the writeFile() method - is issued. - Remember that when dealing with text files, - setContents handles Java style strings, which - must be in bare LF, or Unix style newline format. - In binary format, setContents should be the - base64 encoded data. -**Parameters:** -: `index`- array index -: `contents`- the contents of the file + +The actual file is not modified until the `writeFile()` method is issued. + +Remember that when dealing with text files, `setContents` handles Java style strings, which must be in bare LF, or Unix style newline format. In binary format, `setContents` should be the base64 encoded data. + +**Parameters:** +- `index`- array index +- `contents`- the contents of the file + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### getContents +### getContents ```java public java.lang.String getContents(int index) throws java.lang.Exception ``` retrieves the contents of the file for an element of an 1D array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: the contents of the file +- the contents of the file + **Throws:** -: `java.lang.Exception` +- `java.lang.Exception` -- #### getContents +### getContents ```java public java.lang.String getContents(int[] index) throws java.io.IOException ``` retrieves the contents of the file for an element of an array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: the contents of the file +- the contents of the file + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### fromFile +### fromFile ```java public void fromFile(int index) throws java.io.IOException ``` loads the file from disk for an element of an 1D array. + **Parameters:** -: `index`- array index +- `index`- array index + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException`- thrown if the file can't be loaded. -- #### fromFile +### fromFile ```java public void fromFile(int[] index) throws java.io.IOException ``` loads the file from disk for an element of an array. + **Parameters:** -: `index`- array index +- `index`- array index + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException`- thrown if the file can't be loaded. -- #### readFile +### readFile ```java public void readFile(int index) throws java.io.IOException ``` loads the file from disk for an element of an 1D array. + **Parameters:** -: `index`- array index +- `index`- array index + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException`- thrown if the file can't be loaded. -- #### readFile +### readFile ```java public void readFile(int[] index) throws java.io.IOException ``` loads the file from disk for an element of an array. + **Parameters:** -: `index`- array index +- `index`- array index + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException`- thrown if the file can't be loaded. -- #### fromFile +### fromFile ```java public void fromFile(int index, @@ -565,16 +564,17 @@ public void fromFile(int index, throws java.io.IOException ``` Sets the filename and then reads from disk for an element of an 1D array. - It is preferred that you use setName() when you create a PHXRawFile and then - use readFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. + +It is preferred that you use `setName()` when you create a PHXRawFile and then use `readFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + **Parameters:** -: `index`- array index -: `fileName`- file name +- `index`- array index +- `fileName`- file name + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException`- thrown if the file can't be loaded. -- #### fromFile +### fromFile ```java public void fromFile(int[] index, @@ -582,152 +582,163 @@ public void fromFile(int[] index, throws java.io.IOException ``` Sets the filename and then reads from disk for an element of an array. - It is preferred that you use setName() when you create a PHXRawFile and then - use readFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. + +It is preferred that you use `setName()` when you create a PHXRawFile and then use `readFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + **Parameters:** -: `index`- array index -: `fileName`- file name +- `index`- array index +- `fileName`- file name + **Throws:** -: `java.io.IOException`- thrown if the file can't be loaded. +- `java.io.IOException`- thrown if the file can't be loaded. -- #### markAsRead +### markAsRead ```java public void markAsRead(int index) ``` -set markAsRead flag for an element for an 1D array - call this function after you manually get the contents of the - file. The function records it's name and timestamp for use with - the hasChanged() function +set `markAsRead` flag for an element for an 1D array + +call this function after you manually get the contents of the file. The function records its name and timestamp for use with the `hasChanged()` function + **Parameters:** -: `index`- array index +- `index`- array index -- #### markAsRead +### markAsRead ```java public void markAsRead(int[] index) ``` -set markAsRead flag for an element for an array - call this function after you manually get the contents of the - file. The function records it's name and timestamp for use with - the hasChanged() function +set `markAsRead` flag for an element for an array + +call this function after you manually get the contents of the file. The function records it's name and timestamp for use with the `hasChanged()` function + **Parameters:** -: `index`- array index +- `index`- array index -- #### hasChanged +### hasChanged ```java public boolean hasChanged(int index) ``` -checks to see if the file has changed since the last time - getContents() was called for an element of an 1D array +checks to see if the file has changed since the last time `getContents()` was called for an element of an 1D array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: true if the timestamp of the file is new, or if the - file name has changed +- `true` if the timestamp of the file is new, or if the file name has changed -- #### hasChanged +### hasChanged ```java public boolean hasChanged(int[] index) ``` -checks to see if the file has changed since the last time - getContents() was called for an element of an array +checks to see if the file has changed since the last time `getContents()` was called for an element of an array + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: true if the timestamp of the file is new, or if the - file name has changed +- `true` if the timestamp of the file is new, or if the file name has changed -- #### toFile +### toFile ```java public void toFile(int index, java.lang.String fileName) throws java.io.IOException ``` -sets the filename and then writes the file to disk for an element of - an 1D array. It is preferred - that you use setName() when you create a PHXRawFile and then - use writeFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. +sets the filename and then writes the file to disk for an element of an 1D array. + +It is preferred that you use `setName()` when you create a PHXRawFile and then use `writeFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + **Parameters:** -: `index`- array index -: `fileName`- name of the file to write +- `index`- array index +- `fileName`- name of the file to write + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException`- thrown if the file can't be written. -- #### toFile +### toFile ```java public void toFile(int[] index, java.lang.String fileName) throws java.io.IOException ``` -sets the filename and then writes the file to disk for an element of - an array. It is preferred - that you use setName() when you create a PHXRawFile and then - use writeFile() without passing a filename to it. This allows - progress monitoring to work correctly in all cases. +sets the filename and then writes the file to disk for an element of an array. + +It is preferred that you use `setName()` when you create a PHXRawFile and then use `writeFile()` without passing a filename to it. This allows progress monitoring to work correctly in all cases. + **Parameters:** -: `index`- array index -: `fileName`- name of the file to write +- `index`- array index +- `fileName`- name of the file to write + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException`- thrown if the file can't be written. -- #### toFile +### toFile ```java public void toFile(int index) throws java.io.IOException ``` writes the file to disk for an element of an 1D array + **Parameters:** -: `index`- array index +- `index`- array index + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException`- thrown if the file can't be written. -- #### toFile +### toFile ```java public void toFile(int[] index) throws java.io.IOException ``` writes the file to disk for an element of an array + **Parameters:** -: `index`- array index +- `index`- array index + **Throws:** -: `java.io.IOException`- thrown if the file can't be written. +- `java.io.IOException`- thrown if the file can't be written. -- #### toString +### toString ```java public java.lang.String toString(int index) ``` converts an element of the 1D array to a string + **Overrides:** -: `toString`in class`PHXSimpleArray` +- `toString` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### toString +### toString ```java public java.lang.String toString(int[] index) ``` converts an element of the array to a string + **Overrides:** -: `toString`in class`PHXSimpleArray` +- `toString` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString +### fromString ```java public void fromString(int index, @@ -735,156 +746,166 @@ public void fromString(int index, ``` converts a String representation to the internal value for an element of an 1D array + **Overrides:** -: `fromString`in class`PHXSimpleArray` +- `fromString` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `index`- array index -: `value`- the value to convert +- `index`- array index +- `value`- the value to convert -- #### fromString +### fromString ```java public void fromString(int[] index, java.lang.String value) ``` -converts a String representation to the internal value - for an element of an array +converts a String representation to the internal value for an element of an array + **Overrides:** -: `fromString`in class`PHXSimpleArray` +- `fromString` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `index`- array index -: `value`- the value to convert +- `index`- array index +- `value`- the value to convert -- #### getValue +### getValue ```java public PHXRawFile getValue(int index) ``` -a utility function to return the internal PHXRawFile - that represents the array element for the 1D array. +a utility function to return the internal PHXRawFile that represents the array element for the 1D array. + **Overrides:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: array element +- array element -- #### getValue +### getValue ```java public PHXRawFile getValue(int[] index) ``` -a utility function to return the internal PHXRawFile - that represents the array element for the array. +a utility function to return the internal PHXRawFile that represents the array element for the array. + **Specified by:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `index`- array index +- `index`- array index + **Returns:** -: array element +- array element -- #### setValue +### setValue ```java public void setValue(int index, PHXRawFile val) ``` -a utility function to set the internal PHXRawFile - that represents the array element for the 1D array. +a utility function to set the internal PHXRawFile that represents the array element for the 1D array. + **Parameters:** -: `index`- array index -: `val`- array element to set +- `index`- array index +- `val`- array element to set -- #### setValue +### setValue ```java public void setValue(int[] index, PHXRawFile val) ``` -a utility function to set the internal PHXRawFile - that represents the array element for the array. +a utility function to set the internal PHXRawFile that represents the array element for the array. + **Parameters:** -: `index`- array index -: `val`- array element to set +- `index`- array index +- `val`- array element to set -- #### setValue +### setValue ```java public void setValue(int index, java.lang.String val) throws java.io.IOException ``` -a utility function to set the value of an array element for the 1D array. - This is a synomym of setContent(). +a utility function to set the value of an array element for the 1D array. This is a synomym of `setContent()`. + **Parameters:** -: `index`- array index -: `val`- value to set +- `index`- array index +- `val`- value to set + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### setValue +### setValue ```java public void setValue(int[] index, java.lang.String val) throws java.io.IOException ``` -a utility function to set the value of an array element for the 1D array. - This is a synomym of setContent(). +a utility function to set the value of an array element for the 1D array. This is a synomym of `setContent()`. + **Parameters:** -: `index`- array index -: `val`- value to set +- `index`- array index +- `val`- value to set + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### dataTypeOK +### dataTypeOK ```java protected boolean dataTypeOK(java.lang.Class c) ``` -Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified - class is acceptable as an array element component type. +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Must override this function and return true if the specified class is acceptable as an array element component type. + **Specified by:** -: `dataTypeOK`in class`PHXSimpleArray` +- `dataTypeOK` in class [`PHXSimpleArray`](PHXSimpleArray.md) -- #### elementFromString +### elementFromString ```java protected java.lang.Object elementFromString(java.lang.String val) ``` -Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. This is only used when the element type does not - implement IPHXType or IPHXType2. For primitives, return - the wrapper objects. +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. This is only used when the element type does not implement [`IPHXType`](IPHXType.md) or [`IPHXType2`](IPHXType2.md). For primitives, return the wrapper objects. + **Specified by:** -: `elementFromString`in class`PHXSimpleArray` +- `elementFromString` in class [`PHXSimpleArray`](PHXSimpleArray.md) -- #### _getMetaData +### _getMetaData ```java protected void _getMetaData(PHXSimpleType v2) ``` -Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. Override this in order to add - more custom meta data in sub-classes. Be sure to cal - super._getMetaData(PHXSimpleType), though! +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Worker which takes the meta data from an instance of [PHXSimpleType](PHXSimpleType.md) and sets it into our meta data. Override this in order to add more custom meta data in sub-classes. Be sure to call `super._getMetaData(PHXSimpleType)`, though! + **Overrides:** -: `_getMetaData`in class`PHXSimpleArray` +- `_getMetaData` in class [`PHXSimpleArray`](PHXSimpleArray.md) -- #### _setMetaData +### _setMetaData ```java protected void _setMetaData(PHXSimpleType v2) ``` -Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data - in this object. Override this to set additional - information in sub-classes. Be sure to call - super._setMetaData(PHXSimpleType) +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Sets a simple type's meta data based on the meta data in this object. Override this to set additional information in sub-classes. Be sure to call `super._setMetaData(PHXSimpleType)`. + **Overrides:** -: `_setMetaData`in class`PHXSimpleArray` +- `_setMetaData` in class [`PHXSimpleArray`](PHXSimpleArray.md) -- #### allocateElement +### allocateElement ```java protected java.lang.Object allocateElement(java.lang.Class elementClass) @@ -892,93 +913,105 @@ protected java.lang.Object allocateElement(java.lang.Class elementClass) java.lang.InstantiationException ``` Allocates a single element in a default state. - This overrides allocateElement to set the common metadata - for the newly created element + +This overrides `allocateElement` to set the common metadata for the newly created element + **Overrides:** -: `allocateElement`in class`PHXSimpleArray` +- `allocateElement` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Throws:** -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### equalsNatural +### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. Array comparison is handled as follows: + 1) Compare the number of dimensions between the two arrays 2) Compare the length of dimensions between the two arrays 3) Compare the values in each of the two arrays - Iff these three conditions are met, the two arrays are considered naturally equal. + + If these three conditions are met, the two arrays are considered naturally equal. + **Overrides:** -: `equalsNatural`in class`PHXSimpleArray` +- `equalsNatural` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `toCompare`- +- `toCompare`- + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) - if the given PHXSimpleType cannot be compared with this object. -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md) + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class `PHXSimpleType` + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. -- #### setValue +### setValue ```java public void setValue(int[] index, PHXSimpleType val) ``` -Sets an element as an object of the appropriate PHXSimpleType - Must be overridden in subclasses +Sets an element as an object of the appropriate [`PHXSimpleType `](PHXSimpleType.md) + +Must be overridden in subclasses + **Specified by:** -: `setValue`in class`PHXSimpleArray` +- `setValue` in class [`PHXSimpleArray`](PHXSimpleArray.md) + **Parameters:** -: `index`- nD array index -: `val`- value to set +- `index`- nD array index +- `val`- value to set -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java public PHXRawFileArray createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class `PHXSimpleType` + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md index 2e1aa6aa3a..054d88e3ab 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefArrayProperty.md @@ -1,197 +1,226 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXRefArrayProperty -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXRefArrayProperty -- **All Implemented Interfaces:** -: [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html),[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) +# Class PHXRefArrayProperty + + +**Packages:** `com.phoenix_int.aserver.types` + +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXRefArrayProperty +``` + + +**All Implemented Interfaces:** +- [IPHXDescription](IPHXDescription.md), [IPHXRefPropInfo](IPHXRefPropInfo.md) --- + +**Declaration:** + ```java public class PHXRefArrayProperty extends java.lang.Object implements IPHXRefPropInfo ``` -This is a class for holding properties of a reference - object + +This is a class for holding properties of a reference object + - **type**: String - **enumValues**: String[] - **description**: String - **title**: String - **input**: boolean + where type may be any of the following: + - "long" - "double" - "boolean" - "string" -**Author:** -: Woyak- ========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `void` | `enumValuesFromString(java.lang.String enumValues)`sets the enum values from a comma-separated list of values | -| `java.lang.String` | `getDescription()`retrieves a description of the ref prop | -| `java.lang.String[]` | `getEnumValues()`lists enum values | -| `boolean` | `getInput()`retrieves an indicator of whether the ref prop is an input - or an output. | -| `java.lang.String` | `getName()`retrieves the name of the variable | -| `java.lang.String` | `getTitle()`retrieves a title of the ref prop. | -| `java.lang.String` | `getType()`retrieves the current type of the variable | -| `java.lang.String` | `getValues(int index)`gets the value at an index | -| `void` | `setDescription(java.lang.String value)`sets a description of the ref prop | -| `void` | `setEnumValues(java.lang.String[] enumValues)`sets the enum values | -| `void` | `setInput(boolean value)`sets an indicator for the ref prop | -| `void` | `setTitle(java.lang.String value)`sets a title of the ref prop | -| `void` | `setValues(int index, - java.lang.String v)`sets the value for the variable | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ METHOD DETAIL ========== -- ### Method Detail - -- #### getName +| `void` | `enumValuesFromString(java.lang.String enumValues)`
sets the enum values from a comma-separated list of values | +| `java.lang.String` | `getDescription()`
retrieves a description of the ref prop | +| `java.lang.String[]` | `getEnumValues()`
lists enum values | +| `boolean` | `getInput()`
retrieves an indicator of whether the ref prop is an input or an output. | +| `java.lang.String` | `getName()`
retrieves the name of the variable | +| `java.lang.String` | `getTitle()`
retrieves a title of the ref prop. | +| `java.lang.String` | `getType()`
retrieves the current type of the variable | +| `java.lang.String` | `getValues(int index)`
gets the value at an index | +| `void` | `setDescription(java.lang.String value)`
sets a description of the ref prop | +| `void` | `setEnumValues(java.lang.String[] enumValues)`
sets the enum values | +| `void` | `setInput(boolean value)`
sets an indicator for the ref prop | +| `void` | `setTitle(java.lang.String value)`
sets a title of the ref prop | +| `void` | `setValues(int index, java.lang.String v)`
sets the value for the variable | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Method Detail + +### getName ```java public java.lang.String getName() ``` retrieves the name of the variable + **Specified by:** -: `getName`in interface`IPHXRefPropInfo` +- `getName` in interface `IPHXRefPropInfo`### + **Returns:** -: the name of the variable +- the name of the variable -- #### getDescription +### getDescription ```java public java.lang.String getDescription() ``` retrieves a description of the ref prop + **Specified by:** -: `getDescription`in interface`IPHXDescription` +- `getDescription` in interface `IPHXDescription` + **Returns:** -: a description of the ref prop +- a description of the ref prop -- #### setDescription +### setDescription ```java public void setDescription(java.lang.String value) ``` sets a description of the ref prop + **Specified by:** -: `setDescription`in interface`IPHXDescription` +- `setDescription` in interface `IPHXDescription` + **Parameters:** -: `value`- a description of the ref prop +- `value`- a description of the ref prop -- #### getTitle +### getTitle ```java public java.lang.String getTitle() ``` -retrieves a title of the ref prop. Used by ModelCenter when - displaying the variable in certain dialogs +retrieves a title of the ref prop. Used by ModelCenter when displaying the variable in certain dialogs + **Specified by:** -: `getTitle`in interface`IPHXRefPropInfo` +- `getTitle` in interface `IPHXRefPropInfo` + **Returns:** -: a title for the ref prop +- a title for the ref prop -- #### setTitle +### setTitle ```java public void setTitle(java.lang.String value) ``` sets a title of the ref prop + **Specified by:** -: `setTitle`in interface`IPHXRefPropInfo` +- `setTitle` in interface `IPHXRefPropInfo` + **Parameters:** -: `value`- a title for the ref prop +- `value`- a title for the ref prop -- #### getInput +### getInput ```java public boolean getInput() ``` -retrieves an indicator of whether the ref prop is an input - or an output. If it's an output, the driver component - will calculate a value for it. +retrieves an indicator of whether the ref prop is an input or an output. If it's an output, the driver component will calculate a value for it. + **Specified by:** -: `getInput`in interface`IPHXRefPropInfo` +- `getInput` in interface `IPHXRefPropInfo` + **Returns:** -: an indicator if the ref prop is an input +- an indicator if the ref prop is an input -- #### setInput +### setInput ```java public void setInput(boolean value) ``` sets an indicator for the ref prop + **Specified by:** -: `setInput`in interface`IPHXRefPropInfo` +- `setInput` in interface `IPHXRefPropInfo` + **Parameters:** -: `value`- an indicator for the ref prop +- `value`- an indicator for the ref prop -- #### getValues +### getValues ```java public java.lang.String getValues(int index) ``` gets the value at an index + **Parameters:** -: `index`- the desired index +- `index`- the desired index -- #### setValues +### setValues ```java public void setValues(int index, java.lang.String v) ``` sets the value for the variable + **Parameters:** -: `v`- the value +- `v`- the value -- #### getType +### getType ```java public java.lang.String getType() ``` retrieves the current type of the variable + **Specified by:** -: `getType`in interface`IPHXRefPropInfo` +- `getType` in interface `IPHXRefPropInfo` + **Returns:** -: the value of the variable +- the value of the variable -- #### getEnumValues +### getEnumValues ```java public java.lang.String[] getEnumValues() ``` lists enum values + **Specified by:** -: `getEnumValues`in interface`IPHXRefPropInfo` +- `getEnumValues` in interface `IPHXRefPropInfo` + **Returns:** -: enum values +- enum values -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String[] enumValues) ``` sets the enum values + **Specified by:** -: `setEnumValues`in interface`IPHXRefPropInfo` +- `setEnumValues` in interface `IPHXRefPropInfo` + **Parameters:** -: `enumValues`- an array enum values +- `enumValues`- an array enum values -- #### enumValuesFromString +### enumValuesFromString ```java public void enumValuesFromString(java.lang.String enumValues) ``` sets the enum values from a comma-separated list of values + **Specified by:** -: `enumValuesFromString`in interface`IPHXRefPropInfo` +- `enumValuesFromString` in interface `IPHXRefPropInfo` + **Parameters:** -: `enumValues`- a comma-separated list of values -========= END OF CLASS DATA ========= \ No newline at end of file +- `enumValues`- a comma-separated list of values diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md index 0bd08be767..cb8b97a71b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXRefProperty.md @@ -1,219 +1,247 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXRefProperty -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXRefProperty -- **All Implemented Interfaces:** -: [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html),[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) +# Class PHXRefProperty + + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXRefProperty +``` + +**All Implemented Interfaces:** +- [IPHXDescription](IPHXDescription.md), [IPHXRefPropInfo](IPHXRefPropInfo.md) --- +**Declaration:** + ```java public class PHXRefProperty extends java.lang.Object implements IPHXRefPropInfo ``` -This is a class for holding properties of a reference - object + +This is a class for holding properties of a reference object + - **type**: String - **enumValues**: String[] - **description**: String - **title**: String - **input**: boolean + where type may be any of the following: + - "long" - "double" - "boolean" - "string" -**Author:** -: Woyak- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXRefProperty(java.lang.String name, - java.lang.String type)`constructor | -========== METHOD SUMMARY =========== -- ### Method Summary +| `PHXRefProperty(java.lang.String name, java.lang.String type)`
constructor | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `void` | `enumValuesFromString(java.lang.String enumValues)`sets the enum values from a comma-separated list of values | -| `java.lang.String` | `getDescription()`retrieves a description of the ref prop | -| `java.lang.String[]` | `getEnumValues()`lists enum values | -| `boolean` | `getInput()`retrieves an indicator of whether the ref prop is an input - or an output. | -| `java.lang.String` | `getName()`retrieves the name of the variable | -| `java.lang.String` | `getTitle()`retrieves a title of the ref prop. | -| `java.lang.String` | `getType()`retrieves the current type of the variable | -| `java.lang.String` | `getValue()`retrieves the current value of the variable | -| `void` | `setDescription(java.lang.String value)`sets a description of the ref prop | -| `void` | `setEnumValues(java.lang.String[] enumValues)`sets the enum values | -| `void` | `setInput(boolean value)`sets an indicator for the ref prop | -| `void` | `setTitle(java.lang.String value)`sets a title of the ref prop | -| `void` | `setValue(java.lang.String v)`sets the value for the variable | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXRefProperty +| `void` | `enumValuesFromString(java.lang.String enumValues)`
sets the enum values from a comma-separated list of values | +| `java.lang.String` | `getDescription()`
retrieves a description of the ref prop | +| `java.lang.String[]` | `getEnumValues()`
lists enum values | +| `boolean` | `getInput()`
retrieves an indicator of whether the ref prop is an input or an output. | +| `java.lang.String` | `getName()`
retrieves the name of the variable | +| `java.lang.String` | `getTitle()`
retrieves a title of the ref prop. | +| `java.lang.String` | `getType()`
retrieves the current type of the variable | +| `java.lang.String` | `getValue()`
retrieves the current value of the variable | +| `void` | `setDescription(java.lang.String value)`
sets a description of the ref prop | +| `void` | `setEnumValues(java.lang.String[] enumValues)`
sets the enum values | +| `void` | `setInput(boolean value)`
sets an indicator for the ref prop | +| `void` | `setTitle(java.lang.String value)`
sets a title of the ref prop | +| `void` | `setValue(java.lang.String v)`
sets the value for the variable | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXRefProperty ```java public PHXRefProperty(java.lang.String name, java.lang.String type) ``` constructor + **Parameters:** -: `name`- the name of the property -: `type`- the type of the property -============ METHOD DETAIL ========== -- ### Method Detail +- `name`- the name of the property +- `type`- the type of the property -- #### getName +### Method Detail + +### getName ```java public java.lang.String getName() ``` retrieves the name of the variable + **Specified by:** -: `getName`in interface`IPHXRefPropInfo` +- `getName` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Returns:** -: the name of the variable +- the name of the variable -- #### getDescription +### getDescription ```java public java.lang.String getDescription() ``` retrieves a description of the ref prop + **Specified by:** -: `getDescription`in interface`IPHXDescription` +- `getDescription` in interface [`IPHXDescription`](IPHXDescription.md) + **Returns:** -: a description of the ref prop +- a description of the ref prop -- #### setDescription +### setDescription ```java public void setDescription(java.lang.String value) ``` sets a description of the ref prop + **Specified by:** -: `setDescription`in interface`IPHXDescription` +- `setDescription` in interface [`IPHXDescription`](IPHXDescription.md) + **Parameters:** -: `value`- a description of the ref prop +- `value`- a description of the ref prop -- #### getTitle +### getTitle ```java public java.lang.String getTitle() ``` -retrieves a title of the ref prop. Used by ModelCenter when - displaying the variable in certain dialogs +retrieves a title of the ref prop. Used by ModelCenter when displaying the variable in certain dialogs + **Specified by:** -: `getTitle`in interface`IPHXRefPropInfo` +- `getTitle` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Returns:** -: a title for the ref prop +- a title for the ref prop -- #### setTitle +### setTitle ```java public void setTitle(java.lang.String value) ``` sets a title of the ref prop + **Specified by:** -: `setTitle`in interface`IPHXRefPropInfo` +- `setTitle` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Parameters:** -: `value`- a title for the ref prop +- `value`- a title for the ref prop -- #### getInput +### getInput ```java public boolean getInput() ``` -retrieves an indicator of whether the ref prop is an input - or an output. If it's an output, the driver component - will calculate a value for it. +retrieves an indicator of whether the ref prop is an input or an output. If it's an output, the driver component will calculate a value for it. + **Specified by:** -: `getInput`in interface`IPHXRefPropInfo` +- `getInput` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Returns:** -: an indicator if the ref prop is an input +- an indicator if the ref prop is an input -- #### setInput +### setInput ```java public void setInput(boolean value) ``` sets an indicator for the ref prop + **Specified by:** -: `setInput`in interface`IPHXRefPropInfo` +- `setInput` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Parameters:** -: `value`- an indicator for the ref prop +- `value`- an indicator for the ref prop -- #### getValue +### getValue ```java public java.lang.String getValue() throws PHXTypeMismatchException ``` retrieves the current value of the variable + **Returns:** -: the value of the variable +- the value of the variable + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### setValue +### setValue ```java public void setValue(java.lang.String v) ``` sets the value for the variable + **Parameters:** -: `v`- the value +- `v`- the value -- #### getType +### getType ```java public java.lang.String getType() ``` retrieves the current type of the variable + **Specified by:** -: `getType`in interface`IPHXRefPropInfo` +- `getType` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Returns:** -: the value of the variable +- the value of the variable -- #### getEnumValues +### getEnumValues ```java public java.lang.String[] getEnumValues() ``` lists enum values + **Specified by:** -: `getEnumValues`in interface`IPHXRefPropInfo` +- `getEnumValues` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Returns:** -: enum values +- enum values -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String[] enumValues) ``` sets the enum values + **Specified by:** -: `setEnumValues`in interface`IPHXRefPropInfo` +- `setEnumValues` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Parameters:** -: `enumValues`- an array enum values +- `enumValues`- an array enum values -- #### enumValuesFromString +### enumValuesFromString ```java public void enumValuesFromString(java.lang.String enumValues) ``` sets the enum values from a comma-separated list of values + **Specified by:** -: `enumValuesFromString`in interface`IPHXRefPropInfo` +- `enumValuesFromString` in interface [`IPHXRefPropInfo`](IPHXRefPropInfo.md) + **Parameters:** -: `enumValues`- a comma-separated list of values -========= END OF CLASS DATA ========= \ No newline at end of file +- `enumValues`- a comma-separated list of values diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md index 23923e2af7..c82a7b4c81 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReference.md @@ -1,10 +1,15 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXReference -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXReference -- **All Implemented Interfaces:** -: [IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html),[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) +# Class PHXReference + + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXReference +``` + + +**All Implemented Interfaces:** +- [IPHXAlwaysWriteable](IPHXAlwaysWriteable.md), [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md) --- @@ -13,182 +18,189 @@ public class PHXReference extends java.lang.Object implements IPHXAlwaysWriteable, IPHXType2 ``` -The Phoenix type for references. This class matches up to - references in ModelCenter. Users may define their own - properties in addition to the value property. -- **value**: double -- **properties**: PHXRefProperty[] -- **reference**: String -**Author:** -: Woyak- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary - -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +The type for references. This class matches up to references in ModelCenter. Users may define their own properties in addition to the value property. + + +**value**: double + + +**properties**: PHXRefProperty[] + + +**reference**: String + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXReference()`constructor | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `PHXRefProperty` | `_getProperty(java.lang.String name)`retrieves a named property | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `IPHXRefPropInfo` | `createRefProp(java.lang.String name, - java.lang.String type)`adds a property to the variable | -| `void` | `fromString(java.lang.String s)`converts from a string | -| `void` | `fromString2(PHXStringBuffers)`converts from a PHXStringBuffer | +| `PHXRefProperty` | `_getProperty(java.lang.String name)`
retrieves a named property | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `IPHXRefPropInfo` | `createRefProp(java.lang.String name, java.lang.String type)`
adds a property to the variable | +| `void` | `fromString(java.lang.String s)`
converts from a string | +| `void` | `fromString2(PHXStringBuffers)`
converts from a PHXStringBuffer | | `java.lang.String` | `getDescription()` | -| `PHXRefProperty[]` | `getProperties()`retrieves the properties of the variable | -| `java.lang.String` | `getReference()`retrieves the current reference string. | +| `PHXRefProperty[]` | `getProperties()`
retrieves the properties of the variable | +| `java.lang.String` | `getReference()`
retrieves the current reference string. | | `boolean` | `getRefPropValueBoolean(java.lang.String name)` | -| `double` | `getRefPropValueDouble(java.lang.String name)`gets a value for a ref prop | +| `double` | `getRefPropValueDouble(java.lang.String name)`
gets a value for a ref prop | | `long` | `getRefPropValueLong(java.lang.String name)` | | `java.lang.String` | `getRefPropValueString(java.lang.String name)` | -| `double` | `getValue()`retrieves the current value of the variable | +| `double` | `getValue()`
retrieves the current value of the variable | | `void` | `setDescription(java.lang.String desc)` | | `void` | `setProperties(PHXRefProperty[] v)` | -| `void` | `setReference(java.lang.String ref)`sets the value for the reference string. | -| `void` | `setRefPropValue(java.lang.String name, - boolean value)` | -| `void` | `setRefPropValue(java.lang.String name, - double value)`sets a value for a ref prop | -| `void` | `setRefPropValue(java.lang.String name, - long value)` | -| `void` | `setRefPropValue(java.lang.String name, - java.lang.String value)` | -| `void` | `setValue(double v)`sets the value for the variable | -| `java.lang.String` | `toString()`converts to a string | -| `PHXStringBuffer` | `toString2()`converts to a PHXStringBuffer | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXReference +| `void` | `setReference(java.lang.String ref)`
sets the value for the reference string. | +| `void` | `setRefPropValue(java.lang.String name, boolean value)` | +| `void` | `setRefPropValue(java.lang.String name, double value)`
sets a value for a ref prop | +| `void` | `setRefPropValue(java.lang.String name, long value)` | +| `void` | `setRefPropValue(java.lang.String name, java.lang.String value)` | +| `void` | `setValue(double v)`
sets the value for the variable | +| `java.lang.String` | `toString()`
converts to a string | +| `PHXStringBuffer` | `toString2()`
converts to a PHXStringBuffer | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXReference ```java public PHXReference() ``` constructor -============ METHOD DETAIL ========== -- ### Method Detail -- #### getValue +## Method Detail + +### getValue ```java public double getValue() ``` retrieves the current value of the variable + **Returns:** -: the value of the variable +- the value of the variable -- #### setValue +### setValue ```java public void setValue(double v) ``` sets the value for the variable + **Parameters:** -: `v`- the value +- `v`- the value -- #### getReference +### getReference ```java public java.lang.String getReference() ``` -retrieves the current reference string. This is a client-supplied - value describing what the reference value points to. +retrieves the current reference string. This is a client-supplied value describing what the reference value points to. + **Returns:** -: the reference string +- the reference string -- #### setReference +### setReference ```java public void setReference(java.lang.String ref) ``` -sets the value for the reference string. This should only be - called by the client application, e.g. ModelCenter. +sets the value for the reference string. This should only be called by the client application, e.g. ModelCenter. + **Parameters:** -: `ref`- the reference string +- `ref`- the reference string -- #### getProperties +### getProperties ```java public PHXRefProperty[] getProperties() ``` retrieves the properties of the variable + **Returns:** -: the properties of the variable +- the properties of the variable -- #### setProperties +### setProperties ```java public void setProperties(PHXRefProperty[] v) ``` -- #### createRefProp +### createRefProp ```java public IPHXRefPropInfo createRefProp(java.lang.String name, java.lang.String type) ``` adds a property to the variable + **Parameters:** -: `name`- the name of the property -: `type`- property type: "long", "double", "boolean", or "string" +- `name`- the name of the property +- `type`- property type: "long", "double", "boolean", or "string" -- #### getRefPropValueDouble +### getRefPropValueDouble ```java public double getRefPropValueDouble(java.lang.String name) throws PHXTypeMismatchException ``` gets a value for a ref prop + **Parameters:** -: `name`- the name of the property +- `name`- the name of the property + **Returns:** -: the value of the property +- the value of the property + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### getRefPropValueLong +### getRefPropValueLong ```java public long getRefPropValueLong(java.lang.String name) throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### getRefPropValueBoolean +### getRefPropValueBoolean ```java public boolean getRefPropValueBoolean(java.lang.String name) throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### getRefPropValueString +### getRefPropValueString ```java public java.lang.String getRefPropValueString(java.lang.String name) throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -196,13 +208,15 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` sets a value for a ref prop + **Parameters:** -: `name`- the name of the property -: `value`- the value of the property +- `name`- the name of the property +- `value`- the value of the property + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -210,10 +224,11 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -221,10 +236,11 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -232,90 +248,105 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- `PHXTypeMismatchException` -- #### _getProperty +### _getProperty ```java public PHXRefProperty _getProperty(java.lang.String name) ``` retrieves a named property + **Parameters:** -: `name`- the name of the property +- `name`- the name of the property + **Returns:** -: the property matching the specified name +- the property matching the specified name -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2() ``` converts to a PHXStringBuffer + **Specified by:** -: `toString2`in interface`IPHXType2` +- `toString2` in interface [`IPHXType2`](IPHXType2.md) + **Returns:** -: a PHXStringBuffer +- a PHXStringBuffer -- #### toString +### toString ```java public java.lang.String toString() ``` converts to a string + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString`in class`java.lang.Object` + **Returns:** -: a string +- a string -- #### fromString2 +### fromString2 ```java public void fromString2(PHXStringBuffer s) ``` converts from a PHXStringBuffer + **Specified by:** -: `fromString2`in interface`IPHXType2` +- `fromString2` in interface [`IPHXType2`](IPHXType2.md) + **Parameters:** -: `s`- the PHXStringBuffer value +- `s`- the PHXStringBuffer value -- #### fromString +### fromString ```java public void fromString(java.lang.String s) ``` converts from a string + **Specified by:** -: `fromString`in interface`IPHXType` +- `fromString` in interface [`IPHXType`](IPHXType.md) + **Parameters:** -: `s`- the string value +- `s`- the string value -- #### getDescription +### getDescription ```java public java.lang.String getDescription() ``` -- #### setDescription +### setDescription ```java public void setDescription(java.lang.String desc) ``` -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Specified by:** -: `Accept`in interface`IPHXType2` +- `Accept` in interface [`IPHXType2`](IPHXType2.md) + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. -========= END OF CLASS DATA ========= \ No newline at end of file +- The results of the visit. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md index 853480cb51..c39e2de262 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXReferenceArray.md @@ -1,202 +1,197 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXReferenceArray -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXReferenceArray -- **All Implemented Interfaces:** -: [IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html) +# Class PHXReferenceArray + + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXReferenceArray +``` + +**All Implemented Interfaces:** +- [IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html) --- +**Declaration:** ```java public class PHXReferenceArray extends java.lang.Object implements IPHXAlwaysWriteable ``` -The Phoenix type for references. This class matches up to - references in ModelCenter. Users may define their own - properties in addition to the value property. + +The type for references. This class matches up to references in ModelCenter. Users may define their own properties in addition to the value property. + - **value**: double[] - **length**: int - **autoGrow**: boolean - **properties**: PHXRefArrayProperty[] - **reference**: String[] -**Author:** -: Woyak- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXReferenceArray()`constructor | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `IPHXRefPropInfo` | `createRefProp(java.lang.String name, - java.lang.String type)`adds a ref prop to the variable. | -| `boolean` | `getAutoGrow()`retrieves the autoGrow value | -| `int` | `getLength()`retrieves the number of references in the array | -| `PHXRefArrayProperty[]` | `getProperties()`get-set function for AServer | -| `java.lang.String[]` | `getReference()`retrieves the current reference string. | +| `IPHXRefPropInfo` | `createRefProp(java.lang.String name, java.lang.String type)`
adds a ref prop to the variable. | +| `boolean` | `getAutoGrow()`
retrieves the autoGrow value | +| `int` | `getLength()`
retrieves the number of references in the array | +| `PHXRefArrayProperty[]` | `getProperties()`
get-set function for AServer | +| `java.lang.String[]` | `getReference()`
retrieves the current reference string. | | `java.lang.String` | `getReference(int i)` | -| `boolean` | `getRefPropValueBoolean(java.lang.String name, - int index)` | -| `double` | `getRefPropValueDouble(java.lang.String name, - int index)`gets a value for a ref prop | -| `long` | `getRefPropValueLong(java.lang.String name, - int index)` | -| `java.lang.String` | `getRefPropValueString(java.lang.String name, - int index)` | -| `double[]` | `getValues()`retrieves the current value of the variable | -| `void` | `setAutoGrow(boolean flag)`sets the autoGrow value. | -| `void` | `setLength(int v)`sets the number of references | +| `boolean` | `getRefPropValueBoolean(java.lang.String name, int index)` | +| `double` | `getRefPropValueDouble(java.lang.String name, int index)`
gets a value for a ref prop | +| `long` | `getRefPropValueLong(java.lang.String name, int index)` | +| `java.lang.String` | `getRefPropValueString(java.lang.String name, int index)` | +| `double[]` | `getValues()`
retrieves the current value of the variable | +| `void` | `setAutoGrow(boolean flag)`
sets the autoGrow value. | +| `void` | `setLength(int v)`
sets the number of references | | `void` | `setProperties(PHXRefArrayProperty[] p)` | -| `void` | `setReference(int i, - java.lang.String ref)` | -| `void` | `setReference(java.lang.String[] ref)`sets the value for the reference string. | -| `void` | `setRefPropValue(java.lang.String name, - int index, - boolean value)` | -| `void` | `setRefPropValue(java.lang.String name, - int index, - double value)`sets a value for a ref prop | -| `void` | `setRefPropValue(java.lang.String name, - int index, - long value)` | -| `void` | `setRefPropValue(java.lang.String name, - int index, - java.lang.String value)` | -| `void` | `setValues(double[] v)`sets the value for the variable | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXReferenceArray +| `void` | `setReference(int i, java.lang.String ref)` | +| `void` | `setReference(java.lang.String[] ref)`
sets the value for the reference string. | +| `void` | `setRefPropValue(java.lang.String name, int index, boolean value)` | +| `void` | `setRefPropValue(java.lang.String name, int index, double value)`
sets a value for a ref prop | +| `void` | `setRefPropValue(java.lang.String name, int index, long value)` | +| `void` | `setRefPropValue(java.lang.String name, int index, java.lang.String value)` | +| `void` | `setValues(double[] v)`
sets the value for the variable | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXReferenceArray ```java public PHXReferenceArray() ``` constructor -============ METHOD DETAIL ========== -- ### Method Detail -- #### getProperties +## Method Detail + +### getProperties ```java public PHXRefArrayProperty[] getProperties() ``` -get-set function for AServer +get-set function for MCRE -- #### setProperties +### setProperties ```java public void setProperties(PHXRefArrayProperty[] p) ``` -- #### getValues +### getValues ```java public double[] getValues() ``` retrieves the current value of the variable + **Returns:** -: the value of the variable +- the value of the variable -- #### setValues +### setValues ```java public void setValues(double[] v) ``` sets the value for the variable + **Parameters:** -: `v`- the value +- `v`- the value -- #### getReference +### getReference ```java public java.lang.String[] getReference() ``` -retrieves the current reference string. This is a client-supplied - value describing what the reference value points to. +retrieves the current reference string. This is a client-supplied value describing what the reference value points to. + **Returns:** -: the reference string +- the reference string -- #### getReference +### getReference ```java public java.lang.String getReference(int i) ``` -- #### setReference +### setReference ```java public void setReference(java.lang.String[] ref) ``` -sets the value for the reference string. This should only be - called by the client application, e.g. ModelCenter. +sets the value for the reference string. This should only be called by the client application, e.g. ModelCenter. + **Parameters:** -: `ref`- the reference string +- `ref`- the reference string -- #### setReference +### setReference ```java public void setReference(int i, java.lang.String ref) ``` -- #### getLength +### getLength ```java public int getLength() ``` retrieves the number of references in the array + **Returns:** -: the number of references +- the number of references -- #### setLength +### setLength ```java public void setLength(int v) ``` sets the number of references + **Parameters:** -: `v`- the number of references +- `v`- the number of references -- #### getAutoGrow +### getAutoGrow ```java public boolean getAutoGrow() ``` retrieves the autoGrow value + **Returns:** -: true or false +- true or false -- #### setAutoGrow +### setAutoGrow ```java public void setAutoGrow(boolean flag) ``` -sets the autoGrow value. If true, the client application - is allowed to resize the array as needed. +sets the autoGrow value. If true, the client application is allowed to resize the array as needed. + **Parameters:** -: `flag`- true or false +- `flag`- true or false -- #### createRefProp +### createRefProp ```java public IPHXRefPropInfo createRefProp(java.lang.String name, java.lang.String type) ``` adds a ref prop to the variable. + **Parameters:** -: `name`- the name of the property -: `type`- property type: "long", "double", "boolean", or "string" +- `name`- the name of the property +- `type`- property type: "long", "double", "boolean", or "string" -- #### getRefPropValueDouble +### getRefPropValueDouble ```java public double getRefPropValueDouble(java.lang.String name, @@ -204,15 +199,18 @@ public double getRefPropValueDouble(java.lang.String name, throws PHXTypeMismatchException ``` gets a value for a ref prop + **Parameters:** -: `name`- the name of the property -: `index`- the array element +- `name`- the name of the property +- `index`- the array element + **Returns:** -: the value of the property +- the value of the property + **Throws:** -: `PHXTypeMismatchException` +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) -- #### getRefPropValueLong +### getRefPropValueLong ```java public long getRefPropValueLong(java.lang.String name, @@ -220,10 +218,11 @@ public long getRefPropValueLong(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) -- #### getRefPropValueBoolean +### getRefPropValueBoolean ```java public boolean getRefPropValueBoolean(java.lang.String name, @@ -231,10 +230,11 @@ public boolean getRefPropValueBoolean(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) -- #### getRefPropValueString +### getRefPropValueString ```java public java.lang.String getRefPropValueString(java.lang.String name, @@ -242,10 +242,11 @@ public java.lang.String getRefPropValueString(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -254,14 +255,16 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` sets a value for a ref prop + **Parameters:** -: `name`- the name of the property -: `index`- the array element -: `value`- the value of the property +- `name`- the name of the property +- `index`- the array element +- `value`- the value of the property + **Throws:** -: `PHXTypeMismatchException` +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -270,10 +273,11 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -282,10 +286,11 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) -- #### setRefPropValue +### setRefPropValue ```java public void setRefPropValue(java.lang.String name, @@ -294,6 +299,6 @@ public void setRefPropValue(java.lang.String name, throws PHXTypeMismatchException ``` + **Throws:** -: `PHXTypeMismatchException` -========= END OF CLASS DATA ========= \ No newline at end of file +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md index bc1e4421f9..ec4d3a1155 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXScriptObject.md @@ -1,464 +1,456 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXScriptObject -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXScriptObject -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class PHXScriptObject + + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXScriptObject +``` + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md) --- +**Declaration:** ```java public class PHXScriptObject extends PHXSimpleType ``` -The PHX type for object variables. - This class holds an instance of PHXObjectHost that wraps around - a Java or Python object, and uses introspection to get and set - values of the internal object.- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +The type for object variables. + +This class holds an instance of `PHXObjectHost` that wraps around a Java or Python object, and uses introspection to get and set values of the internal object. -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXScriptObject()`Creates a new instance of PHXScriptObject | -========== METHOD SUMMARY =========== -- ### Method Summary + +### Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `java.lang.Object` | `callMethod(java.lang.String method)`call a method | -| `PHXSimpleType` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `void` | `deleteAllMembers()`delete all members for non-strict type object. | -| `void` | `deleteMember(java.lang.String mIndex)`delete a member for non-strict type object. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromFile(java.lang.String mIndex)`load a file into a file member. | -| `void` | `fromFile(java.lang.String mIndex, - java.lang.String fileName)`load a file into a file member | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`update object using the XML value | -| `void` | `fromString2(PHXStringBuffervalue)`update object using the XML value | -| `void` | `fromXML(java.lang.String xmlStr)`update the object from an XML string | -| `boolean` | `getBooleanArrayMemberValue(java.lang.String mIndex, - int index)`get the value of an 1D boolean array element | -| `boolean` | `getBooleanArrayMemberValue(java.lang.String mIndex, - int[] index)`get the value of a boolean array element | -| `boolean` | `getBooleanMemberValue(java.lang.String mIndex)`gets the value of boolean member | -| `java.lang.String` | `getClassURL()`get the class type. | -| `double` | `getDoubleArrayMemberValue(java.lang.String mIndex, - int index)`get the value of an 1D double array element | -| `double` | `getDoubleArrayMemberValue(java.lang.String mIndex, - int[] index)`get the value of a double array element | -| `double` | `getDoubleMemberValue(java.lang.String mIndex)`gets the value of a double member | -| `java.lang.String` | `getFileName(java.lang.String mIndex)`return name of the data source file | -| `int` | `getIntArrayMemberValue(java.lang.String mIndex, - int index)`get the value of an 1D integer array element | -| `int` | `getIntArrayMemberValue(java.lang.String mIndex, - int[] index)`get the value of an integer array element | -| `java.lang.Object` | `getInternalObject()`get internal Java object that represent the data | -| `int` | `getIntMemberValue(java.lang.String mIndex)`gets the value of an integer member | -| `boolean` | `getIsBinary(java.lang.String mIndex)`return true if the file member contains a binary file | -| `java.lang.String` | `getMemberDescription(java.lang.String mIndex)`get description of the member | -| `int[]` | `getMemberDimensions(java.lang.String mIndex)`get dimensions and size of an array member | -| `java.lang.String` | `getMemberEnumAliases(java.lang.String mIndex)`get enum aliases of the member | -| `java.lang.String` | `getMemberEnumValues(java.lang.String mIndex)`return enum values of the member | -| `int` | `getMemberLength(java.lang.String mIndex)`get length of an 1D array member | -| `int` | `getMemberLength(java.lang.String mIndex, - int dimension)`get length of an array member | -| `java.lang.String[]` | `getMemberList(java.lang.String mIndex)`get a list of child members. | -| `java.lang.String` | `getMemberLowerBound(java.lang.String mIndex)`get lowerBound of a member | -| `int` | `getMemberNumDimensions(java.lang.String mIndex)`get number of dimensions of an array member | -| `java.lang.String` | `getMemberProperty(java.lang.String mIndex, - java.lang.String propertyName)`get value of a property of the member | -| `java.lang.String` | `getMemberType(java.lang.String mIndex)`return type of the member | -| `java.lang.String` | `getMemberUnits(java.lang.String mIndex)`get units of the member | -| `java.lang.String` | `getMemberUpperBound(java.lang.String mIndex)`return upperBound of the member | -| `java.lang.String` | `getMemberValueAsString(java.lang.String mIndex)`gets the value of a member as a string | -| `java.lang.String[]` | `getMethodList()`get a list of methods | -| `java.lang.String` | `getStringArrayMemberValue(java.lang.String mIndex, - int index)`get the value of an 1D String array element | -| `java.lang.String` | `getStringArrayMemberValue(java.lang.String mIndex, - int[] index)`get the value of a string array element | -| `java.lang.String` | `getStringMemberValue(java.lang.String mIndex)`gets the value of string member | -| `boolean` | `hasMember(java.lang.String mIndex)`check if a member exists | -| `boolean` | `hasMemberLowerBound(java.lang.String mIndex)`check if a member has lower bound defined | -| `boolean` | `hasMemberUpperBound(java.lang.String mIndex)`check if a member has lower bound defined | -| `void` | `initialize(com.phoenix_int.object.PHXDataObjectClass pClass)`initialize object variable with the specified class | -| `boolean` | `isNonStrictType()`check whether a class is a non-strict type | -| `void` | `setBaseName(java.lang.String mIndex, - java.lang.String baseName)`set base name for the data source file | -| `void` | `setBooleanArrayMemberValue(java.lang.String mIndex, - int[] index, - boolean value)`sets the value of a boolean array member | -| `void` | `setBooleanArrayMemberValue(java.lang.String mIndex, - int index, - boolean value)`sets the value of an 1D boolean array member | -| `void` | `setBooleanMemberValue(java.lang.String mIndex, - boolean value)`sets the value of a boolean member | -| `void` | `setDoubleArrayMemberValue(java.lang.String mIndex, - int[] index, - double value)`sets the value of a double array member | -| `void` | `setDoubleArrayMemberValue(java.lang.String mIndex, - int index, - double value)`sets the value of a 1D double array member | -| `void` | `setDoubleMemberValue(java.lang.String mIndex, - double value)`sets the value of a double member | -| `void` | `setFileExtension(java.lang.String mIndex, - java.lang.String fileExtension)`set file extesion of the data source file | -| `void` | `setFileName(java.lang.String mIndex, - java.lang.String fileName)`set name of the data source file | -| `void` | `setIntArrayMemberValue(java.lang.String mIndex, - int[] index, - int value)`sets the value of an integer array member | -| `void` | `setIntArrayMemberValue(java.lang.String mIndex, - int index, - int value)`sets the value of an 1D integer array member | -| `void` | `setIntMemberValue(java.lang.String mIndex, - int value)`sets the value of an integer member | -| `void` | `setIsBinary(java.lang.String mIndex, - boolean isBinary)`set binary flag for a file member | -| `void` | `setMember(java.lang.String mIndex, - java.lang.String value, - java.lang.String type)`sets the value of a member. | -| `void` | `setMemberDescription(java.lang.String mIndex, - java.lang.String description)`set description of the member | -| `void` | `setMemberDimensions(java.lang.String mIndex, - int[] dims)`set dimensions of an array member | -| `void` | `setMemberEnumAliases(java.lang.String mIndex, - java.lang.String enumAliases)`set enum aliases of the member | -| `void` | `setMemberEnumValues(java.lang.String mIndex, - java.lang.String enumValues)`set enum values of the member | -| `void` | `setMemberLength(java.lang.String mIndex, - int length)`set length of an 1D array member | -| `void` | `setMemberLength(java.lang.String mIndex, - int length, - int dimension)`set length of an array member | -| `void` | `setMemberLowerBound(java.lang.String mIndex, - java.lang.String lowerBound)`set lowerBound of the member | -| `void` | `setMemberProperty(java.lang.String mIndex, - java.lang.String propertyName, - java.lang.String propertyValue)`set value of a property of the member | -| `void` | `setMemberUnits(java.lang.String mIndex, - java.lang.String units)`set units of the member | -| `void` | `setMemberUpperBound(java.lang.String mIndex, - java.lang.String upperBound)`set upperBound of the member | -| `void` | `setMemberValueFromString(java.lang.String mIndex, - java.lang.String value)`sets the value of a member from string | -| `void` | `setStringArrayMemberValue(java.lang.String mIndex, - int[] index, - java.lang.String value)`sets the value of a string array member | -| `void` | `setStringArrayMemberValue(java.lang.String mIndex, - int index, - java.lang.String value)`sets the value of a 1D string array member | -| `void` | `setStringMemberValue(java.lang.String mIndex, - java.lang.String value)`sets the value of a string member | -| `void` | `toFile(java.lang.String mIndex)`write a file member to a file - file name must have been specified | -| `void` | `toFile(java.lang.String mIndex, - java.lang.String fileName)`write a file member to a file | -| `java.lang.String` | `toString()`get XML representation of the object variable | -| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | -| `java.lang.String` | `toXML()`get XML representation of the object | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXScriptObject +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `java.lang.Object` | `callMethod(java.lang.String method)`
call a method | +| `PHXSimpleType` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `void` | `deleteAllMembers()`
delete all members for non-strict type object. | +| `void` | `deleteMember(java.lang.String mIndex)`
delete a member for non-strict type object. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromFile(java.lang.String mIndex)`
load a file into a file member. | +| `void` | `fromFile(java.lang.String mIndex, java.lang.String fileName)`
load a file into a file member | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
update object using the XML value | +| `void` | `fromString2(PHXStringBuffervalue)`
update object using the XML value | +| `void` | `fromXML(java.lang.String xmlStr)
`update the object from an XML string | +| `boolean` | `getBooleanArrayMemberValue(java.lang.String mIndex, int index)`
get the value of an 1D boolean array element | +| `boolean` | `getBooleanArrayMemberValue(java.lang.String mIndex, int[] index)`
get the value of a boolean array element | +| `boolean` | `getBooleanMemberValue(java.lang.String mIndex)`
gets the value of boolean member | +| `java.lang.String` | `getClassURL()`
get the class type. | +| `double` | `getDoubleArrayMemberValue(java.lang.String mIndex, int index)`
get the value of an 1D double array element | +| `double` | `getDoubleArrayMemberValue(java.lang.String mIndex, int[] index)`
get the value of a double array element | +| `double` | `getDoubleMemberValue(java.lang.String mIndex)`
gets the value of a double member | +| `java.lang.String` | `getFileName(java.lang.String mIndex)`
return name of the data source file | +| `int` | `getIntArrayMemberValue(java.lang.String mIndex, int index)`
get the value of an 1D integer array element | +| `int` | `getIntArrayMemberValue(java.lang.String mIndex, int[] index)`
get the value of an integer array element | +| `java.lang.Object` | `getInternalObject()`
get internal Java object that represent the data | +| `int` | `getIntMemberValue(java.lang.String mIndex)`
gets the value of an integer member | +| `boolean` | `getIsBinary(java.lang.String mIndex)`
return true if the file member contains a binary file | +| `java.lang.String` | `getMemberDescription(java.lang.String mIndex)`
get description of the member | +| `int[]` | `getMemberDimensions(java.lang.String mIndex)`
get dimensions and size of an array member | +| `java.lang.String` | `getMemberEnumAliases(java.lang.String mIndex)`
get enum aliases of the member | +| `java.lang.String` | `getMemberEnumValues(java.lang.String mIndex)`
return enum values of the member | +| `int` | `getMemberLength(java.lang.String mIndex)`
get length of an 1D array member | +| `int` | `getMemberLength(java.lang.String mIndex, int dimension)`
get length of an array member | +| `java.lang.String[]` | `getMemberList(java.lang.String mIndex)`
get a list of child members. | +| `java.lang.String` | `getMemberLowerBound(java.lang.String mIndex)`
get lowerBound of a member | +| `int` | `getMemberNumDimensions(java.lang.String mIndex)`
get number of dimensions of an array member | +| `java.lang.String` | `getMemberProperty(java.lang.String mIndex, java.lang.String propertyName)`
get value of a property of the member | +| `java.lang.String` | `getMemberType(java.lang.String mIndex)`
return type of the member | +| `java.lang.String` | `getMemberUnits(java.lang.String mIndex)`
get units of the member | +| `java.lang.String` | `getMemberUpperBound(java.lang.String mIndex)`
return upperBound of the member | +| `java.lang.String` | `getMemberValueAsString(java.lang.String mIndex)`
gets the value of a member as a string | +| `java.lang.String[]` | `getMethodList()`
get a list of methods | +| `java.lang.String` | `getStringArrayMemberValue(java.lang.String mIndex, int index)`
get the value of an 1D String array element | +| `java.lang.String` | `getStringArrayMemberValue(java.lang.String mIndex, int[] index)`
get the value of a string array element | +| `java.lang.String` | `getStringMemberValue(java.lang.String mIndex)`
gets the value of string member | +| `boolean` | `hasMember(java.lang.String mIndex)`
check if a member exists | +| `boolean` | `hasMemberLowerBound(java.lang.String mIndex)`
check if a member has lower bound defined | +| `boolean` | `hasMemberUpperBound(java.lang.String mIndex)`
check if a member has lower bound defined | +| `void` | `initialize(com.phoenix_int.object.PHXDataObjectClass pClass)`
initialize object variable with the specified class | +| `boolean` | `isNonStrictType()`
check whether a class is a non-strict type | +| `void` | `setBaseName(java.lang.String mIndex, java.lang.String baseName)`
set base name for the data source file | +| `void` | `setBooleanArrayMemberValue(java.lang.String mIndex, int[] index, boolean value)`
sets the value of a boolean array member | +| `void` | `setBooleanArrayMemberValue(java.lang.String mIndex, int index, boolean value)`
sets the value of an 1D boolean array member | +| `void` | `setBooleanMemberValue(java.lang.String mIndex, boolean value)`
sets the value of a boolean member | +| `void` | `setDoubleArrayMemberValue(java.lang.String mIndex, int[] index, double value)`
sets the value of a double array member | +| `void` | `setDoubleArrayMemberValue(java.lang.String mIndex, int index, double value)`
sets the value of a 1D double array member | +| `void` | `setDoubleMemberValue(java.lang.String mIndex, double value)`
sets the value of a double member | +| `void` | `setFileExtension(java.lang.String mIndex, java.lang.String fileExtension)`
set file extesion of the data source file | +| `void` | `setFileName(java.lang.String mIndex, java.lang.String fileName)`
set name of the data source file | +| `void` | `setIntArrayMemberValue(java.lang.String mIndex, int[] index, int value)`
sets the value of an integer array member | +| `void` | `setIntArrayMemberValue(java.lang.String mIndex, int index, int value)`
sets the value of an 1D integer array member | +| `void` | `setIntMemberValue(java.lang.String mIndex, int value)`
sets the value of an integer member | +| `void` | `setIsBinary(java.lang.String mIndex, boolean isBinary)`
set binary flag for a file member | +| `void` | `setMember(java.lang.String mIndex, java.lang.String value, java.lang.String type)`
sets the value of a member. | +| `void` | `setMemberDescription(java.lang.String mIndex, java.lang.String description)`
set description of the member | +| `void` | `setMemberDimensions(java.lang.String mIndex, int[] dims)`
set dimensions of an array member | +| `void` | `setMemberEnumAliases(java.lang.String mIndex, java.lang.String enumAliases)`
set enum aliases of the member | +| `void` | `setMemberEnumValues(java.lang.String mIndex, java.lang.String enumValues)`
set enum values of the member | +| `void` | `setMemberLength(java.lang.String mIndex, int length)`
set length of an 1D array member | +| `void` | `setMemberLength(java.lang.String mIndex, int length, int dimension)`
set length of an array member | +| `void` | `setMemberLowerBound(java.lang.String mIndex, java.lang.String lowerBound)`
set lowerBound of the member | +| `void` | `setMemberProperty(java.lang.String mIndex, java.lang.String propertyName, java.lang.String propertyValue)`
set value of a property of the member | +| `void` | `setMemberUnits(java.lang.String mIndex, java.lang.String units)`
set units of the member | +| `void` | `setMemberUpperBound(java.lang.String mIndex, java.lang.String upperBound)`
set upperBound of the member | +| `void` | `setMemberValueFromString(java.lang.String mIndex, java.lang.String value)`
sets the value of a member from string | +| `void` | `setStringArrayMemberValue(java.lang.String mIndex, int[] index, java.lang.String value)`
sets the value of a string array member | +| `void` | `setStringArrayMemberValue(java.lang.String mIndex, int index, java.lang.String value)`
sets the value of a 1D string array member | +| `void` | `setStringMemberValue(java.lang.String mIndex, java.lang.String value)`
sets the value of a string member | +| `void` | `toFile(java.lang.String mIndex)`
write a file member to a file file name must have been specified | +| `void` | `toFile(java.lang.String mIndex, java.lang.String fileName)`
write a file member to a file | +| `java.lang.String` | `toString()`
get XML representation of the object variable | +| `PHXStringBuffer` | `toString2()`
converts the variable to a PHXStringBuffer | +| `java.lang.String` | `toXML()`
get XML representation of the object | + +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` +### Constructor Detail + +#### PHXScriptObject ```java public PHXScriptObject() ``` Creates a new instance of PHXScriptObject -============ METHOD DETAIL ========== -- ### Method Detail -- #### initialize +### Method Detail + +#### initialize ```java public void initialize(com.phoenix_int.object.PHXDataObjectClass pClass) throws java.io.IOException ``` initialize object variable with the specified class + **Parameters:** -: `pClass`- class information +- `pClass`- class information + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### toString +#### toString ```java public java.lang.String toString() ``` get XML representation of the object variable + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: XML string +- XML string -- #### fromString +#### fromString ```java public void fromString(java.lang.String value) ``` update object using the XML value + **Parameters:** -: `value`- XML string for the object +- `value`- XML string for the object -- #### toString2 +#### toString2 ```java public PHXStringBuffer toString2() ``` converts the variable to a PHXStringBuffer + **Returns:** -: the PHXStringBuffer representation of the variable +- the PHXStringBuffer representation of the variable -- #### fromString2 +#### fromString2 ```java public void fromString2(PHXStringBuffer value) ``` update object using the XML value + **Parameters:** -: `value`- the value to convert +- `value`- the value to convert -- #### getClassURL +#### getClassURL ```java public java.lang.String getClassURL() ``` get the class type. The class type is defined in a URL format + **Returns:** -: class type +- class type -- #### getMemberValueAsString +#### getMemberValueAsString ```java public java.lang.String getMemberValueAsString(java.lang.String mIndex) ``` gets the value of a member as a string + **Parameters:** -: `mIndex`- member index (e.g., member1, grp1.member1, member1[1], member1[1,2]) +- `mIndex`- member index (e.g., `member1, grp1.member1, member1[1], member1[1,2]`) + **Returns:** -: the value of the variable +- the value of the variable -- #### getDoubleMemberValue +#### getDoubleMemberValue ```java public double getDoubleMemberValue(java.lang.String mIndex) ``` gets the value of a double member + **Parameters:** -: `mIndex`- member index +- `mIndex`- member index + **Returns:** -: the value of the variable +- the value of the variable -- #### getIntMemberValue +#### getIntMemberValue ```java public int getIntMemberValue(java.lang.String mIndex) ``` gets the value of an integer member + **Parameters:** -: `mIndex`- member index +- `mIndex`- member index + **Returns:** -: the value of the variable +- the value of the variable -- #### getBooleanMemberValue +#### getBooleanMemberValue ```java public boolean getBooleanMemberValue(java.lang.String mIndex) ``` gets the value of boolean member + **Parameters:** -: `mIndex`- member index +- `mIndex`- member index + **Returns:** -: the value of the variable +- the value of the variable -- #### getStringMemberValue +#### getStringMemberValue ```java public java.lang.String getStringMemberValue(java.lang.String mIndex) ``` gets the value of string member + **Parameters:** -: `mIndex`- member index +- `mIndex`- member index + **Returns:** -: the value of the variable +- the value of the variable -- #### getDoubleArrayMemberValue +#### getDoubleArrayMemberValue ```java public double getDoubleArrayMemberValue(java.lang.String mIndex, int index) ``` get the value of an 1D double array element + **Parameters:** -: `mIndex`- member index +- `mIndex`- member index + **Returns:** -: the value of the variable +- the value of the variable -- #### getDoubleArrayMemberValue +#### getDoubleArrayMemberValue ```java public double getDoubleArrayMemberValue(java.lang.String mIndex, int[] index) ``` get the value of a double array element + **Parameters:** -: `mIndex`- member index -: `index`- array index +- `mIndex`- member index +- `index`- array index + **Returns:** -: the value of the variable +- the value of the variable -- #### getIntArrayMemberValue +#### getIntArrayMemberValue ```java public int getIntArrayMemberValue(java.lang.String mIndex, int index) ``` get the value of an 1D integer array element + **Parameters:** -: `mIndex`- member index -: `index`- array index +- `mIndex`- member index +- `index`- array index + **Returns:** -: the value of the variable +- the value of the variable -- #### getIntArrayMemberValue +#### getIntArrayMemberValue ```java public int getIntArrayMemberValue(java.lang.String mIndex, int[] index) ``` get the value of an integer array element + **Parameters:** -: `mIndex`- member index -: `index`- array index +- `mIndex`- member index +- `index`- array index + **Returns:** -: the value of the variable +- the value of the variable -- #### getBooleanArrayMemberValue +#### getBooleanArrayMemberValue ```java public boolean getBooleanArrayMemberValue(java.lang.String mIndex, int index) ``` get the value of an 1D boolean array element + **Parameters:** -: `mIndex`- member index -: `index`- array index +- `mIndex`- member index +- `index`- array index + **Returns:** -: the value of the variable +- the value of the variable -- #### getBooleanArrayMemberValue +#### getBooleanArrayMemberValue ```java public boolean getBooleanArrayMemberValue(java.lang.String mIndex, int[] index) ``` get the value of a boolean array element + **Parameters:** -: `mIndex`- member index -: `index`- array index +- `mIndex`- member index +- `index`- array index + **Returns:** -: the value of the variable +- the value of the variable -- #### getStringArrayMemberValue +#### getStringArrayMemberValue ```java public java.lang.String getStringArrayMemberValue(java.lang.String mIndex, int index) ``` get the value of an 1D String array element + **Parameters:** -: `mIndex`- member index -: `index`- array index +- `mIndex`- member index +- `index`- array index + **Returns:** -: the value of the variable +- the value of the variable -- #### getStringArrayMemberValue +#### getStringArrayMemberValue ```java public java.lang.String getStringArrayMemberValue(java.lang.String mIndex, int[] index) ``` get the value of a string array element + **Parameters:** -: `mIndex`- member index -: `index`- array index +- `mIndex`- member index +- `index`- array index + **Returns:** -: the value of the variable +- the value of the variable -- #### setMemberValueFromString +#### setMemberValueFromString ```java public void setMemberValueFromString(java.lang.String mIndex, java.lang.String value) ``` sets the value of a member from string + **Parameters:** -: `mIndex`- member index -: `value`- the value of the member +- `mIndex`- member index +- `value`- the value of the member -- #### setDoubleMemberValue +#### setDoubleMemberValue ```java public void setDoubleMemberValue(java.lang.String mIndex, double value) ``` sets the value of a double member + **Parameters:** -: `mIndex`- member index -: `value`- value of the member +- `mIndex`- member index +- `value`- value of the member -- #### setIntMemberValue +#### setIntMemberValue ```java public void setIntMemberValue(java.lang.String mIndex, int value) ``` sets the value of an integer member + **Parameters:** -: `mIndex`- member index -: `value`- value of the member +- `mIndex`- member index +- `value`- value of the member -- #### setBooleanMemberValue +#### setBooleanMemberValue ```java public void setBooleanMemberValue(java.lang.String mIndex, boolean value) ``` sets the value of a boolean member + **Parameters:** -: `mIndex`- member index -: `value`- value of the member +- `mIndex`- member index +- `value`- value of the member -- #### setStringMemberValue +#### setStringMemberValue ```java public void setStringMemberValue(java.lang.String mIndex, java.lang.String value) ``` sets the value of a string member + **Parameters:** -: `mIndex`- member index -: `value`- value of the member +- `mIndex`- member index +- `value`- value of the member -- #### setDoubleArrayMemberValue +#### setDoubleArrayMemberValue ```java public void setDoubleArrayMemberValue(java.lang.String mIndex, @@ -466,12 +458,13 @@ public void setDoubleArrayMemberValue(java.lang.String mIndex, double value) ``` sets the value of a 1D double array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setDoubleArrayMemberValue +#### setDoubleArrayMemberValue ```java public void setDoubleArrayMemberValue(java.lang.String mIndex, @@ -479,12 +472,13 @@ public void setDoubleArrayMemberValue(java.lang.String mIndex, double value) ``` sets the value of a double array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setIntArrayMemberValue +#### setIntArrayMemberValue ```java public void setIntArrayMemberValue(java.lang.String mIndex, @@ -492,12 +486,13 @@ public void setIntArrayMemberValue(java.lang.String mIndex, int value) ``` sets the value of an 1D integer array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setIntArrayMemberValue +#### setIntArrayMemberValue ```java public void setIntArrayMemberValue(java.lang.String mIndex, @@ -505,12 +500,13 @@ public void setIntArrayMemberValue(java.lang.String mIndex, int value) ``` sets the value of an integer array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setBooleanArrayMemberValue +#### setBooleanArrayMemberValue ```java public void setBooleanArrayMemberValue(java.lang.String mIndex, @@ -518,12 +514,13 @@ public void setBooleanArrayMemberValue(java.lang.String mIndex, boolean value) ``` sets the value of an 1D boolean array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setBooleanArrayMemberValue +#### setBooleanArrayMemberValue ```java public void setBooleanArrayMemberValue(java.lang.String mIndex, @@ -531,12 +528,13 @@ public void setBooleanArrayMemberValue(java.lang.String mIndex, boolean value) ``` sets the value of a boolean array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setStringArrayMemberValue +#### setStringArrayMemberValue ```java public void setStringArrayMemberValue(java.lang.String mIndex, @@ -544,12 +542,13 @@ public void setStringArrayMemberValue(java.lang.String mIndex, java.lang.String value) ``` sets the value of a 1D string array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setStringArrayMemberValue +#### setStringArrayMemberValue ```java public void setStringArrayMemberValue(java.lang.String mIndex, @@ -557,119 +556,128 @@ public void setStringArrayMemberValue(java.lang.String mIndex, java.lang.String value) ``` sets the value of a string array member + **Parameters:** -: `mIndex`- member index -: `index`- array index -: `value`- value of the member +- `mIndex`- member index +- `index`- array index +- `value`- value of the member -- #### setMember +#### setMember ```java public void setMember(java.lang.String mIndex, java.lang.String value, java.lang.String type) ``` -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. +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 +- `mIndex`- member index +- `value`- the value of the member +- `type`- type of the member -- #### deleteMember +#### deleteMember ```java public void deleteMember(java.lang.String mIndex) ``` -delete a member for non-strict type object. An exception will - be thrown for strict types +delete a member for non-strict type object. An exception will be thrown for strict types + **Parameters:** -: `mIndex`- member index +- `mIndex`- member index -- #### deleteAllMembers +#### deleteAllMembers ```java public void deleteAllMembers() ``` -delete all members for non-strict type object. An exception will - be thrown for strict types +delete all members for non-strict type object. An exception will be thrown for strict types -- #### callMethod +#### callMethod ```java public java.lang.Object callMethod(java.lang.String method) ``` call a method + **Parameters:** -: `method`- name of the method +- `method`- name of the method + **Returns:** -: primitives object (e.g., java.lang.Double) or - array of primitives (e.g., double[]) +- primitives object (e.g., `java.lang.Double`) or array of primitives (e.g., `double[]`) -- #### isNonStrictType +#### isNonStrictType ```java public boolean isNonStrictType() ``` check whether a class is a non-strict type + **Returns:** -: true if the class is a non-strict type +- true if the class is a non-strict type -- #### toXML +#### toXML ```java public java.lang.String toXML() ``` get XML representation of the object + **Returns:** -: XML representation of the object +- XML representation of the object -- #### fromXML +#### fromXML ```java public void fromXML(java.lang.String xmlStr) ``` update the object from an XML string + **Parameters:** -: `xmlStr`- content of an object in XML format +- `xmlStr`- content of an object in XML format -- #### hasMember +#### hasMember ```java public boolean hasMember(java.lang.String mIndex) ``` check if a member exists + **Parameters:** -: `mIndex`- member name +- `mIndex`- member name + **Returns:** -: true if the member exists +- `true` if the member exists -- #### getMemberLength +#### getMemberLength ```java public int getMemberLength(java.lang.String mIndex, int dimension) ``` get length of an array member + **Parameters:** -: `mIndex`- name of the member -: `dimension`- dimension id of the array member +- `mIndex`- name of the member +- `dimension`- dimension id of the array member + **Returns:** -: length of the array member +- length of the array member -- #### getMemberLength +#### getMemberLength ```java public int getMemberLength(java.lang.String mIndex) ``` get length of an 1D array member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: length of the array member +- length of the array member -- #### setMemberLength +#### setMemberLength ```java public void setMemberLength(java.lang.String mIndex, @@ -677,246 +685,278 @@ public void setMemberLength(java.lang.String mIndex, int dimension) ``` set length of an array member + **Parameters:** -: `mIndex`- name of the member -: `length`- of the array -: `dimension`- dimension id of the array member +- `mIndex`- name of the member +- `length`- of the array +- `dimension`- dimension id of the array member -- #### setMemberLength +#### setMemberLength ```java public void setMemberLength(java.lang.String mIndex, int length) ``` set length of an 1D array member + **Parameters:** -: `mIndex`- name of the member -: `length`- of the array +- `mIndex`- name of the member +- `length`- of the array -- #### setMemberDimensions +#### setMemberDimensions ```java public void setMemberDimensions(java.lang.String mIndex, int[] dims) ``` set dimensions of an array member + **Parameters:** -: `mIndex`- name of the member -: `dims`- length of the array +- `mIndex`- name of the member +- `dims`- length of the array -- #### getMemberNumDimensions +#### getMemberNumDimensions ```java public int getMemberNumDimensions(java.lang.String mIndex) ``` get number of dimensions of an array member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### getMemberDimensions +#### getMemberDimensions ```java public int[] getMemberDimensions(java.lang.String mIndex) ``` get dimensions and size of an array member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### getMemberList +#### getMemberList ```java public java.lang.String[] getMemberList(java.lang.String mIndex) ``` get a list of child members. + **Parameters:** -: `mIndex`- name of the parent member +- `mIndex`- name of the parent member + **Returns:** -: String array of child names +- String array of child names -- #### getMemberType +#### getMemberType ```java public java.lang.String getMemberType(java.lang.String mIndex) ``` return type of the member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### getMethodList +#### getMethodList ```java public java.lang.String[] getMethodList() ``` get a list of methods + **Returns:** -: String array of methods +- String array of methods -- #### hasMemberLowerBound +#### hasMemberLowerBound ```java public boolean hasMemberLowerBound(java.lang.String mIndex) ``` check if a member has lower bound defined + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: true if the member has lower bound defined +- `true` if the member has lower bound defined -- #### hasMemberUpperBound +#### hasMemberUpperBound ```java public boolean hasMemberUpperBound(java.lang.String mIndex) ``` check if a member has lower bound defined + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: true if the member has upper bound defined +- `true` if the member has upper bound defined -- #### getMemberLowerBound +#### getMemberLowerBound ```java public java.lang.String getMemberLowerBound(java.lang.String mIndex) ``` get lowerBound of a member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: lowerBound of the member +- lowerBound of the member -- #### setMemberLowerBound +#### setMemberLowerBound ```java public void setMemberLowerBound(java.lang.String mIndex, java.lang.String lowerBound) ``` set lowerBound of the member + **Parameters:** -: `mIndex`- name of the member -: `lowerBound`- lower bound +- `mIndex`- name of the member +- `lowerBound`- lower bound -- #### getMemberUpperBound +#### getMemberUpperBound ```java public java.lang.String getMemberUpperBound(java.lang.String mIndex) ``` return upperBound of the member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### setMemberUpperBound +#### setMemberUpperBound ```java public void setMemberUpperBound(java.lang.String mIndex, java.lang.String upperBound) ``` set upperBound of the member + **Parameters:** -: `mIndex`- name of the member -: `upperBound`- upper bound +- `mIndex`- name of the member +- `upperBound`- upper bound -- #### getMemberEnumValues +#### getMemberEnumValues ```java public java.lang.String getMemberEnumValues(java.lang.String mIndex) ``` return enum values of the member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: enum values of the member as a comma separated string +- enum values of the member as a comma separated string -- #### setMemberEnumValues +#### setMemberEnumValues ```java public void setMemberEnumValues(java.lang.String mIndex, java.lang.String enumValues) ``` set enum values of the member + **Parameters:** -: `mIndex`- name of the member -: `enumValues`- enumerated values as a comma separated string +- `mIndex`- name of the member +- `enumValues`- enumerated values as a comma separated string -- #### getMemberEnumAliases +#### getMemberEnumAliases ```java public java.lang.String getMemberEnumAliases(java.lang.String mIndex) ``` get enum aliases of the member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: enum aliases of the member as a comma separated string +- enum aliases of the member as a comma separated string -- #### setMemberEnumAliases +#### setMemberEnumAliases ```java public void setMemberEnumAliases(java.lang.String mIndex, java.lang.String enumAliases) ``` set enum aliases of the member + **Parameters:** -: `mIndex`- name of the member -: `enumAliases`- enumerated aliases as a comma separated string +- `mIndex`- name of the member +- `enumAliases`- enumerated aliases as a comma separated string -- #### getMemberDescription +#### getMemberDescription ```java public java.lang.String getMemberDescription(java.lang.String mIndex) ``` get description of the member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: description of the member +- description of the member -- #### setMemberDescription +#### setMemberDescription ```java public void setMemberDescription(java.lang.String mIndex, java.lang.String description) ``` set description of the member + **Parameters:** -: `mIndex`- name of the member -: `description`- +- `mIndex`- name of the member +- `description`- -- #### getMemberUnits +#### getMemberUnits ```java public java.lang.String getMemberUnits(java.lang.String mIndex) ``` get units of the member + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member + **Returns:** -: units of the member +- units of the member -- #### setMemberUnits +#### setMemberUnits ```java public void setMemberUnits(java.lang.String mIndex, java.lang.String units) ``` set units of the member + **Parameters:** -: `mIndex`- name of the member -: `units`- +- `mIndex`- name of the member +- `units`- -- #### getMemberProperty +#### getMemberProperty ```java public java.lang.String getMemberProperty(java.lang.String mIndex, java.lang.String propertyName) ``` get value of a property of the member + **Parameters:** -: `mIndex`- name of the member -: `propertyName`- name of the property +- `mIndex`- name of the member +- `propertyName`- name of the property + **Returns:** -: value of a property of the member +- value of a property of the member -- #### setMemberProperty +#### setMemberProperty ```java public void setMemberProperty(java.lang.String mIndex, @@ -924,183 +964,198 @@ public void setMemberProperty(java.lang.String mIndex, java.lang.String propertyValue) ``` set value of a property of the member + **Parameters:** -: `mIndex`- name of the member -: `propertyName`- name of the property -: `propertyValue`- value of the property +- `mIndex`- name of the member +- `propertyName`- name of the property +- `propertyValue`- value of the property -- #### fromFile +#### fromFile ```java public void fromFile(java.lang.String mIndex, java.lang.String fileName) ``` load a file into a file member + **Parameters:** -: `mIndex`- name of the member -: `fileName`- source file name +- `mIndex`- name of the member +- `fileName`- source file name -- #### fromFile +#### fromFile ```java public void fromFile(java.lang.String mIndex) ``` -load a file into a file member. - The file name must have been specified by setFileName. +load a file into a file member. The file name must have been specified by `setFileName`. + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### toFile +#### toFile ```java public void toFile(java.lang.String mIndex, java.lang.String fileName) ``` write a file member to a file + **Parameters:** -: `mIndex`- name of the member -: `fileName`- destination file name +- `mIndex`- name of the member +- `fileName`- destination file name -- #### toFile +#### toFile ```java public void toFile(java.lang.String mIndex) ``` -write a file member to a file - file name must have been specified +write a file member to a file file name must have been specified + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### getIsBinary +#### getIsBinary ```java public boolean getIsBinary(java.lang.String mIndex) ``` return true if the file member contains a binary file + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### setIsBinary +#### setIsBinary ```java public void setIsBinary(java.lang.String mIndex, boolean isBinary) ``` set binary flag for a file member + **Parameters:** -: `mIndex`- name of the member -: `isBinary`- binary flag +- `mIndex`- name of the member +- `isBinary`- binary flag -- #### getFileName +#### getFileName ```java public java.lang.String getFileName(java.lang.String mIndex) ``` return name of the data source file + **Parameters:** -: `mIndex`- name of the member +- `mIndex`- name of the member -- #### setFileName +#### setFileName ```java public void setFileName(java.lang.String mIndex, java.lang.String fileName) ``` set name of the data source file + **Parameters:** -: `mIndex`- name of the member -: `fileName`- file name +- `mIndex`- name of the member +- `fileName`- file name -- #### setFileExtension +#### setFileExtension ```java public void setFileExtension(java.lang.String mIndex, java.lang.String fileExtension) ``` set file extesion of the data source file + **Parameters:** -: `mIndex`- name of the member -: `fileExtension`- file extension +- `mIndex`- name of the member +- `fileExtension`- file extension -- #### setBaseName +#### setBaseName ```java public void setBaseName(java.lang.String mIndex, java.lang.String baseName) ``` set base name for the data source file + **Parameters:** -: `mIndex`- name of the member -: `baseName`- the new base name +- `mIndex`- name of the member +- `baseName`- the new base name -- #### getInternalObject +#### getInternalObject ```java public java.lang.Object getInternalObject() ``` get internal Java object that represent the data + **Returns:** -: internal Java object that represent the actual data +- internal Java object that represent the actual data -- #### equalsNatural +#### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare`- + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. -- #### fromObject +#### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [PHXInvalidTypeException](PHXInvalidTypeException.md) + + NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md)- if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +#### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +#### createCopy ```java public PHXSimpleType createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md index 4063e6beae..999955d25b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleArray.md @@ -1,14 +1,19 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXSimpleArray -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXSimpleArray -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable +# Class PHXSimpleArray`` + + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXSimpleArray +``` + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md),[IPHXUnits](IPHXUnits.md), java.lang.Iterable`` + **Direct Known Subclasses:** -: [PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html),[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html),[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html),[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html),[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html),[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) +- [PHXBooleanArray](PHXBooleanArray.md), [PHXDoubleArray](PHXDoubleArray.md), [PHXLongArray](PHXLongArray.md), [PHXObjectArray](PHXObjectArray.md), [PHXRawFileArray](PHXRawFileArray.md), [PHXStringArray](PHXStringArray.md) --- @@ -17,312 +22,265 @@ public abstract class PHXSimpleArray extends PHXSimpleType implements IPHXType2, java.lang.Iterable ``` -This class enables components to create resizeable - arrays where the number of dimensions is variable - as well as the size of each dimension. -Typically you don't use this class directly but - one of its sub-classes that are created and passed - to you automatically. -**Version:** -: Oct 2002 -**Author:** -: Nathan P Sharp- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary - -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +This class enables components to create resizeable arrays where the number of dimensions is variable as well as the size of each dimension.Typically you don't use this class directly but one of its sub-classes that are created and passed to you automatically. + + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -=========== FIELD SUMMARY =========== -- ### Field Summary + +## Field Summary | Modifier and Type | Field and Description | | --- | --- | -| Modifier and Type | Field and Description | | `protected java.lang.Object` | `_data` | | `protected boolean` | `_lockDims` | | `protected boolean` | `_lockResize` | -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Modifier | Constructor and Description | | --- | --- | -| Modifier | Constructor and Description | -| `protected` | `PHXSimpleArray()`Default Constructor | -| `protected` | `PHXSimpleArray(java.lang.Object data)`Constructs a PHXSimpleArray that wraps a particular ModelCenter Remote Execution style variable. | -========== METHOD SUMMARY =========== -- ### Method Summary +| `protected` | `PHXSimpleArray()`
Default Constructor | +| `protected` | `PHXSimpleArray(java.lang.Object data)`
Constructs a PHXSimpleArray that wraps a particular ModelCenter Remote Execution style variable. | + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_getMetaData()`Gets the meta data off of the first element of the array - and sets it into our meta data info. | -| `protected void` | `_getMetaData(PHXSimpleTypev)`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. | -| `protected void` | `_setMetaData()`Call this function to set the meta data from this object into - every element of the array. | -| `protected void` | `_setMetaData(PHXSimpleTypev)`Sets a simple type's meta data based on the meta data - in this object. | -| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`Allocates a single element in a default state. | -| `static boolean` | `checkRectangular(java.lang.Object obj)`Check if the array is rectangular | -| `protected void` | `copy(PHXSimpleArrayother)`Clone another PHXSimpleArray's value and metadata. | -| `protected abstract boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified - class is acceptable as an array element component type. | -| `protected abstract java.lang.Object` | `elementFromString(java.lang.String value)`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromString(int[] index,PHXStringBuffervalue)`Sets the value of a single element based on string - input. | -| `void` | `fromString(int[] index, - java.lang.String value)`Sets the value of a single element based on string - input. | -| `void` | `fromString(int index, - java.lang.String value)`Sets the value of a single element based on string - input for 1-d arrays. | -| `void` | `fromString(java.lang.String in)`reads in the entire array in string form. | -| `void` | `fromString2(PHXStringBufferin)`reads in the entire array in string form. | -| `staticPHXSimpleArray` | `generateFor(java.lang.Object o)`Static method to generate a new instance of - one of the sub-classes of PHXSimpleArray as appropriate - for the type of variable passed in. | -| `staticPHXSimpleArray` | `generateFor(java.lang.Object o, - java.lang.Class c)`Static method to generate a new instance of - one of the sub-classes of PHXSimpleArray as appropriate - for the type of variable passed in. | -| `java.lang.Object` | `getArray()`Gets the entire contents of the array | -| `java.lang.Object` | `getArrayElement(int index)`Gets a particular element from a 1-d array | -| `java.lang.Object` | `getArrayElement(int[] index)`Gets a particular element from the array | -| `java.lang.Class` | `getComponentType()`Returns the component type of the array wrapped - with this class | -| `static java.lang.Class` | `getComponentType(java.lang.Object v)`Gets the component type of an array, even for - n-d arrays. | +| `protected void` | `_getMetaData()`
Gets the meta data off of the first element of the array and sets it into our meta data info. | +| `protected void` | `_getMetaData(PHXSimpleTypev)`
Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. | +| `protected void` | `_setMetaData()`
Call this function to set the meta data from this object into every element of the array. | +| `protected void` | `_setMetaData(PHXSimpleTypev)`
Sets a simple type's meta data based on the meta data in this object. | +| `protected java.lang.Object` | `allocateElement(java.lang.Class elementClass)`
Allocates a single element in a default state. | +| `static boolean` | `checkRectangular(java.lang.Object obj)`
Check if the array is rectangular | +| `protected void` | `copy(PHXSimpleArrayother)`
Clone another PHXSimpleArray's value and metadata. | +| `protected abstract boolean` | `dataTypeOK(java.lang.Class c)`
Must override this function and return true if the specified class is acceptable as an array element component type. | +| `protected abstract java.lang.Object` | `elementFromString(java.lang.String value)`
Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromString(int[] index,PHXStringBuffervalue)`
Sets the value of a single element based on string input. | +| `void` | `fromString(int[] index, java.lang.String value)`
Sets the value of a single element based on string input. | +| `void` | `fromString(int index, java.lang.String value)`
Sets the value of a single element based on string input for 1-d arrays. | +| `void` | `fromString(java.lang.String in)`
reads in the entire array in string form. | +| `void` | `fromString2(PHXStringBufferin)`
reads in the entire array in string form. | +| `staticPHXSimpleArray` | `generateFor(java.lang.Object o)`
Static method to generate a new instance of one of the sub-classes of PHXSimpleArray as appropriate for the type of variable passed in. | +| `staticPHXSimpleArray` | `generateFor(java.lang.Object o, java.lang.Class c)`
Static method to generate a new instance of one of the sub-classes of PHXSimpleArray as appropriate for the type of variable passed in. | +| `java.lang.Object` | `getArray()`
Gets the entire contents of the array | +| `java.lang.Object` | `getArrayElement(int index)`
Gets a particular element from a 1-d array | +| `java.lang.Object` | `getArrayElement(int[] index)`
Gets a particular element from the array | +| `java.lang.Class` | `getComponentType()`
Returns the component type of the array wrapped with this class | +| `static java.lang.Class` | `getComponentType(java.lang.Object v)`
Gets the component type of an array, even for n-d arrays. | | `int[]` | `getDimensions()` | -| `static int[]` | `getDimensions(java.lang.Object array)`Gets the array of dimensions of the array | -| `java.lang.Object` | `getFirst()`Returns the first element of the array, or throws ArrayIndexOutOfBounds - if there are no elements. | -| `int` | `getLength()`Gets the length of the first dimension of the array | -| `int` | `getLength(int dim)`Gets the length of a dimension of the array | +| `static int[]` | `getDimensions(java.lang.Object array)`
Gets the array of dimensions of the array | +| `java.lang.Object` | `getFirst()`
Returns the first element of the array, or throws `ArrayIndexOutOfBounds` if there are no elements. | +| `int` | `getLength()`
Gets the length of the first dimension of the array | +| `int` | `getLength(int dim)`
Gets the length of a dimension of the array | | `boolean` | `getLockResize()` | -| `protected int[]` | `getnDIndex(long oneDIndex, - int[] actualSize)` | -| `int` | `getNumDimensions()`Gets the number of dimensions of the array | +| `protected int[]` | `getnDIndex(long oneDIndex, int[] actualSize)` | +| `int` | `getNumDimensions()`
Gets the number of dimensions of the array | | `static int` | `getNumDimensions(java.lang.Object o)` | | `PHXSimpleArray` | `getSelf()` | -| `T` | `getValue(int index)`Gets an element as PHXSimpleType object of the appropriate subtype | -| `abstractT` | `getValue(int[] index)`Gets the value of an element as an object of the appropriate subtype - Must be overridden in subclasses | -| `static boolean` | `incrementIndex(int[] index, - int[] size)`Utility function for incrementing an nD index on the array | -| `java.util.Iterator` | `iterator()`Returns an iterator that loops over the array in the standard PHX order, rightmost - index varies fastest. | -| `void` | `lockDimensions()`Tells this array that the number of dimensions cannot be changed - from what they are right now. | -| `int[]` | `newIndex()`Produces a new index based zeroed out, but with the proper dimensions | -| `static int[]` | `parseIndex(java.lang.String index)`Takes a string of the form "anything[n, n2, n3]" - or "n, n2, n3" - and returns an int[] of the index values. | -| `void` | `resize(int[] newSize)`Resize the nD array to the new size specified. | -| `void` | `setArray(java.lang.Object v)`Sets the entire array. | -| `void` | `setArrayElement(int[] index, - java.lang.Object v)`Sets a particular element of the array | -| `void` | `setArrayElement(int index, - java.lang.Object v)`Sets a particular element of a 1-d array | -| `void` | `setDimensions(int[] dim)`Sets the dimensions of the array. | -| `void` | `setFirst(java.lang.Object val)`Sets the first element of the array, or throws ArrayIndexOutOfBounds - if there are no elements. | -| `void` | `setLength(int len)`Sets the length of the first dimension of the array. | -| `void` | `setLength(int len, - int dim)`Sets the length of a dimensions of the array. | -| `void` | `setLockResize(boolean lockResize)`Tells this array that it cannot be resized. | -| `abstract void` | `setValue(int[] index,Tval)`Sets an element as an object of the appropriate PHXSimpleType - Must be overridden in subclasses | -| `void` | `setValue(int index,Tval)`Sets an element as an object of the appropriate PHXSimpleType | -| `java.lang.String` | `toString()`Returns the string form of this array. | -| `java.lang.String` | `toString(int index)`Converts a single element of a 1-d array to a string | -| `java.lang.String` | `toString(int[] index)`Converts a single element to a string | -| `java.lang.String` | `toString(java.lang.String index)`Converts a single element to a string | -| `PHXStringBuffer` | `toString2()`Returns the string form of this array. | -| `PHXStringBuffer` | `toString2(int[] index)`Converts a single element to a string | -| `PHXStringBuffer` | `toString2(java.lang.String index)`Converts a single element to a string | -| `boolean` | `validElement(int[] index, - int[] size)`Is the given index valid? | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,createCopy,fromObject,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` - -- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType2 +| `T` | `getValue(int index)`
Gets an element as PHXSimpleType object of the appropriate subtype | +| `abstractT` | `getValue(int[] index)`
Gets the value of an element as an object of the appropriate subtype Must be overridden in subclasses | +| `static boolean` | `incrementIndex(int[] index, int[] size)`
Utility function for incrementing an nD index on the array | +| `java.util.Iterator` | `iterator()`
Returns an iterator that loops over the array in the standard order, rightmost index varies fastest. | +| `void` | `lockDimensions()`
Tells this array that the number of dimensions cannot be changed from what they are right now. | +| `int[]` | `newIndex()`
Produces a new index based zeroed out, but with the proper dimensions | +| `static int[]` | `parseIndex(java.lang.String index)`
Takes a string of the form "anything[n, n2, n3]" or "n, n2, n3" and returns an int[] of the index values. | +| `void` | `resize(int[] newSize)`
Resize the nD array to the new size specified. | +| `void` | `setArray(java.lang.Object v)`
Sets the entire array. | +| `void` | `setArrayElement(int[] index, java.lang.Object v)`
Sets a particular element of the array | +| `void` | `setArrayElement(int index, java.lang.Object v)`
Sets a particular element of a 1-d array | +| `void` | `setDimensions(int[] dim)`
Sets the dimensions of the array. | +| `void` | `setFirst(java.lang.Object val)`
Sets the first element of the array, or throws `ArrayIndexOutOfBounds` if there are no elements. | +| `void` | `setLength(int len)`
Sets the length of the first dimension of the array. | +| `void` | `setLength(int len, int dim)`
Sets the length of a dimensions of the array. | +| `void` | `setLockResize(boolean lockResize)`
Tells this array that it cannot be resized. | +| `abstract void` | `setValue(int[] index,Tval)`
Sets an element as an object of the appropriate PHXSimpleType. Must be overridden in subclasses | +| `void` | `setValue(int index,Tval)`
Sets an element as an object of the appropriate PHXSimpleType | +| `java.lang.String` | `toString()`
Returns the string form of this array. | +| `java.lang.String` | `toString(int index)`
Converts a single element of a 1-d array to a string | +| `java.lang.String` | `toString(int[] index)`
Converts a single element to a string | +| `java.lang.String` | `toString(java.lang.String index)`
Converts a single element to a string | +| `PHXStringBuffer` | `toString2()`
Returns the string form of this array. | +| `PHXStringBuffer` | `toString2(int[] index)`
Converts a single element to a string | +| `PHXStringBuffer` | `toString2(java.lang.String index)`
Converts a single element to a string | +| `boolean` | `validElement(int[] index, int[] size)`
Is the given index valid? | + +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `createCopy`, `fromObject`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +### Methods inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `Accept` -- ### Methods inherited from interface java.lang.Iterable -`forEach, spliterator`- ============ FIELD DETAIL =========== -- ### Field Detail +### Methods inherited from interface java.lang.Iterable +`forEach, spliterator` -- #### _data +## Field Detail + +### _data ```java protected java.lang.Object _data ``` -- #### _lockDims +### _lockDims ```java protected boolean _lockDims ``` -- #### _lockResize +### _lockResize ```java protected boolean _lockResize ``` -========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail -- #### PHXSimpleArray +## Constructor Detail + +### PHXSimpleArray ```java protected PHXSimpleArray(java.lang.Object data) ``` Constructs a PHXSimpleArray that wraps a particular ModelCenter Remote Execution style variable. + **Parameters:** -: `data`- The ModelCenter Remote Execution variable to wrap, which must +- `data`- The ModelCenter Remote Execution variable to wrap, which must be an array. -- #### PHXSimpleArray +### PHXSimpleArray ```java protected PHXSimpleArray() ``` Default Constructor ============ METHOD DETAIL ========== -- ### Method Detail +### Method Detail -- #### copy +### copy ```java protected void copy(PHXSimpleArray other) ``` Clone another PHXSimpleArray's value and metadata. + **Parameters:** -: `other`- the other PHXSimpleArray to clone. +- `other`- the other PHXSimpleArray to clone. -- #### lockDimensions +### lockDimensions ```java public void lockDimensions() ``` -Tells this array that the number of dimensions cannot be changed - from what they are right now. +Tells this array that the number of dimensions cannot be changed from what they are right now. -- #### setLockResize +### setLockResize ```java public void setLockResize(boolean lockResize) ``` -Tells this array that it cannot be resized. Implies lockDimensions. +Tells this array that it cannot be resized. Implies `lockDimensions`. -- #### getLockResize +### getLockResize ```java public boolean getLockResize() ``` -- #### _getMetaData +### _getMetaData ```java protected void _getMetaData() ``` -Gets the meta data off of the first element of the array - and sets it into our meta data info. Call this from - base classes in the constructor and after anything that - might change the meta information on the first array element. +Gets the meta data off of the first element of the array and sets it into our meta data info. Call this from base classes in the constructor and after anything that might change the meta information on the first array element. -- #### _getMetaData +### _getMetaData ```java protected void _getMetaData(PHXSimpleType v) ``` -Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. Override this in order to add - more custom meta data in sub-classes. Be sure to cal - super._getMetaData(PHXSimpleType), though! +Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. Override this in order to add more custom meta data in sub-classes. Be sure to call `super._getMetaData(PHXSimpleType)`, though! -- #### dataTypeOK +### dataTypeOK ```java protected abstract boolean dataTypeOK(java.lang.Class c) ``` -Must override this function and return true if the specified - class is acceptable as an array element component type. +Must override this function and return true if the specified class is acceptable as an array element component type. -- #### resize +### resize ```java public void resize(int[] newSize) throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Resize the nD array to the new size specified. Preserve elements if the # of dimensions stays the same, else - initialize the array with default values. +Resize the nD array to the new size specified. Preserve elements if the # of dimensions stays the same, else initialize the array with default values. + **Parameters:** -: `newSize`- new dimensions for the array +- `newSize`- new dimensions for the array + **Throws:** -: `java.lang.IllegalAccessException`- if an error occurs allocating new array size -: `java.lang.InstantiationException`- if an error occurs allocating new array size +- `java.lang.IllegalAccessException`- if an error occurs allocating new array size +- `java.lang.InstantiationException`- if an error occurs allocating new array size -- #### getFirst +### getFirst ```java public java.lang.Object getFirst() ``` -Returns the first element of the array, or throws ArrayIndexOutOfBounds - if there are no elements. +Returns the first element of the array, or throws `ArrayIndexOutOfBounds` if there are no elements. -- #### setFirst +### setFirst ```java public void setFirst(java.lang.Object val) ``` -Sets the first element of the array, or throws ArrayIndexOutOfBounds - if there are no elements. +Sets the first element of the array, or throws `ArrayIndexOutOfBounds` if there are no elements. -- #### getLength +### getLength ```java public int getLength() ``` Gets the length of the first dimension of the array -- #### getLength +### getLength ```java public int getLength(int dim) ``` Gets the length of a dimension of the array + **Parameters:** -: `dim`- the dimension of interest +- `dim`- the dimension of interest + **Returns:** -: the size of the dimension +- the size of the dimension -- #### setLength +### setLength ```java public void setLength(int len) throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Sets the length of the first dimension of the array. - Will preserve as many element values as possible. +Sets the length of the first dimension of the array. Will preserve as many element values as possible. + **Parameters:** -: `len`- the new length of the 1D array +- `len`- the new length of the 1D array + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if arguments are incorrect or don't - jive with the current array -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalArgumentException`- thrown if arguments are incorrect or don't jive with the current array +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### setLength +### setLength ```java public void setLength(int len, @@ -330,437 +288,453 @@ public void setLength(int len, throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Sets the length of a dimensions of the array. - You may grow the array by 1 dimension if 'dim' is - the next dim that needs defining. You may shorten - the array by passing in 'len' < 0 and 'dim' as the - first dimension after the valid dimensions. +Sets the length of a dimensions of the array. You may grow the array by 1 dimension if 'dim' is the next dim that needs defining. You may shorten the array by passing in 'len' < 0 and 'dim' as the first dimension after the valid dimensions. + **Parameters:** -: `len`- the new length of the dimension. -: `dim`- the dimension to change +- `len`- the new length of the dimension. +- `dim`- the dimension to change + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if arguments are incorrect or don't - jive with the current array -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalArgumentException`- thrown if arguments are incorrect or don't jive with the current array +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### getDimensions +### getDimensions ```java public static int[] getDimensions(java.lang.Object array) ``` Gets the array of dimensions of the array + **Returns:** -: the array with the dimensions +- the array with the dimensions -- #### getDimensions +### getDimensions ```java public int[] getDimensions() ``` -- #### setDimensions +### setDimensions ```java public void setDimensions(int[] dim) throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Sets the dimensions of the array. Will preserve as many element - values as possible. +Sets the dimensions of the array. Will preserve as many element values as possible. + **Parameters:** -: `dim`- the new dimensions for the array +- `dim`- the new dimensions for the array + **Throws:** -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### getNumDimensions +### getNumDimensions ```java public static int getNumDimensions(java.lang.Object o) ``` -- #### getNumDimensions +### getNumDimensions ```java public int getNumDimensions() ``` Gets the number of dimensions of the array -- #### fromString +### fromString ```java public void fromString(int index, java.lang.String value) ``` -Sets the value of a single element based on string - input for 1-d arrays. Data is converted as appropriate. +Sets the value of a single element based on string input for 1-d arrays. Data is converted as appropriate. + **Parameters:** -: `index`- Which element to set. -: `value`- The new value. +- `index`- Which element to set. +- `value`- The new value. -- #### fromString +### fromString ```java public void fromString(int[] index, PHXStringBuffer value) ``` -Sets the value of a single element based on string - input. Data is converted as appropriate. +Sets the value of a single element based on string input. Data is converted as appropriate. + **Parameters:** -: `index`- Which element to set. -: `value`- The new value. +- `index`- Which element to set. +- `value`- The new value. -- #### fromString +### fromString ```java public void fromString(int[] index, java.lang.String value) ``` -Sets the value of a single element based on string - input. Data is converted as appropriate. +Sets the value of a single element based on string input. Data is converted as appropriate. + **Parameters:** -: `index`- Which element to set. -: `value`- The new value. +- `index`- Which element to set. +- `value`- The new value. -- #### elementFromString +### elementFromString ```java protected abstract java.lang.Object elementFromString(java.lang.String value) ``` -Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. This is only used when the element type does not - implement IPHXType or IPHXType2. For primitives, return - the wrapper objects. +Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. This is only used when the element type does not implement [IPHXType](IPHXType.md) or [IPHXType2](IPHXType2.md). For primitives, return the wrapper objects. -- #### toString +### toString ```java public java.lang.String toString(int index) ``` Converts a single element of a 1-d array to a string + **Parameters:** -: `index`- the index of the desired element +- `index`- the index of the desired element + **Returns:** -: the desired element, in string form +- the desired element, in string form -- #### parseIndex +### parseIndex ```java public static int[] parseIndex(java.lang.String index) ``` -Takes a string of the form "anything[n, n2, n3]" - or "n, n2, n3" - and returns an int[] of the index values. +Takes a string of the form "anything[n, n2, n3]" or "n, n2, n3" and returns an int[] of the index values. -- #### toString +### toString ```java public java.lang.String toString(java.lang.String index) ``` Converts a single element to a string + **Parameters:** -: `index`- the index of the desired element +- `index`- the index of the desired element + **Returns:** -: the desired element, in string form +- the desired element, in string form -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2(java.lang.String index) throws java.io.IOException ``` Converts a single element to a string + **Parameters:** -: `index`- the index of the desired element +- `index`- the index of the desired element + **Returns:** -: the desired element, in string form +- the desired element, in string form + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### toString +### toString ```java public java.lang.String toString(int[] index) ``` Converts a single element to a string + **Parameters:** -: `index`- the index of the desired element +- `index`- the index of the desired element + **Returns:** -: the desired element, in string form +- the desired element, in string form -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2(int[] index) throws java.io.IOException ``` Converts a single element to a string + **Parameters:** -: `index`- the index of the desired element +- `index`- the index of the desired element + **Returns:** -: the desired element, in string form +- the desired element, in string form + **Throws:** -: `java.io.IOException` +- `java.io.IOException` -- #### getArrayElement +### getArrayElement ```java public java.lang.Object getArrayElement(int index) ``` Gets a particular element from a 1-d array + **Parameters:** -: `index`- the 1D array index into the 1D array +- `index`- the 1D array index into the 1D array + **Returns:** -: the specified element +- the specified element + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if 1D reference is given to a >1D array +- `java.lang.IllegalArgumentException`- thrown if 1D reference is given to a >1D array -- #### getArrayElement +### getArrayElement ```java public java.lang.Object getArrayElement(int[] index) ``` Gets a particular element from the array + **Parameters:** -: `index`- the 1D array index into the 1D array +- `index`- the 1D array index into the 1D array + **Returns:** -: the specified element +- the specified element + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if 1D reference is given to a >1D array +- `java.lang.IllegalArgumentException`- thrown if 1D reference is given to a >1D array -- #### setArrayElement +### setArrayElement ```java public void setArrayElement(int index, java.lang.Object v) ``` Sets a particular element of a 1-d array + **Parameters:** -: `index`- Which index to set -: `v`- The new value. Note that this takes - an instance of a PHXType. +- `index`- Which index to set +- `v`- The new value. Note that this takes an instance of a PHXType. -- #### setArrayElement +### setArrayElement ```java public void setArrayElement(int[] index, java.lang.Object v) ``` Sets a particular element of the array + **Parameters:** -: `index`- Which index to set -: `v`- The new value. Note that this takes - an instance of a PHXType. +- `index`- Which index to set +- `v`- The new value. Note that this takes an instance of a PHXType. -- #### getArray +### getArray ```java public java.lang.Object getArray() ``` Gets the entire contents of the array + **Returns:** -: the base array object +- the base array object -- #### setArray +### setArray ```java public void setArray(java.lang.Object v) ``` -Sets the entire array. Array is checked for validity - and rectangularity. _getMetaData() is called. +Sets the entire array. Array is checked for validity and rectangularity. `_getMetaData()` is called. + **Parameters:** -: `v`- the new array (nD) +- `v`- the new array (nD) + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if array passed in is not rectangular +- `java.lang.IllegalArgumentException`- thrown if array passed in is not rectangular -- #### getSelf +### getSelf ```java public PHXSimpleArray getSelf() ``` -- #### checkRectangular +### checkRectangular ```java public static boolean checkRectangular(java.lang.Object obj) ``` Check if the array is rectangular + **Parameters:** -: `obj`- the array to check +- `obj`- the array to check + **Returns:** -: is the array rectangular? +- is the array rectangular? + **Throws:** -: `java.lang.NullPointerException`- thrown if one of the values in the array is null +- `java.lang.NullPointerException`- thrown if one of the values in the array is null -- #### getComponentType +### getComponentType ```java public static java.lang.Class getComponentType(java.lang.Object v) ``` -Gets the component type of an array, even for - n-d arrays. +Gets the component type of an array, even for n-d arrays. + **Parameters:** -: `v`- The array to get the component type for +- `v`- The array to get the component type for -- #### getComponentType +### getComponentType ```java public java.lang.Class getComponentType() ``` -Returns the component type of the array wrapped - with this class +Returns the component type of the array wrapped with this class -- #### generateFor +### generateFor ```java public static PHXSimpleArray generateFor(java.lang.Object o) throws java.lang.IllegalArgumentException ``` -Static method to generate a new instance of - one of the sub-classes of PHXSimpleArray as appropriate - for the type of variable passed in. +Static method to generate a new instance of one of the sub-classes of PHXSimpleArray as appropriate for the type of variable passed in. + **Throws:** -: `java.lang.IllegalArgumentException` +- `java.lang.IllegalArgumentException` -- #### generateFor +### generateFor ```java public static PHXSimpleArray generateFor(java.lang.Object o, java.lang.Class c) throws java.lang.IllegalArgumentException ``` -Static method to generate a new instance of - one of the sub-classes of PHXSimpleArray as appropriate - for the type of variable passed in. If 'o' is null, a - new 0 length array will be generated based on 'c' as - the component type. +Static method to generate a new instance of one of the sub-classes of PHXSimpleArray as appropriate for the type of variable passed in. If 'o' is null, a new 0 length array will be generated based on 'c' as the component type. + **Throws:** -: `java.lang.IllegalArgumentException` +- `java.lang.IllegalArgumentException` -- #### fromString +### fromString ```java public void fromString(java.lang.String in) ``` reads in the entire array in string form. bounds[3,2] { 1,2,3,4,5,6 } + **Specified by:** -: `fromString`in interface`IPHXType` +- `fromString` in interface [`IPHXType`](IPHXType.md) + **Parameters:** -: `in`- the value of the variable +- `in`- the value of the variable -- #### fromString2 +### fromString2 ```java public void fromString2(PHXStringBuffer in) ``` -reads in the entire array in string form. -bounds[3,2] { 1,2,3,4,5,6 } +reads in the entire array in string form. `bounds[3,2] { 1,2,3,4,5,6 }` + **Specified by:** -: `fromString2`in interface`IPHXType2` +- `fromString2` in interface [`IPHXType2`](IPHXType2.md) + **Parameters:** -: `in`- representation of the type to use +- `in`- representation of the type to use -- #### toString +### toString ```java public java.lang.String toString() ``` -Returns the string form of this array. - Puts each element in quotes, even if it is a number and backslashes - any quote or backslash characters (" and \). +Returns the string form of this array. Puts each element in quotes, even if it is a number and backslashes any quote or backslash characters (" and \\). + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString`in class`java.lang.Object` + **Returns:** -: the value as a String +- the value as a String -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2() ``` -Returns the string form of this array. - Puts each element in quotes, even if it is a number and backslashes - any quote or backslash characters (" and \). +Returns the string form of this array. Puts each element in quotes, even if it is a number and backslashes any quote or backslash characters (" and \\). + **Specified by:** -: `toString2`in interface`IPHXType2` +- `toString2` in interface [`IPHXType2`](IPHXType2.md) + **Returns:** -: PHXStringBuffer representation of the type +- PHXStringBuffer representation of the type -- #### incrementIndex +### incrementIndex ```java public static boolean incrementIndex(int[] index, int[] size) ``` Utility function for incrementing an nD index on the array + **Parameters:** -: `index`- the index to increment -: `size`- the maximum size of the array +- `index`- the index to increment +- `size`- the maximum size of the array + **Returns:** -: did the incrment work? +- did the incrment work? + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if index lengths don't match +- `java.lang.IllegalArgumentException`- thrown if index lengths don't match -- #### newIndex +### newIndex ```java public int[] newIndex() ``` Produces a new index based zeroed out, but with the proper dimensions + **Returns:** -: the new index +- the new index -- #### validElement +### validElement ```java public boolean validElement(int[] index, int[] size) ``` Is the given index valid? + **Parameters:** -: `index`- the index to check -: `size`- the maximum size +- `index`- the index to check +- `size`- the maximum size + **Returns:** -: is the given index valid? +- is the given index valid? -- #### allocateElement +### allocateElement ```java protected java.lang.Object allocateElement(java.lang.Class elementClass) throws java.lang.IllegalAccessException, java.lang.InstantiationException ``` -Allocates a single element in a default state. - If the class type in question has a default constructor, - there is no need to override this. +Allocates a single element in a default state. If the class type in question has a default constructor, there is no need to override this. + **Throws:** -: `java.lang.IllegalAccessException` -: `java.lang.InstantiationException` +- `java.lang.IllegalAccessException` +- `java.lang.InstantiationException` -- #### _setMetaData +### _setMetaData ```java protected void _setMetaData(PHXSimpleType v) ``` -Sets a simple type's meta data based on the meta data - in this object. Override this to set additional - information in sub-classes. Be sure to call - super._setMetaData(PHXSimpleType) +Sets a simple type's meta data based on the meta data in this object. Override this to set additional information in sub-classes. Be sure to call `super._setMetaData(PHXSimpleType)`. -- #### _setMetaData +### _setMetaData ```java protected void _setMetaData() ``` -Call this function to set the meta data from this object into - every element of the array. +Call this function to set the meta data from this object into every element of the array. -- #### getnDIndex +### getnDIndex ```java protected int[] getnDIndex(long oneDIndex, @@ -768,94 +742,100 @@ protected int[] getnDIndex(long oneDIndex, throws java.lang.IllegalArgumentException ``` + **Throws:** -: `java.lang.IllegalArgumentException` +- `java.lang.IllegalArgumentException` -- #### getValue +### getValue ```java public T getValue(int index) ``` Gets an element as PHXSimpleType object of the appropriate subtype + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index + **Returns:** -: referenced array value +- referenced array value + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### setValue +### setValue ```java public void setValue(int index, T val) ``` Sets an element as an object of the appropriate PHXSimpleType + **Parameters:** -: `index`- 1D array index -: `val`- value to set +- `index`- 1D array index +- `val`- value to set -- #### getValue +### getValue ```java public abstract T getValue(int[] index) ``` -Gets the value of an element as an object of the appropriate subtype - Must be overridden in subclasses +Gets the value of an element as an object of the appropriate subtype. Must be overridden in subclasses + **Parameters:** -: `index`- nD array index +- `index`- nD array index + **Returns:** -: referenced array value +- referenced array value -- #### iterator +### iterator ```java public java.util.Iterator iterator() ``` -Returns an iterator that loops over the array in the standard PHX order, rightmost - index varies fastest. Note that the iterator returned is not thread safe. It also has - undefined behavior if the array is modified while iterating over the array. It does not - support Iterator.remove(). Lastly, - the iterator returned may throw exceptions other than NoSuchElementException, such as - IndexOutOfBoundsException. +Returns an iterator that loops over the array in the standard PHX order, rightmost index varies fastest. Note that the iterator returned is not thread safe. It also has undefined behavior if the array is modified while iterating over the array. It does not support `Iterator.remove()`. Lastly, the iterator returned may throw exceptions other than `NoSuchElementException`, such as `IndexOutOfBoundsException`. + **Specified by:** -: `iterator`in interface`java.lang.Iterable` +- `iterator` in interface `java.lang.Iterable` + **See Also:** -: `Iterable` +- `Iterable` -- #### setValue +### setValue ```java public abstract void setValue(int[] index, T val) ``` -Sets an element as an object of the appropriate PHXSimpleType - Must be overridden in subclasses +Sets an element as an object of the appropriate PHXSimpleType. Must be overridden in subclasses + **Parameters:** -: `index`- nD array index -: `val`- value to set +- `index`- nD array index +- `val`- value to set -- #### equalsNatural +### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. Array comparison is handled as follows: + 1) Compare the number of dimensions between the two arrays 2) Compare the length of dimensions between the two arrays 3) Compare the values in each of the two arrays - Iff these three conditions are met, the two arrays are considered naturally equal. + + If these three conditions are met, the two arrays are considered naturally equal. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural`in class`PHXSimpleType` + **Parameters:** -: `toCompare`- +- `toCompare`- + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. -========= END OF CLASS DATA ========= \ No newline at end of file +- `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md index 856b729c0d..4682b6e951 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXSimpleType.md @@ -1,13 +1,18 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXSimpleType -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXSimpleType -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class PHXSimpleType + + +**Package:** com.phoenix_int.aserver.types +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType +``` + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md) + **Direct Known Subclasses:** -: [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html),[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html),[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html),[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html),[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html),[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html),[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html),[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html),[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html),[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html) +- [PHXBoolean](PHXBoolean.md), [PHXDouble](PHXDouble.md), [PHXFile](PHXFile.md), [PHXGeometry](PHXGeometry.md), [PHXInteger](PHXInteger.md), [PHXLong](PHXLong.md), [PHXRawFile](PHXRawFile.md), [PHXScriptObject](PHXScriptObject.md), [PHXSimpleArray](PHXSimpleArray.md), [PHXString](PHXString.md) --- @@ -16,187 +21,188 @@ public abstract class PHXSimpleType extends java.lang.Object implements IPHXType2, IPHXUnits ``` -A base class for most Phoenix data types. The class defines - the following properties: + +A base class for most data types. The class defines the following properties: + - description: String - units: String - hasChanged: boolean -This class will fire a property change event when hasChanged(true) is - called. The property event will always have the property name be "value" - and the old and new values of null. Use toString or getValue functions - to get the actual new value from the variable. -**Author:** -: Woyak- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary - -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 + +This class will fire a property change event when `hasChanged(true)` is called. The property event will always have the property name be "value" and the old and new values of null. Use `toString` or `getValue` functions to get the actual new value from the variable. + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXSimpleType()` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_copyMetadataFromOther(PHXSimpleTypeother)`Copy common metadata on PHXSimpleType from another object to this one. | +| `protected void` | `_copyMetadataFromOther(PHXSimpleTypeother)`
Copy common metadata on PHXSimpleType from another object to this one. | | `void` | `addPropertyChangeListener(java.beans.PropertyChangeListener l)` | -| `abstractPHXSimpleType` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `abstract boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `abstract void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | +| `abstractPHXSimpleType` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `abstract boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `abstract void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | | `java.lang.String` | `getDescription()` | | `static java.lang.String[]` | `getEnumTokens(java.lang.String enums)` | -| `boolean` | `getHasChanged()`retrieves the hasChanged flag | -| `java.lang.String` | `getUnits()`Get the units string for the variable | +| `boolean` | `getHasChanged()`
retrieves the `hasChanged` flag | +| `java.lang.String` | `getUnits()`
Get the units string for the variable | | `void` | `removePropertyChangeListener(java.beans.PropertyChangeListener l)` | | `void` | `setDescription(java.lang.String d)` | -| `void` | `setHasChanged(boolean v)`sets the hasChanged flag | -| `void` | `setUnits(java.lang.String u)`Set the units string for the variable | +| `void` | `setHasChanged(boolean v)`
sets the `hasChanged` flag | +| `void` | `setUnits(java.lang.String u)`
Set the units string for the variable | -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` -- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType2 -`Accept,fromString2,toString2` +### Methods inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) +`Accept`, `fromString2`, `toString2` -- ### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType -`fromString,toString`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from interface com.phoenix_int.aserver.types.[IPHXType](IPHXType.md) +`fromString,toString` -- #### PHXSimpleType +## Constructor Detail + +### PHXSimpleType ```java public PHXSimpleType() ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### setUnits +## Method Detail + +### setUnits ```java public void setUnits(java.lang.String u) ``` Set the units string for the variable + **Specified by:** -: `setUnits`in interface`IPHXUnits` +- `setUnits` in interface [`IPHXUnits`](IPHXUnits.md) + **Parameters:** -: `u`- units for the variable +- `u`- units for the variable -- #### getUnits +### getUnits ```java public java.lang.String getUnits() ``` Get the units string for the variable + **Specified by:** -: `getUnits`in interface`IPHXUnits` +- `getUnits` in interface [`IPHXUnits`](IPHXUnits.md) + **Returns:** -: units string +- units string -- #### setDescription +### setDescription ```java public void setDescription(java.lang.String d) ``` -- #### getDescription +### getDescription ```java public java.lang.String getDescription() ``` -- #### setHasChanged +### setHasChanged ```java public void setHasChanged(boolean v) ``` sets the hasChanged flag + **Parameters:** -: `v`- the new value for the flag +- `v`- the new value for the flag -- #### getHasChanged +### getHasChanged ```java public boolean getHasChanged() ``` retrieves the hasChanged flag + **Returns:** -: true if the variable has changed since the last - time the hasChanged flag was set to false +- `true` if the variable has changed since the last time the `hasChanged` flag was set to `false` -- #### addPropertyChangeListener +### addPropertyChangeListener ```java public void addPropertyChangeListener(java.beans.PropertyChangeListener l) ``` -- #### removePropertyChangeListener +### removePropertyChangeListener ```java public void removePropertyChangeListener(java.beans.PropertyChangeListener l) ``` -- #### getEnumTokens +### getEnumTokens ```java public static java.lang.String[] getEnumTokens(java.lang.String enums) ``` -- #### equalsNatural +### equalsNatural ```java public abstract boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Parameters:** -: `toCompare`- +- `toCompare`- + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. -- #### fromObject +### fromObject ```java public abstract void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md) + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently supported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) if the specified object is of an invalid type or there is an error in conversion. -- #### _copyMetadataFromOther +### _copyMetadataFromOther ```java protected final void _copyMetadataFromOther(PHXSimpleType other) ``` -Copy common metadata on PHXSimpleType from another object to this one. - Designed to assist in implementing[createCopy()](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html#createCopy--). +Copy common metadata on PHXSimpleType from another object to this one. Designed to assist in implementing `createCopy()`. + **Parameters:** -: `other`- the other object from which metadata will be copied +- `other`- the other object from which metadata will be copied -- #### createCopy +### createCopy ```java public abstract PHXSimpleType createCopy() ``` Create a copy of this instance, including the value and metadata. + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md index e9672fa4d5..1fec0309e5 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXString.md @@ -1,11 +1,15 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXString -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - com.phoenix_int.aserver.types.PHXString -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +# Class PHXString + + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXString +``` + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md) --- @@ -13,343 +17,368 @@ com.phoenix_int.aserver.types public class PHXString extends PHXSimpleType ``` -The Phoenix type for Strings. This class adds the following - features to the PHXSimpleType: +The type for Strings. This class adds the following features to the [PHXSimpleType](PHXSimpleType.md): + - **value**: String - **enumValues**: String[] - **enumAliases**: String[] -**Author:** -: Woyak + + **See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +- [PHXSimpleType](PHXSimpleType.md) + +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 `IPHXType2.IVisitor` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXString()` | -| `PHXString(PHXStringother)`Clone another PHXString's value and metadata. | +| `PHXString(PHXStringother)`
Clone another PHXString's value and metadata. | | `PHXString(java.lang.String value)` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_copyMetadataFromOther(PHXStringother)`Clone another PHXString's metadata. | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `static java.lang.String` | `arrayToString(java.lang.String[] sa)`Deprecated. | -| `static java.lang.String` | `arrayToStringEscaped(java.lang.String[] sa)`Quotes each element of the array using c-style escape sequences, then - builds a comma separated list of the elements with quotes around each element. | -| `PHXString` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`Compare this PHXSimpleType to another PHXSimpleType. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `void` | `fromString(java.lang.String value)`converts a String representation to the internal value | -| `void` | `fromString2(PHXStringBuffervalue)`converts a PHXStringBuffer representation to the internal value | -| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | -| `java.lang.String[]` | `getEnumValues()`lists enum values | -| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a - comma separated string | -| `java.lang.String` | `getValue()`retrieves the current value of the variable | +| `protected void` | `_copyMetadataFromOther(PHXStringother)`
Clone another PHXString's metadata. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `static java.lang.String` | `arrayToString(java.lang.String[] sa)`
Deprecated. | +| `static java.lang.String` | `arrayToStringEscaped(java.lang.String[] sa)`
Quotes each element of the array using c-style escape sequences, then builds a comma separated list of the elements with quotes around each element. | +| `PHXString` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `boolean` | `equalsNatural(PHXSimpleTypetoCompare)`
Compare this PHXSimpleType to another PHXSimpleType. | +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `void` | `fromString(java.lang.String value)`
converts a String representation to the internal value | +| `void` | `fromString2(PHXStringBuffervalue)`
converts a PHXStringBuffer representation to the internal value | +| `java.lang.String[]` | `getEnumAliases()`
An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`
An interface function for the enumeration array | +| `java.lang.String[]` | `getEnumValues()`
lists enum values | +| `java.lang.String` | `getEnumValuesStr()`
Interface function to pass out the enumeration array as a comma separated string | +| `java.lang.String` | `getValue()`
retrieves the current value of the variable | | `static void` | `main(java.lang.String[] args)` | -| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration aliases list with values. | -| `void` | `setEnumAliases(java.lang.String[] values)`Takes an array of values and fills the enumeration aliases list with values. | -| `void` | `setEnumValues(java.lang.String input)`sets enum values | -| `void` | `setEnumValues(java.lang.String[] values)`sets enum values | -| `void` | `setValue(PHXStringBufferv)`sets the value for the variable | -| `void` | `setValue(java.lang.String v)`sets the value for the variable | +| `void` | `setEnumAliases(java.lang.String values)`
takes a comma seperated string of values and fills the enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`
Takes an array of values and fills the enumeration aliases list with values. | +| `void` | `setEnumValues(java.lang.String input)`
sets enum values | +| `void` | `setEnumValues(java.lang.String[] values)`
sets enum values | +| `void` | `setValue(PHXStringBufferv)`
sets the value for the variable | +| `void` | `setValue(java.lang.String v)`
sets the value for the variable | | `static java.lang.String[]` | `stringToArray(java.lang.String s)` | -| `java.lang.String` | `toString()`converts the variable to a string | -| `PHXStringBuffer` | `toString2()`converts the variable to a PHXStringBuffer | +| `java.lang.String` | `toString()`
converts the variable to a string | +| `PHXStringBuffer` | `toString2()`
converts the variable to a PHXStringBuffer | -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`,`removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` -- #### PHXString +## Constructor Detail + +### PHXString ```java public PHXString() ``` -- #### PHXString +### PHXString ```java public PHXString(java.lang.String value) ``` -- #### PHXString +### PHXString ```java public PHXString(PHXString other) ``` Clone another PHXString's value and metadata. + **Parameters:** -: `other`- the other PHXString to clone. -============ METHOD DETAIL ========== -- ### Method Detail +- `other`- the other PHXString to clone. -- #### getValue +## Method Detail + +### getValue ```java public java.lang.String getValue() ``` retrieves the current value of the variable + **Returns:** -: the value of the variable +- the value of the variable -- #### setValue +### setValue ```java public void setValue(java.lang.String v) throws java.lang.IllegalArgumentException ``` sets the value for the variable + **Parameters:** -: `v`- the value +- `v`- the value + **Throws:** -: `java.lang.IllegalArgumentException` +- `java.lang.IllegalArgumentException` -- #### setValue +### setValue ```java public void setValue(PHXStringBuffer v) throws java.lang.IllegalArgumentException ``` sets the value for the variable + **Parameters:** -: `v`- the value +- `v`- the value + **Throws:** -: `java.lang.IllegalArgumentException` +- `java.lang.IllegalArgumentException` -- #### toString2 +### toString2 ```java public PHXStringBuffer toString2() ``` converts the variable to a PHXStringBuffer + **Returns:** -: a PHXStringBuffer representation of the variable +- a PHXStringBuffer representation of the variable -- #### toString +### toString ```java public java.lang.String toString() ``` converts the variable to a string + **Specified by:** -: `toString`in interface`IPHXType` +- `toString` in interface [`IPHXType`](IPHXType.md) + **Overrides:** -: `toString`in class`java.lang.Object` +- `toString` in class `java.lang.Object` + **Returns:** -: a String representation of the variable +- a String representation of the variable -- #### fromString2 +### fromString2 ```java public void fromString2(PHXStringBuffer value) ``` converts a PHXStringBuffer representation to the internal value + **Parameters:** -: `value`- the value to convert +- `value`- the value to convert -- #### fromString +### fromString ```java public void fromString(java.lang.String value) ``` converts a String representation to the internal value + **Parameters:** -: `value`- the value to convert +- `value`- the value to convert -- #### getEnumValues +### getEnumValues ```java public java.lang.String[] getEnumValues() ``` lists enum values + **Returns:** -: enum values +- enum values -- #### getEnumValuesStr +### getEnumValuesStr ```java public java.lang.String getEnumValuesStr() ``` -Interface function to pass out the enumeration array as a - comma separated string +Interface function to pass out the enumeration array as a comma separated string + **Returns:** -: comma separated string of the possible values of the list +- comma separated string of the possible values of the list -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String input) ``` sets enum values + **Parameters:** -: `input:`- list of enum values +- `input:`- list of enum values -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String[] values) ``` sets enum values + **Parameters:** -: `values:`- list of enum values +- `values:`- list of enum values -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration aliases list with values. +takes a comma seperated string of values and fills the enumeration aliases list with values. + **Parameters:** -: `values`- A comma seperated string of enumeration aliases +- `values`- A comma seperated string of enumeration aliases -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String[] values) ``` -Takes an array of values and fills the enumeration aliases list with values. If null, aliases will be set to - an empty list. +Takes an array of values and fills the enumeration aliases list with values. If null, aliases will be set to an empty list. + **Parameters:** -: `values`- string array of enumeration aliases +- `values`- string array of enumeration aliases -- #### getEnumAliases +### getEnumAliases ```java public java.lang.String[] getEnumAliases() ``` An interface function for the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumAliasesStr +### getEnumAliasesStr ```java public java.lang.String getEnumAliasesStr() ``` An interface function for the enumeration array + **Returns:** -: an comma separated string of the possible values of the list +- an comma separated string of the possible values of the list -- #### _copyMetadataFromOther +### _copyMetadataFromOther ```java protected final void _copyMetadataFromOther(PHXString other) ``` Clone another PHXString's metadata. + **Parameters:** -: `other`- the other PHXString +- `other`- the other PHXString -- #### arrayToString +### arrayToString ```java @Deprecated public static java.lang.String arrayToString(java.lang.String[] sa) ``` -Deprecated.Do not use, does not generate correct strings. +**Deprecated.** Do not use, does not generate correct strings. + **Parameters:** -: `sa`- +- `sa`- + **Returns:** -- #### stringToArray +### stringToArray ```java public static java.lang.String[] stringToArray(java.lang.String s) ``` -- #### arrayToStringEscaped +### arrayToStringEscaped ```java public static java.lang.String arrayToStringEscaped(java.lang.String[] sa) ``` -Quotes each element of the array using c-style escape sequences, then - builds a comma separated list of the elements with quotes around each element. +Quotes each element of the array using c-style escape sequences, then builds a comma separated list of the elements with quotes around each element. + **Parameters:** -: `sa`- The array to read +- `sa`- The array to read + **Returns:** -: The generated string. +- The generated string. -- #### main +### main ```java public static void main(java.lang.String[] args) ``` -- #### equalsNatural +### equalsNatural ```java public boolean equalsNatural(PHXSimpleType toCompare) throws PHXTypeMismatchException ``` -Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than`Comparable`in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, - and may behave oddly if put in those circumstances. +Compare this PHXSimpleType to another PHXSimpleType. This type of comparison is different than `Comparable` in that it does a natural comparison between numbers. It is not designed, nor suited, for use in things such as sets, and may behave oddly if put in those circumstances. + **Specified by:** -: `equalsNatural`in class`PHXSimpleType` +- `equalsNatural` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toCompare`- +- `toCompare`- + **Returns:** -: a negative number if this object is less than toCompare, a positive number if this object is greater than - to compare, and zero if these two objects are equal. +- a negative number if this object is less than `toCompare`, a positive number if this object is greater than `toCompare`, and zero if these two objects are equal. + **Throws:** -: `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. +- `PHXTypeMismatchException`- if the given PHXSimpleType cannot be compared with this object. -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string + NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently upported. You MUST use the PHX string array formatting style. + **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md)- if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java public PHXString createCopy() ``` Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md index ef74453fcc..54520cf798 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXStringArray.md @@ -1,12 +1,16 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXStringArray -- java.lang.Object -- - [com.phoenix_int.aserver.types.PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) -- - [com.phoenix_int.aserver.types.PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)<[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html)> -- - com.phoenix_int.aserver.types.PHXStringArray -- **All Implemented Interfaces:** -: [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html),[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html),[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html), java.lang.Iterable<[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html)> +# Class PHXStringArray + + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXSimpleType + ↳ com.phoenix_int.aserver.types.PHXSimpleArray + ↳ com.phoenix_int.aserver.types.PHXStringArray +``` + +**All Implemented Interfaces:** +- [IPHXType](IPHXType.md), [IPHXType2](IPHXType2.md), [IPHXUnits](IPHXUnits.md), java.lang.Iterable<[PHXString](PHXString.md)> --- @@ -14,340 +18,352 @@ com.phoenix_int.aserver.types public class PHXStringArray extends PHXSimpleArray ``` -Class wraps an array of PHXString variables - for the ScriptWrapper utility. -**Version:** -: May 2002 -**Author:** -: Nathan P Sharp +Class wraps an array of PHXString variables for the ScriptWrapper utility. + + **See Also:** -: [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html)- ======== NESTED CLASS SUMMARY ======== -- ### Nested Class Summary +- [PHXSimpleArray](PHXSimpleArray.md) -- ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +## Nested Class Summary + +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) `IPHXType2.IVisitor` -=========== FIELD SUMMARY =========== -- ### Field Summary -- ### Fields inherited from class com.phoenix_int.aserver.types.PHXSimpleArray +## Field Summary + +### Fields inherited from class com.phoenix_int.aserver.types.[PHXSimpleArray](PHXSimpleArray.md) `_data,_lockDims,_lockResize` -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXStringArray()` | | `PHXStringArray(java.lang.Object data)` | | `PHXStringArray(PHXStringArrayother)` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `protected void` | `_getMetaData(PHXSimpleTypev2)`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. | -| `protected void` | `_setMetaData(PHXSimpleTypev2)`Sets a simple type's meta data based on the meta data - in this object. | -| ` T` | `Accept(IPHXType2.IVisitor visitor)`Accept a Visitor. | -| `PHXStringArray` | `createCopy()`Create a copy of this instance, including the value and metadata. | -| `protected boolean` | `dataTypeOK(java.lang.Class c)`Must override this function and return true if the specified - class is acceptable as an array element component type. | -| `protected java.lang.Object` | `elementFromString(java.lang.String val)`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object +| `protected void` | `_getMetaData(PHXSimpleTypev2)`
Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. | +| `protected void` | `_setMetaData(PHXSimpleTypev2)`
Sets a simple type's meta data based on the meta data in this object. | +| ` T` | `Accept(IPHXType2.IVisitor visitor)`
Accept a Visitor. | +| `PHXStringArray` | `createCopy()`
Create a copy of this instance, including the value and metadata. | +| `protected boolean` | `dataTypeOK(java.lang.Class c)`
Must override this function and return `true` if the specified class is acceptable as an array element component type. | +| `protected java.lang.Object` | `elementFromString(java.lang.String val)`
Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. | -| `void` | `fromObject(java.lang.Object toRead)`Load the value of this object from the specified object. | -| `java.lang.String[]` | `getEnumAliases()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumAliasesStr()`An interface function for the enumeration array | -| `java.lang.String[]` | `getEnumValues()`An interface function for the enumeration array | -| `java.lang.String` | `getEnumValuesStr()`Interface function to pass out the enumeration array as a - comma separated string | -| `java.lang.String` | `getStringValue(int index)`Gets a particular element as a String | -| `java.lang.String` | `getStringValue(int[] index)`Gets a particular element as a String | -| `PHXString` | `getValue(int[] index)`Gets a particular element as a PHXString | -| `void` | `setEnumAliases(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration aliases list with values. | -| `void` | `setEnumAliases(java.lang.String[] values)`Sets the enumeration aliases list | -| `void` | `setEnumValues(java.lang.String values)`takes a comma seperated string of values and fills the - enumeration List with values. | -| `void` | `setEnumValues(java.lang.String[] values)`sets enum values | -| `void` | `setValue(int[] index,PHXStringval)`Sets a particular element as a PHXString | -| `void` | `setValue(int[] index, - java.lang.String val)`Sets a particular element as a String | -| `void` | `setValue(int index, - java.lang.String val)`Sets a particular element as a String | - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleArray -`_getMetaData,_setMetaData,allocateElement,checkRectangular,copy,equalsNatural,fromString,fromString,fromString,fromString,fromString2,generateFor,generateFor,getArray,getArrayElement,getArrayElement,getComponentType,getComponentType,getDimensions,getDimensions,getFirst,getLength,getLength,getLockResize,getnDIndex,getNumDimensions,getNumDimensions,getSelf,getValue,incrementIndex,iterator,lockDimensions,newIndex,parseIndex,resize,setArray,setArrayElement,setArrayElement,setDimensions,setFirst,setLength,setLength,setLockResize,setValue,toString,toString,toString,toString,toString2,toString2,toString2,validElement` - -- ### Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType -`_copyMetadataFromOther,addPropertyChangeListener,getDescription,getEnumTokens,getHasChanged,getUnits,removePropertyChangeListener,setDescription,setHasChanged,setUnits` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` - -- ### Methods inherited from interface java.lang.Iterable -`forEach, spliterator`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXStringArray +| `void` | `fromObject(java.lang.Object toRead)`
Load the value of this object from the specified object. | +| `java.lang.String[]` | `getEnumAliases()`
An interface function for the enumeration array | +| `java.lang.String` | `getEnumAliasesStr()`
An interface function for the enumeration array | +| `java.lang.String[]` | `getEnumValues()`
An interface function for the enumeration array | +| `java.lang.String` | `getEnumValuesStr()`
Interface function to pass out the enumeration array as a comma separated string | +| `java.lang.String` | `getStringValue(int index)`
Gets a particular element as a String | +| `java.lang.String` | `getStringValue(int[] index)`
Gets a particular element as a String | +| `PHXString` | `getValue(int[] index)
`Gets a particular element as a PHXString | +| `void` | `setEnumAliases(java.lang.String values)`
takes a comma seperated string of values and fills the enumeration aliases list with values. | +| `void` | `setEnumAliases(java.lang.String[] values)`
Sets the enumeration aliases list | +| `void` | `setEnumValues(java.lang.String values)`
takes a comma seperated string of values and fills the enumeration List with values. | +| `void` | `setEnumValues(java.lang.String[] values)`
sets enum values | +| `void` | `setValue(int[] index,PHXStringval)`
Sets a particular element as a PHXString | +| `void` | `setValue(int[] index, java.lang.String val)`
Sets a particular element as a String | +| `void` | `setValue(int index, java.lang.String val)`
Sets a particular element as a String | + +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleArray](PHXSimpleArray.md) +`_getMetaData`, `_setMetaData`, `allocateElement`, `checkRectangular`, `copy`, `equalsNatural`, `fromString`, `fromString`, `fromString`, `fromString`, `fromString2`, `generateFor`, `generateFor`, `getArray`, `getArrayElement`, `getArrayElement`, `getComponentType`, `getComponentType`, `getDimensions`, `getDimensions`, `getFirst`, `getLength`, `getLength`, `getLockResize`, `getnDIndex`, `getNumDimensions`, `getNumDimensions`, `getSelf`, `getValue`, `incrementIndex`, `iterator`, `lockDimensions`, `newIndex`, `parseIndex`, `resize`, `setArray`, `setArrayElement`, `setArrayElement`, `setDimensions`, `setFirst`, `setLength`, `setLength`, `setLockResize`, `setValue`, `toString`, `toString`, `toString`, `toString`, `toString2`, `toString2`, `toString2`, `validElement` + +### Methods inherited from class com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) +`_copyMetadataFromOther`, `addPropertyChangeListener`, `getDescription`, `getEnumTokens`, `getHasChanged`, `getUnits`, `removePropertyChangeListener`, `setDescription`, `setHasChanged`, `setUnits` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +### Methods inherited from interface java.lang.Iterable +`forEach`, `spliterator` + +## Constructor Detail + +### PHXStringArray ```java public PHXStringArray() ``` -- #### PHXStringArray +### PHXStringArray ```java public PHXStringArray(java.lang.Object data) ``` -- #### PHXStringArray +### PHXStringArray ```java public PHXStringArray(PHXStringArray other) ``` -============ METHOD DETAIL ========== -- ### Method Detail -- #### dataTypeOK +### Method Detail + +### dataTypeOK ```java protected boolean dataTypeOK(java.lang.Class c) ``` -Description copied from class:`PHXSimpleArray`Must override this function and return true if the specified - class is acceptable as an array element component type. +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Must override this function and return `true` if the specified class is acceptable as an array element component type. + **Specified by:** -: `dataTypeOK`in class`PHXSimpleArray` +- `dataTypeOK` in class `PHXSimpleArray` -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration List with values. +takes a comma seperated string of values and fills the enumeration List with values. + **Parameters:** -: `values`- A comma seperrated string of enumeration values +- `values`- A comma seperrated string of enumeration values -- #### setEnumValues +### setEnumValues ```java public void setEnumValues(java.lang.String[] values) ``` sets enum values + **Parameters:** -: `values:`- list of enum values +- `values:`- list of enum values -- #### getEnumValues +### getEnumValues ```java public java.lang.String[] getEnumValues() ``` An interface function for the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumValuesStr +### getEnumValuesStr ```java public java.lang.String getEnumValuesStr() ``` -Interface function to pass out the enumeration array as a - comma separated string +Interface function to pass out the enumeration array as a comma separated string + **Returns:** -: comma separated string of the possible values of the list +- comma separated string of the possible values of the list -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String values) ``` -takes a comma seperated string of values and fills the - enumeration aliases list with values. +takes a comma seperated string of values and fills the enumeration aliases list with values. + **Parameters:** -: `values`- A comma seperated string of enumeration aliases +- `values`- A comma seperated string of enumeration aliases -- #### setEnumAliases +### setEnumAliases ```java public void setEnumAliases(java.lang.String[] values) ``` Sets the enumeration aliases list + **Parameters:** -: `values`- An array of strings +- `values`- An array of strings -- #### getEnumAliases +### getEnumAliases ```java public java.lang.String[] getEnumAliases() ``` An interface function for the enumeration array + **Returns:** -: an array of the possible values of the list +- an array of the possible values of the list -- #### getEnumAliasesStr +### getEnumAliasesStr ```java public java.lang.String getEnumAliasesStr() ``` An interface function for the enumeration array + **Returns:** -: an comma separated string of the possible values of the list +- an comma separated string of the possible values of the list -- #### _setMetaData +### _setMetaData ```java protected void _setMetaData(PHXSimpleType v2) ``` -Description copied from class:`PHXSimpleArray`Sets a simple type's meta data based on the meta data - in this object. Override this to set additional - information in sub-classes. Be sure to call - super._setMetaData(PHXSimpleType) +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Sets a simple type's meta data based on the meta data in this object. Override this to set additional information in sub-classes. Be sure to call `super._setMetaData(PHXSimpleType)`. + **Overrides:** -: `_setMetaData`in class`PHXSimpleArray` +- `_setMetaData` in class `PHXSimpleArray` -- #### _getMetaData +### _getMetaData ```java protected void _getMetaData(PHXSimpleType v2) ``` -Description copied from class:`PHXSimpleArray`Worker which takes the meta data from an instance of PHXSimpleType - and sets it into our meta data. Override this in order to add - more custom meta data in sub-classes. Be sure to cal - super._getMetaData(PHXSimpleType), though! +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Worker which takes the meta data from an instance of PHXSimpleType and sets it into our meta data. Override this in order to add more custom meta data in sub-classes. Be sure to call `super._getMetaData(PHXSimpleType)`, though! + **Overrides:** -: `_getMetaData`in class`PHXSimpleArray` +- `_getMetaData` in class `PHXSimpleArray` -- #### getValue +### getValue ```java public PHXString getValue(int[] index) ``` Gets a particular element as a PHXString + **Specified by:** -: `getValue`in class`PHXSimpleArray` +- `getValue` in class `PHXSimpleArray` + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index + **Returns:** -: referenced array value +- referenced array value -- #### getStringValue +### getStringValue ```java public java.lang.String getStringValue(int index) ``` Gets a particular element as a String + **Parameters:** -: `index`- nD array index +- `index`- nD array index + **Returns:** -: referenced array value +- referenced array value + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### getStringValue +### getStringValue ```java public java.lang.String getStringValue(int[] index) ``` Gets a particular element as a String + **Parameters:** -: `index`- nD array index +- `index`- nD array index + **Returns:** -: referenced array value +- referenced array value -- #### setValue +### setValue ```java public void setValue(int[] index, PHXString val) ``` Sets a particular element as a PHXString + **Specified by:** -: `setValue`in class`PHXSimpleArray` +- `setValue` in class `PHXSimpleArray` + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index : `val`- value to set -- #### setValue +### setValue ```java public void setValue(int index, java.lang.String val) ``` Sets a particular element as a String + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index : `val`- value to set + **Throws:** -: `java.lang.IllegalArgumentException`- thrown if called on non-1D array +- `java.lang.IllegalArgumentException`- thrown if called on non-1D array -- #### setValue +### setValue ```java public void setValue(int[] index, java.lang.String val) ``` Sets a particular element as a String + **Parameters:** -: `index`- 1D array index +- `index`- 1D array index : `val`- value to set -- #### elementFromString +### elementFromString ```java protected java.lang.Object elementFromString(java.lang.String val) ``` -Description copied from class:`PHXSimpleArray`Sub-classes must provide an implementation of this function - which converts a string form of a single element to Object - form. This is only used when the element type does not - implement IPHXType or IPHXType2. For primitives, return - the wrapper objects. +Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md) + +Sub-classes must provide an implementation of this function which converts a string form of a single element to Object form. This is only used when the element type does not implement [IPHXType](IPHXType.md) or [IPHXType2](IPHXType2.md). For primitives, return the wrapper objects. + **Specified by:** -: `elementFromString`in class`PHXSimpleArray` +- `elementFromString` in class `PHXSimpleArray` -- #### fromObject +### fromObject ```java public void fromObject(java.lang.Object toRead) throws PHXInvalidTypeException ``` -Load the value of this object from the specified object. This will read the object and attempt to convert it if it - is a known type. If the type isn't recognized, it will throw a PHXInvalidTypeException. If there is an error in - conversion, it will also throw a PHXInvalidTypeException +Load the value of this object from the specified object. This will read the object and attempt to convert it if it is a known type. If the type isn't recognized, it will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md). + +NOTE: while it might be logical to think you can create a `PHX(Type)Array` from, say, an array of `java.lang.(Type)`, that is not currently upported. You MUST use the PHX string array formatting style. - NOTE: while it might be logical to think you can create a PHX(Type)Array from, say, an - array of java.lang.(Type), that is not currently supported. You MUST use the PHX string - array formatting style. **Specified by:** -: `fromObject`in class`PHXSimpleType` +- `fromObject` in class [`PHXSimpleType`](PHXSimpleType.md) + **Parameters:** -: `toRead`- to object from which to load this objects value. +- `toRead`- to object from which to load this objects value. + **Throws:** -: `PHXInvalidTypeException`- if the specified object is of an invalid type or there is an error in conversion. +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) - if the specified object is of an invalid type or there is an error in conversion. -- #### Accept +### Accept ```java public  T Accept(IPHXType2.IVisitor visitor) ``` Accept a Visitor. + **Type Parameters:** -: `T`- Type of the result of the visit. +- `T`- Type of the result of the visit. + **Parameters:** -: `visitor`- The visitor to accept. +- `visitor`- The visitor to accept. + **Returns:** -: The results of the visit. +- The results of the visit. -- #### createCopy +### createCopy ```java public PHXStringArray createCopy() ``` -Description copied from class:`PHXSimpleType`Create a copy of this instance, including the value and metadata. +Description copied from class: [`PHXSimpleType`](PHXSimpleType.md) + +Create a copy of this instance, including the value and metadata. + **Specified by:** -: `createCopy`in class`PHXSimpleType` +- `createCopy` in class [`PHXSimpleType`](PHXSimpleType.md) + **Returns:** -: a newly constructed copy of this instance. -========= END OF CLASS DATA ========= \ No newline at end of file +- a newly constructed copy of this instance. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md index 121d60d49d..3a2ee9b9db 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeFactory.md @@ -1,343 +1,380 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXTypeFactory -- java.lang.Object -- - com.phoenix_int.aserver.types.PHXTypeFactory -- --- +# Class PHXTypeFactory + +**Package:** `com.phoenix_int.aserver.types` +``` +↳ java.lang.Object + ↳ com.phoenix_int.aserver.types.PHXTypeFactory +``` +--- + +**Declaration:** ```java public class PHXTypeFactory extends java.lang.Object ``` + A class for creating variables -**Author:** -: Woyak, 6/00 + + **See Also:** -: [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)- =========== FIELD SUMMARY =========== -- ### Field Summary +- [PHXSimpleType](PHXSimpleType.md)- + +## Field Summary | Modifier and Type | Field and Description | | --- | --- | | Modifier and Type | Field and Description | -| `static java.lang.String` | `BOOLEAN`Type identifier for a boolean type | -| `static java.lang.String` | `BOOLEAN_ARRAY`Type identifier for a boolean array type | -| `static java.lang.String` | `DOUBLE`Type identifier for a double type | -| `static java.lang.String` | `DOUBLE_ARRAY`Type identifier for a double array type | -| `static java.lang.String` | `FILE`Type identifier for a file type | -| `static java.lang.String` | `FILE_ARRAY`Type identifier for a file array type | -| `static java.lang.String` | `GEOMETRY`Type identifier for a geometry type | -| `static java.lang.String` | `LONG`Type identifier for a long type | -| `static java.lang.String` | `LONG_ARRAY`Type identifier for a long array type | -| `static java.lang.String` | `OBJECT`Type identifier for an object type | -| `static java.lang.String` | `REFERENCE`Type identifier for a reference type | -| `static java.lang.String` | `REFERENCE_ARRAY`Type identifier for a reference array type | -| `static java.lang.String` | `STRING`Type identifier for a string type | -| `static java.lang.String` | `STRING_ARRAY`Type identifier for a string array type | -| `static java.lang.String` | `UNKNOWN`Type identifier for an unknown type | -| `static java.lang.String` | `UNKNOWN_ARRAY`Type identifier for an unknown array type | -======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +| `static java.lang.String` | `BOOLEAN`
Type identifier for a boolean type | +| `static java.lang.String` | `BOOLEAN_ARRAY`
Type identifier for a boolean array type | +| `static java.lang.String` | `DOUBLE`
Type identifier for a double type | +| `static java.lang.String` | `DOUBLE_ARRAY`
Type identifier for a double array type | +| `static java.lang.String` | `FILE`
Type identifier for a file type | +| `static java.lang.String` | `FILE_ARRAY`
Type identifier for a file array type | +| `static java.lang.String` | `GEOMETRY`
Type identifier for a geometry type | +| `static java.lang.String` | `LONG`
Type identifier for a long type | +| `static java.lang.String` | `LONG_ARRAY`
Type identifier for a long array type | +| `static java.lang.String` | `OBJECT`
Type identifier for an object type | +| `static java.lang.String` | `REFERENCE`
Type identifier for a reference type | +| `static java.lang.String` | `REFERENCE_ARRAY`
Type identifier for a reference array type | +| `static java.lang.String` | `STRING`
Type identifier for a string type | +| `static java.lang.String` | `STRING_ARRAY`
Type identifier for a string array type | +| `static java.lang.String` | `UNKNOWN`
Type identifier for an unknown type | +| `static java.lang.String` | `UNKNOWN_ARRAY`
Type identifier for an unknown array type | + + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | | `PHXTypeFactory()` | -========== METHOD SUMMARY =========== -- ### Method Summary + +## Method Summary | Modifier and Type | Method and Description | | --- | --- | -| Modifier and Type | Method and Description | -| `static void` | `_verifyIsArrayType(java.lang.String type)`utility function for verifying that a type string is an - array type - it is in the form "XXXX[#]" | -| `staticPHXSimpleArray` | `allocateArray(java.lang.String arrayType)`Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays - and non-array types. | -| `staticIPHXType2` | `allocateVariable(java.lang.String type)`Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays - and non-array types. | -| `staticIPHXType2` | `allocateVariable2(java.lang.String type)`Allocate a given variable for the given type string | -| `static java.lang.Class` | `getClass(java.lang.String type)`returns the class for the specified type. | -| `static java.lang.Class` | `getVariableClass(java.lang.String type)`Returns the class associated with the type string. | -| `static java.lang.String` | `getVarType(java.lang.String className)`Given the class name, determine the corresponding type. | -| `staticPHXSimpleType` | `toPHXSimpleType(java.lang.Object input, - java.lang.Class simpleTypeClass)`Converts the given type to the associated PHXSimpleType. | - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`- ============ FIELD DETAIL =========== -- ### Field Detail - -- #### UNKNOWN +| `static void` | `_verifyIsArrayType(java.lang.String type)`
utility function for verifying that a type string is an + array type - it is in the form `"XXXX[#]"` | +| `staticPHXSimpleArray` | `allocateArray(java.lang.String arrayType)`
**Deprecated.** Prefer `allocateVariable2(java.lang.String)` which can properly differentiate between arrays and non-array types. | +| `staticIPHXType2` | `allocateVariable(java.lang.String type)`
**Deprecated.** Prefer `allocateVariable2(java.lang.String)` which can properly differentiate between arrays and non-array types. | +| `staticIPHXType2` | `allocateVariable2(java.lang.String type)`
Allocate a given variable for the given type string | +| `static java.lang.Class` | `getClass(java.lang.String type)`
returns the class for the specified type. | +| `static java.lang.Class` | `getVariableClass(java.lang.String type)`
Returns the class associated with the type string. | +| `static java.lang.String` | `getVarType(java.lang.String className)`
Given the class name, determine the corresponding type. | +| `staticPHXSimpleType` | `toPHXSimpleType(java.lang.Object input, java.lang.Class simpleTypeClass)`
Converts the given type to the associated PHXSimpleType. | + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` + + +## Field Detail + +### UNKNOWN ```java public static final java.lang.String UNKNOWN ``` Type identifier for an unknown type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.UNKNOWN) +- [Constant Field Values](../../../../constant-values.md) -- #### UNKNOWN_ARRAY +### UNKNOWN_ARRAY ```java public static final java.lang.String UNKNOWN_ARRAY ``` Type identifier for an unknown array type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.UNKNOWN_ARRAY) +- [Constant Field Values](../../../../constant-values.md) -- #### BOOLEAN +### BOOLEAN ```java public static final java.lang.String BOOLEAN ``` Type identifier for a boolean type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.BOOLEAN) +- [Constant Field Values](../../../../constant-values.md) -- #### BOOLEAN_ARRAY +### BOOLEAN_ARRAY ```java public static final java.lang.String BOOLEAN_ARRAY ``` Type identifier for a boolean array type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.BOOLEAN_ARRAY) +- [Constant Field Values](../../../../constant-values.md) -- #### DOUBLE +### DOUBLE ```java public static final java.lang.String DOUBLE ``` Type identifier for a double type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.DOUBLE) +- [Constant Field Values](../../../../constant-values.md) -- #### DOUBLE_ARRAY +### DOUBLE_ARRAY ```java public static final java.lang.String DOUBLE_ARRAY ``` Type identifier for a double array type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.DOUBLE_ARRAY) +- [Constant Field Values](../../../../constant-values.md) -- #### LONG +### LONG ```java public static final java.lang.String LONG ``` Type identifier for a long type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.LONG) +- [Constant Field Values](../../../../constant-values.md) -- #### LONG_ARRAY +### LONG_ARRAY ```java public static final java.lang.String LONG_ARRAY ``` Type identifier for a long array type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.LONG_ARRAY) +- [Constant Field Values](../../../../constant-values.md) -- #### FILE +### FILE ```java public static final java.lang.String FILE ``` Type identifier for a file type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.FILE) +- [Constant Field Values](../../../../constant-values.md) -- #### FILE_ARRAY +### FILE_ARRAY ```java public static final java.lang.String FILE_ARRAY ``` Type identifier for a file array type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.FILE_ARRAY) +- [Constant Field Values](../../../../constant-values.md) -- #### STRING +### STRING ```java public static final java.lang.String STRING ``` Type identifier for a string type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.STRING) +- [Constant Field Values](../../../../constant-values.md) -- #### STRING_ARRAY +### STRING_ARRAY ```java public static final java.lang.String STRING_ARRAY ``` Type identifier for a string array type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.STRING_ARRAY) +- [Constant Field Values](../../../../constant-values.md) -- #### GEOMETRY +### GEOMETRY ```java public static final java.lang.String GEOMETRY ``` Type identifier for a geometry type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.GEOMETRY) +- [Constant Field Values](../../../../constant-values.md) -- #### OBJECT +### OBJECT ```java public static final java.lang.String OBJECT ``` Type identifier for an object type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.OBJECT) +- [Constant Field Values](../../../../constant-values.md) -- #### REFERENCE +### REFERENCE ```java public static final java.lang.String REFERENCE ``` Type identifier for a reference type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.REFERENCE) +- [Constant Field Values](../../../../constant-values.md) -- #### REFERENCE_ARRAY +### REFERENCE_ARRAY ```java public static final java.lang.String REFERENCE_ARRAY ``` Type identifier for a reference array type + **See Also:** -: [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.types.PHXTypeFactory.REFERENCE_ARRAY) -========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail +- [Constant Field Values](../../../../constant-values.md) + + +## Constructor Detail -- #### PHXTypeFactory +### PHXTypeFactory ```java public PHXTypeFactory() ``` ============ METHOD DETAIL ========== -- ### Method Detail +### Method Detail -- #### allocateVariable2 +### allocateVariable2 ```java public static IPHXType2 allocateVariable2(java.lang.String type) throws PHXInvalidTypeException ``` Allocate a given variable for the given type string + **Parameters:** -: `type`- the type of the variable to instantiate +- `
Type` - the type of the variable to instantiate + **Returns:** -: the instantiated variable +- the instantiated variable + **Throws:** -: `PHXInvalidTypeException` +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) -- #### allocateVariable +### allocateVariable ```java @Deprecated public static IPHXType2 allocateVariable(java.lang.String type) throws PHXInvalidTypeException ``` -Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays - and non-array types.creates a variable from a type string +**Deprecated.** Prefer `allocateVariable2(java.lang.String)` which can properly differentiate between arrays and non-array types. + +Creates a variable from a type string + **Parameters:** -: `type`- the type string, e.g. "double" +- `
Type` - the type string, e.g. "double" + **Returns:** -: the allocated variable +- the allocated variable + **Throws:** -: `PHXInvalidTypeException` +- `PHXInvalidTypeException` -- #### allocateArray +### allocateArray ```java @Deprecated public static PHXSimpleArray allocateArray(java.lang.String arrayType) throws PHXInvalidTypeException ``` -Deprecated.Prefer[allocateVariable2(java.lang.String)](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#allocateVariable2-java.lang.String-)which can properly differentiate between arrays - and non-array types.creates an array from a type string. - Creates the PHXSimpleArray type, although it overrides the default - behaviour of having he PHXSimpleArray store primitives internally - in favor of having it store the PHX type. +**Deprecated.** Prefer `allocateVariable2(java.lang.String)` which can properly differentiate between arrays and non-array types. + +creates an array from a type string. + +Creates the PHXSimpleArray type, although it overrides the default behaviour of having the PHXSimpleArray store primitives internally in favor of having it store the PHX type. + **Parameters:** -: `arrayType`- the type string, e.g. "double[5]", "string[3][3]", etc. +- `arrayType` - the type string, e.g. `"double[5]"`, `"string[3][3]"`, etc. + **Returns:** -: the allocated variable +- the allocated variable + **Throws:** -: `PHXInvalidTypeException` +- `PHXInvalidTypeException` -- #### _verifyIsArrayType +### _verifyIsArrayType ```java public static void _verifyIsArrayType(java.lang.String type) throws PHXInvalidTypeException ``` -utility function for verifying that a type string is an - array type - it is in the form "XXXX[#]" +utility function for verifying that a type string is an array type - it is in the form `"XXXX[#]"` + **Parameters:** -: `type`- the type string +- `
Type` - the type string + **Throws:** -: `PHXInvalidTypeException` +- `PHXInvalidTypeException` -- #### getClass +### getClass ```java public static java.lang.Class getClass(java.lang.String type) throws PHXInvalidTypeException ``` -returns the class for the specified type. If the specified type is an - array, the class of one of it's members is returned +returns the class for the specified type. If the specified type is an array, the class of one of its members is returned + **Parameters:** -: `type`- the type string in format "double" or "double[5]" +- `
Type` - the type string in format "double" or "double[5]" + **Returns:** -: the class of the specified type +- the class of the specified type + **Throws:** -: `PHXInvalidTypeException` +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) -- #### getVariableClass +### getVariableClass ```java public static java.lang.Class getVariableClass(java.lang.String type) throws PHXInvalidTypeException ``` Returns the class associated with the type string. This includes array classes if the type ends with "[]" or "Array" + **Parameters:** -: `type`- the string representing the type, such as "string", "double[]", or "IntegerArray" +- `
Type` - the string representing the type, such as "string", "double[]", or "IntegerArray" + **Returns:** -: the class of the variable type +- the class of the variable type + **Throws:** -: `PHXInvalidTypeException`- if the type string does not match a known type +- [`PHXInvalidTypeException`](PHXInvalidTypeException.md) - if the type string does not match a known type -- #### getVarType +### getVarType ```java public static java.lang.String getVarType(java.lang.String className) ``` Given the class name, determine the corresponding type. + **Parameters:** -: `className`- class name of the variable, i.e. "PHXDouble", "PHXDoubleArray", etc. +- `className` - class name of the variable, i.e. "PHXDouble", "PHXDoubleArray", etc. + **Returns:** -: variable name type, i.e. "double", "double[]", etc. +- variable name type, i.e. "double", "double[]", etc. -- #### toPHXSimpleType +### toPHXSimpleType ```java public static PHXSimpleType toPHXSimpleType(java.lang.Object input, java.lang.Class simpleTypeClass) throws PHXTypeMismatchException ``` -Converts the given type to the associated PHXSimpleType. This will always create a new object, regardless of - whether or not the given type is a PHXSimpleType. If there is an error converting, or the class does not have an - associated PHXSimpleType, this will throw a PHXInvalidTypeException +Converts the given type to the associated PHXSimpleType. This will always create a new object, regardless of whether or not the given type is a PHXSimpleType. If there is an error converting, or the class does not have an associated [PHXSimpleType](PHXSimpleType.md), this will throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md) + **Parameters:** -: `input`- the object to convert to a PHXSimpleType -: `simpleTypeClass`- the class of PHXSimpleType to convert to +- `input` - the object to convert to a [PHXSimpleType](PHXSimpleType.md) +: `simpleTypeClass` - the class of [PHXSimpleType](PHXSimpleType.md) to convert to + **Returns:** -: a new object containing the value of the input; in the case of PHXRawFile and PHXRawFileArray, only a new - instance is returned, the value is not copied +- a new object containing the value of the input; in the case of PHXRawFile and PHXRawFileArray, only a new instance is returned, the value is not copied + **Throws:** -: `PHXTypeMismatchException`- if there is an error creating the PHXSimpleType object, or if the given type - cannot be converted to a PHXSimpleType -========= END OF CLASS DATA ========= \ No newline at end of file +- [`PHXTypeMismatchException`](PHXTypeMismatchException.md) - if there is an error creating the [PHXSimpleType](PHXSimpleType.md) object, or if the given type cannot be converted to a [PHXSimpleType](PHXSimpleType.md) diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md index dc5a8d8c46..023c272024 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/PHXTypeMismatchException.md @@ -1,12 +1,17 @@ -======== START OF CLASS DATA ======== -com.phoenix_int.aserver.types -## Class PHXTypeMismatchException -- java.lang.Object -- - java.lang.Throwable -- - java.lang.Exception -- - com.phoenix_int.aserver.types.PHXTypeMismatchException -- **All Implemented Interfaces:** -: java.io.Serializable +# Class PHXTypeMismatchException + + +**Package:** `com.phoenix_int.aserver.types` + +``` +↳ java.lang.Object + ↳ java.lang.Throwable + ↳ java.lang.Exception + ↳ com.phoenix_int.aserver.types.PHXTypeMismatchException +``` + +**All Implemented Interfaces:** +- java.io.Serializable --- @@ -14,34 +19,30 @@ com.phoenix_int.aserver.types public class PHXTypeMismatchException extends java.lang.Exception ``` -An exception thrown when trying to set a value using an incompatible type, or when trying to - compare two values of incompatible types +An exception thrown when trying to set a value using an incompatible type, or when trying to compare two values of incompatible types + **See Also:** -: [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.types.PHXTypeMismatchException)- ======== CONSTRUCTOR SUMMARY ======== -- ### Constructor Summary +- [Serialized Form](../../../../serialized-form.md) + +## Constructor Summary | Constructor and Description | | --- | -| Constructor and Description | -| `PHXTypeMismatchException(java.lang.String givenType, - java.lang.String expectedType)`Create an exception for attempting to compare two values of incompatible types | -| `PHXTypeMismatchException(java.lang.String name, - java.lang.String type, - java.lang.String expectedType)`Create an exception for attempting to set a value using an incompatible type | -| `PHXTypeMismatchException(java.lang.String givenType, - java.lang.String expectedType, - java.lang.Throwable cause)`Create an exception for attempting to compare two values of incompatible types | -========== METHOD SUMMARY =========== -- ### Method Summary - -- ### Methods inherited from class java.lang.Throwable -`addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString` - -- ### Methods inherited from class java.lang.Object -`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`- ========= CONSTRUCTOR DETAIL ======== -- ### Constructor Detail - -- #### PHXTypeMismatchException +| `PHXTypeMismatchException(java.lang.String givenType, java.lang.String expectedType)`
Create an exception for attempting to compare two values of incompatible types | +| `PHXTypeMismatchException(java.lang.String name, java.lang.String type, java.lang.String expectedType)`
Create an exception for attempting to set a value using an incompatible type | +| `PHXTypeMismatchException(java.lang.String givenType, java.lang.String expectedType, java.lang.Throwable cause)`
Create an exception for attempting to compare two values of incompatible types | + +## Method Summary + +### Methods inherited from class java.lang.Throwable +`addSuppressed`, `fillInStackTrace`, `getCause`, `getLocalizedMessage`, `getMessage`, `getStackTrace`, `getSuppressed`, `initCause`, `printStackTrace`, `printStackTrace`, `printStackTrace`, `setStackTrace`, `toString` + +### Methods inherited from class java.lang.Object +`clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `wait`, `wait`, `wait` + +## Constructor Detail + +### PHXTypeMismatchException ```java public PHXTypeMismatchException(java.lang.String name, @@ -49,23 +50,25 @@ public PHXTypeMismatchException(java.lang.String name, java.lang.String expectedType) ``` Create an exception for attempting to set a value using an incompatible type + **Parameters:** -: `name`- the name of the variable where the error occurred -: `type`- the bad type -: `expectedType`- the type that should have been used +- `name`- the name of the variable where the error occurred +- `type`- the bad type +- `expectedType`- the type that should have been used -- #### PHXTypeMismatchException +### PHXTypeMismatchException ```java public PHXTypeMismatchException(java.lang.String givenType, java.lang.String expectedType) ``` Create an exception for attempting to compare two values of incompatible types + **Parameters:** -: `givenType`- the bad type that was passed to the comparator -: `expectedType`- the type expected by the comparator +- `givenType`- the bad type that was passed to the comparator +- `expectedType`- the type expected by the comparator -- #### PHXTypeMismatchException +### PHXTypeMismatchException ```java public PHXTypeMismatchException(java.lang.String givenType, @@ -73,8 +76,8 @@ public PHXTypeMismatchException(java.lang.String givenType, java.lang.Throwable cause) ``` Create an exception for attempting to compare two values of incompatible types + **Parameters:** -: `givenType`- the bad type that was passed to the comparator -: `expectedType`- the type expected by the comparator -: `cause`- exception which caused this exception to be thrown -========= END OF CLASS DATA ========= \ No newline at end of file +- `givenType`- the bad type that was passed to the comparator +- `expectedType`- the type expected by the comparator +- `cause`- exception which caused this exception to be thrown diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-frame.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-frame.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md index 9cbcdd821b..49f5741ea1 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-summary.md @@ -1,90 +1,59 @@ # Package com.phoenix_int.aserver.types + Provides a collection of basic data types that contain meta-information like description and units. -See:Description -- | Interface | Description | -| --- | --- | -| [IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html) | Interface for types with descriptions | -| [IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html) | Interface for variables that support formats | -| [IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) | This interface provides information about a reference property:**name**: String**type**: String**enumValues**: String[]**description**: String**title**: String**input**: boolean - - where type may be any of the following: +## Interface Summary - - "long" - "double" - "boolean" - "string" | -| [IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html) | The interface for all Phoenix types. | -| [IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) | The interface for Phoenix types which use PHXStringBuffer instead of String for performance. | -| [IPHXType2.IVisitor](../../../../com/phoenix_int/aserver/types/IPHXType2.IVisitor.html) | The interface of a visitor into an IPHXType2. | -| [IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) | Interface for PHX variables that support units | -- | Class | Description | +| Interface | Description | | --- | --- | -| [PHXAppearance](../../../../com/phoenix_int/aserver/types/PHXAppearance.html) | This is a utility class for holding appearance properties. | -| [PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html) | The Phoenix type for booleans. | -| [PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html) | Class wraps an array of PHXBoolean variables - for the ScriptWrapper utility. | -| [PHXDataCollector](../../../../com/phoenix_int/aserver/types/PHXDataCollector.html) | A class for Driver Components to tell ModelCenter what to do with the - DataCollector while the component is running. | -| [PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html) | The Phoenix type for doubles. | -| [PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html) | Class wraps an array of PHXDouble variables - for the ScriptWrapper utility. | -| [PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html) | Deprecated | -| [PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html) | The Phoenix type for geometry. | -| [PHXGeomInfo](../../../../com/phoenix_int/aserver/types/PHXGeomInfo.html) | this is a utility class that mirrors the structures in ModelCenter. | -| [PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html) | Deprecated | -| [PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html) | The Phoenix type for longs. | -| [PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html) | Class wraps an array of PHXLong variables - for the ScriptWrapper utility. | -| [PHXMassProperties](../../../../com/phoenix_int/aserver/types/PHXMassProperties.html) | This is a utility class for holding mass property information. | -| [PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html) | Placeholder for an array of any random Java Object. | -| [PHXOrientation](../../../../com/phoenix_int/aserver/types/PHXOrientation.html) | This is a utility class for holding orientation information. | -| [PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html) | The Phoenix type for Files. | -| [PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html) | Wraps an array of PHXRawFile variables - for the ScriptWrapper utility. | -| [PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html) | This is a class for holding properties of a reference - object**type**: String**enumValues**: String[]**description**: String**title**: String**input**: boolean - +| [IPHXDescription](IPHXDescription.md) | Interface for types with descriptions | +| [IPHXFormat](IPHXFormat.md) | Interface for variables that support formats | +| [IPHXRefPropInfo](IPHXRefPropInfo.md) | This interface provides information about a reference property: **name**: String **type**: String **enumValues**: String[] **description**: String **title**: String **input**: boolean, where `type` may be any of the following: "long", "double", "boolean", "string" | +| [IPHXType](IPHXType.md) | The interface for all Phoenix types. | +| [IPHXType2](IPHXType2.md) | The interface for Phoenix types which use PHXStringBuffer instead of String for performance. | +| [IPHXType2.IVisitor](IPHXType2.IVisitor.md) | The interface of a visitor into an IPHXType2. | +| [IPHXUnits](IPHXUnits.md) | Interface for PHX variables that support units | - where type may be any of the following: +## Class Summary - - "long" - "double" - "boolean" - "string" | -| [PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html) | The Phoenix type for references. | -| [PHXReferenceArray](../../../../com/phoenix_int/aserver/types/PHXReferenceArray.html) | The Phoenix type for references. | -| [PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html) | This is a class for holding properties of a reference - object**type**: String**enumValues**: String[]**description**: String**title**: String**input**: boolean - +| Class | Description | +| --- | --- | +| [PHXAppearance](PHXAppearance.md) | This is a utility class for holding appearance properties. | +| [PHXBoolean](PHXBoolean.md) | The ModelCenter type for booleans. | +| [PHXBooleanArray](PHXBooleanArray.md) | Class wraps an array of PHXBoolean variables for the ScriptWrapper utility. | +| [PHXDataCollector](PHXDataCollector.md) | A class for Driver Components to tell ModelCenter what to do with the DataCollector while the component is running. | +| [PHXDouble](PHXDouble.md) | The ModelCenter type for doubles. | +| [PHXDoubleArray](PHXDoubleArray.md) | Class wraps an array of PHXDouble variables for the ScriptWrapper utility. | +| [PHXFile](PHXFile.md) | Deprecated | +| [PHXGeometry](PHXGeometry.md) | The ModelCenter type for geometry. | +| [PHXGeomInfo](PHXGeomInfo.md) | this is a utility class that mirrors the structures in ModelCenter. | +| [PHXInteger](PHXInteger.md) | Deprecated | +| [PHXLong](PHXLong.md) | The ModelCenter type for longs. | +| [PHXLongArray](PHXLongArray.md) | Class wraps an array of PHXLong variables for the ScriptWrapper utility. | +| [PHXMassProperties](PHXMassProperties.md) | This is a utility class for holding mass property information. | +| [PHXObjectArray](PHXObjectArray.md) | Placeholder for an array of any random Java Object. | +| [PHXOrientation](PHXOrientation.md) | This is a utility class for holding orientation information. | +| [PHXRawFile](PHXRawFile.md) | The ModelCenter type for Files. | +| [PHXRawFileArray](PHXRawFileArray.md) | Wraps an array of PHXRawFile variables for the ScriptWrapper utility. | +| [PHXRefArrayProperty](PHXRefArrayProperty.md) | This is a class for holding properties of a reference object **type**: String **enumValues**: String[] **description**: String **title**: String **input**: boolean, where `type` may be any of the following: "long", "double", "boolean", "string" | +| [PHXReference](PHXReference.md) | The ModelCenter type for references. | +| [PHXReferenceArray](PHXReferenceArray.md) | The ModelCenter type for references. | +| [PHXRefProperty](PHXRefProperty.md) | This is a class for holding properties of a reference object **type**: String **enumValues**: String[]**description**: String **title**: String **input**: boolean, where `type` may be any of the following: "long", "double", "boolean", "string" | +| [PHXScriptObject](PHXScriptObject.md) | The PHX type for object variables. | +| [PHXSimpleArray](PHXSimpleArray.md) | This class enables components to create resizeable arrays where the number of dimensions is variable as well as the size of each dimension. | +| [PHXSimpleType](PHXSimpleType.md) | A base class for most Phoenix data types. | +| [PHXString](PHXString.md) | The ModelCenter type for Strings. | +| [PHXStringArray](PHXStringArray.md) | Class wraps an array of PHXString variables for the ScriptWrapper utility. | +| [PHXTypeFactory](PHXTypeFactory.md) | A class for creating variables | - where type may be any of the following: +## Exception Description - - "long" - "double" - "boolean" - "string" | -| [PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html) | The PHX type for object variables. | -| [PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) | This class enables components to create resizeable - arrays where the number of dimensions is variable - as well as the size of each dimension. | -| [PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html) | A base class for most Phoenix data types. | -| [PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html) | The Phoenix type for Strings. | -| [PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) | Class wraps an array of PHXString variables - for the ScriptWrapper utility. | -| [PHXTypeFactory](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html) | A class for creating variables | -- | Exception | Description | +| Exception | Description | | --- | --- | -| [PHXInvalidTypeException](../../../../com/phoenix_int/aserver/types/PHXInvalidTypeException.html) | An exception that is thrown when trying to use a bad type | -| [PHXNumberFormatException](../../../../com/phoenix_int/aserver/types/PHXNumberFormatException.html) | Like a NumberFormatException except that it isn't a runtime exception - and must be caught | -| [PHXTypeMismatchException](../../../../com/phoenix_int/aserver/types/PHXTypeMismatchException.html) | An exception thrown when trying to set a value using an incompatible type, or when trying to - compare two values of incompatible types | +| [PHXInvalidTypeException](PHXInvalidTypeException.md) | An exception that is thrown when trying to use a bad type | +| [PHXNumberFormatException](PHXNumberFormatException.md) | Like a NumberFormatException except that it isn't a runtime exception and must be caught | +| [PHXTypeMismatchException](PHXTypeMismatchException.md) | An exception thrown when trying to set a value using an incompatible type, or when trying to compare two values of incompatible types | ## Package com.phoenix_int.aserver.types Description -Provides a collection of basic data types that contain meta-information -like description and units.Put @see and @since tags down here. \ No newline at end of file +Provides a collection of basic data types that contain meta-information like description and units. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md index 3cecc8b029..9105629e0e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/types/package-tree.md @@ -1,48 +1,50 @@ # Hierarchy For Package com.phoenix_int.aserver.types -Package Hierarchies: + +**Package Hierarchies:** - [All Packages](../../../../overview-tree.html) + ## Class Hierarchy - java.lang.Object -- com.phoenix_int.aserver.types.[PHXAppearance](../../../../com/phoenix_int/aserver/types/PHXAppearance.html) -- com.phoenix_int.aserver.types.[PHXDataCollector](../../../../com/phoenix_int/aserver/types/PHXDataCollector.html) -- com.phoenix_int.aserver.types.[PHXGeomInfo](../../../../com/phoenix_int/aserver/types/PHXGeomInfo.html) -- com.phoenix_int.aserver.types.[PHXMassProperties](../../../../com/phoenix_int/aserver/types/PHXMassProperties.html) -- com.phoenix_int.aserver.types.[PHXOrientation](../../../../com/phoenix_int/aserver/types/PHXOrientation.html) -- com.phoenix_int.aserver.types.[PHXRefArrayProperty](../../../../com/phoenix_int/aserver/types/PHXRefArrayProperty.html)(implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html)) -- com.phoenix_int.aserver.types.[PHXReference](../../../../com/phoenix_int/aserver/types/PHXReference.html)(implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html), com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html)) -- com.phoenix_int.aserver.types.[PHXReferenceArray](../../../../com/phoenix_int/aserver/types/PHXReferenceArray.html)(implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](../../../../com/phoenix_int/aserver/IPHXAlwaysWriteable.html)) -- com.phoenix_int.aserver.types.[PHXRefProperty](../../../../com/phoenix_int/aserver/types/PHXRefProperty.html)(implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html)) -- com.phoenix_int.aserver.types.[PHXSimpleType](../../../../com/phoenix_int/aserver/types/PHXSimpleType.html)(implements com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.aserver.types.[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html)) -- com.phoenix_int.aserver.types.[PHXBoolean](../../../../com/phoenix_int/aserver/types/PHXBoolean.html) -- com.phoenix_int.aserver.types.[PHXDouble](../../../../com/phoenix_int/aserver/types/PHXDouble.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) -- com.phoenix_int.aserver.types.[PHXFile](../../../../com/phoenix_int/aserver/types/PHXFile.html) -- com.phoenix_int.aserver.types.[PHXGeometry](../../../../com/phoenix_int/aserver/types/PHXGeometry.html) -- com.phoenix_int.aserver.types.[PHXInteger](../../../../com/phoenix_int/aserver/types/PHXInteger.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) -- com.phoenix_int.aserver.types.[PHXLong](../../../../com/phoenix_int/aserver/types/PHXLong.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) -- com.phoenix_int.aserver.types.[PHXRawFile](../../../../com/phoenix_int/aserver/types/PHXRawFile.html)(implements java.lang.AutoCloseable, com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html)) -- com.phoenix_int.aserver.types.[PHXScriptObject](../../../../com/phoenix_int/aserver/types/PHXScriptObject.html) -- com.phoenix_int.aserver.types.[PHXSimpleArray](../../../../com/phoenix_int/aserver/types/PHXSimpleArray.html) (implements com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html), java.lang.Iterable) -- com.phoenix_int.aserver.types.[PHXBooleanArray](../../../../com/phoenix_int/aserver/types/PHXBooleanArray.html) -- com.phoenix_int.aserver.types.[PHXDoubleArray](../../../../com/phoenix_int/aserver/types/PHXDoubleArray.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) -- com.phoenix_int.aserver.types.[PHXLongArray](../../../../com/phoenix_int/aserver/types/PHXLongArray.html)(implements com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html)) -- com.phoenix_int.aserver.types.[PHXObjectArray](../../../../com/phoenix_int/aserver/types/PHXObjectArray.html) -- com.phoenix_int.aserver.types.[PHXRawFileArray](../../../../com/phoenix_int/aserver/types/PHXRawFileArray.html) -- com.phoenix_int.aserver.types.[PHXStringArray](../../../../com/phoenix_int/aserver/types/PHXStringArray.html) -- com.phoenix_int.aserver.types.[PHXString](../../../../com/phoenix_int/aserver/types/PHXString.html) -- com.phoenix_int.aserver.types.[PHXTypeFactory](../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html) -- java.lang.Throwable (implements java.io.Serializable) -- java.lang.Exception -- com.phoenix_int.aserver.types.[PHXInvalidTypeException](../../../../com/phoenix_int/aserver/types/PHXInvalidTypeException.html) -- com.phoenix_int.aserver.types.[PHXNumberFormatException](../../../../com/phoenix_int/aserver/types/PHXNumberFormatException.html) -- com.phoenix_int.aserver.types.[PHXTypeMismatchException](../../../../com/phoenix_int/aserver/types/PHXTypeMismatchException.html) + - com.phoenix_int.aserver.types.[PHXAppearance](PHXAppearance.md) + - com.phoenix_int.aserver.types.[PHXDataCollector](PHXDataCollector.md) + - com.phoenix_int.aserver.types.[PHXGeomInfo](PHXGeomInfo.md) + - com.phoenix_int.aserver.types.[PHXMassProperties](PHXMassProperties.md) + - com.phoenix_int.aserver.types.[PHXOrientation](PHXOrientation.md) + - com.phoenix_int.aserver.types.[PHXRefArrayProperty](PHXRefArrayProperty.md) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](IPHXRefPropInfo.md)) + - com.phoenix_int.aserver.types.[PHXReference](PHXReference.md) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](../IPHXAlwaysWriteable.md), com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md)) + - com.phoenix_int.aserver.types.[PHXReferenceArray](PHXReferenceArray.md) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](../IPHXAlwaysWriteable.md)) + - com.phoenix_int.aserver.types.[PHXRefProperty](PHXRefProperty.md) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](IPHXRefPropInfo.md)) + - com.phoenix_int.aserver.types.[PHXSimpleType](PHXSimpleType.md) (implements com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md), com.phoenix_int.aserver.types.[IPHXUnits](IPHXUnits.md)) + - com.phoenix_int.aserver.types.[PHXBoolean](PHXBoolean.md) + - com.phoenix_int.aserver.types.[PHXDouble](PHXDouble.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXFile](PHXFile.md) + - com.phoenix_int.aserver.types.[PHXGeometry](PHXGeometry.md) + - com.phoenix_int.aserver.types.[PHXInteger](PHXInteger.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXLong](PHXLong.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXRawFile](PHXRawFile.md) (implements java.lang.AutoCloseable, com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md)) + - com.phoenix_int.aserver.types.[PHXScriptObject](PHXScriptObject.md) + - com.phoenix_int.aserver.types.[PHXSimpleArray](PHXSimpleArray.md)`` (implements com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md), java.lang.Iterable``) + - com.phoenix_int.aserver.types.[PHXBooleanArray](PHXBooleanArray.md) + - com.phoenix_int.aserver.types.[PHXDoubleArray](PHXDoubleArray.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXLongArray](PHXLongArray.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXObjectArray](PHXObjectArray.md) + - com.phoenix_int.aserver.types.[PHXRawFileArray](PHXRawFileArray.md) + - com.phoenix_int.aserver.types.[PHXStringArray](PHXStringArray.md) + - com.phoenix_int.aserver.types.[PHXString](PHXString.md) + - com.phoenix_int.aserver.types.[PHXTypeFactory](PHXTypeFactory.md) + - java.lang.Throwable (implements java.io.Serializable) + - java.lang.Exception + - com.phoenix_int.aserver.types.[PHXInvalidTypeException](PHXInvalidTypeException.md) + - com.phoenix_int.aserver.types.[PHXNumberFormatException](PHXNumberFormatException.md) + - com.phoenix_int.aserver.types.[PHXTypeMismatchException](PHXTypeMismatchException.md) ## Interface Hierarchy -- com.phoenix_int.aserver.types.[IPHXDescription](../../../../com/phoenix_int/aserver/types/IPHXDescription.html) -- com.phoenix_int.aserver.types.[IPHXRefPropInfo](../../../../com/phoenix_int/aserver/types/IPHXRefPropInfo.html) -- com.phoenix_int.aserver.types.[IPHXFormat](../../../../com/phoenix_int/aserver/types/IPHXFormat.html) -- com.phoenix_int.aserver.types.[IPHXType](../../../../com/phoenix_int/aserver/types/IPHXType.html) -- com.phoenix_int.aserver.types.[IPHXType2](../../../../com/phoenix_int/aserver/types/IPHXType2.html) -- com.phoenix_int.aserver.types.[IPHXType2.IVisitor](../../../../com/phoenix_int/aserver/types/IPHXType2.IVisitor.html) -- com.phoenix_int.aserver.types.[IPHXUnits](../../../../com/phoenix_int/aserver/types/IPHXUnits.html) \ No newline at end of file +- com.phoenix_int.aserver.types.[IPHXDescription](IPHXDescription.md) + - com.phoenix_int.aserver.types.[IPHXRefPropInfo](IPHXRefPropInfo.md) +- com.phoenix_int.aserver.types.[IPHXFormat](IPHXFormat.md) +- com.phoenix_int.aserver.types.[IPHXType](IPHXType.md) + - com.phoenix_int.aserver.types.[IPHXType2](IPHXType2.md) +- com.phoenix_int.aserver.types.[IPHXType2.IVisitor](IPHXType2.IVisitor.md)`` +- com.phoenix_int.aserver.types.[IPHXUnits](IPHXUnits.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md index 9e92143d2f..45d35a9338 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXLineStore.md @@ -8,13 +8,24 @@ public interface IPHXLineStore ``` -This is the interface for holding a set of lines. It is used by the `PHXFileParser` class. Concrete classes include `PHXFileLineStore` and `PHXRandomAccessFileLineStore`. +This is the interface for holding a set of lines. It is used by the [`PHXFileParser`](PHXFileParser.md) class. Concrete classes include `PHXFileLineStore` and `PHXRandomAccessFileLineStore`. ## Method Summary | Modifier and Type | Method and Description | |-------------------|----------------------| | `void` | `close()`
Closes any resources associated with this line store | + +## Related Classes + +- [`PHXFileParser`](PHXFileParser.md) - File parser that uses this interface +- [`Parser`](Parser.md) - Base parser class +- [`package-tree`](package-tree.md) - Class hierarchy for this package + +**See Also:** + +- [Package Summary](package-summary.md) - Overview of all classes in this package +- [All Classes Index](../../../index-all.md) - Complete class index | `java.lang.String` | `getLine(int index)`
Retrieves the specified line | | `int` | `getNumLines()`
Gets the total number of lines | @@ -36,11 +47,17 @@ java.lang.String getLine(int index) Retrieves the specified line **Parameters:** + - `index` - the index of the line to retrieve **Throws:** + - `java.io.IOException` +**See Also:** + +- [`PHXFileParser.getLine(int)`](PHXFileParser.md) - Related method in file parser + ### close ```java diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md index e42622403a..68f9d68066 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/IPHXStringReplacer.md @@ -35,4 +35,4 @@ replaces the specified string with some other value. If the string does not matc - the replacement **Throws:** -- `PHXNoSuchReplacementException` - thrown if no replacement exists \ No newline at end of file +- [`PHXNoSuchReplacementException`](PHXNoSuchReplacementException.md) - thrown if no replacement exists \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md index c0f4a90312..0650dbadcc 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXFileParser.md @@ -160,7 +160,7 @@ public static final int RESIZE_DISALLOW Don't allow the length of an array to change **See Also:** -- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.RESIZE_DISALLOW) +- [Constant Field Values](../../../../constant-values.md) ### RESIZE_ROWS @@ -170,7 +170,7 @@ public static final int RESIZE_ROWS Allow a square matrix to change sizes by adding or deleting rows. **See Also:** -- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.RESIZE_ROWS) +- [Constant Field Values](../../../../constant-values.md) ### FIRST @@ -179,7 +179,7 @@ public static final int FIRST ``` **See Also:** -- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.FIRST) +- [Constant Field Values](../../../../constant-values.md) ### LAST @@ -188,7 +188,7 @@ public static final int LAST ``` **See Also:** -- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.LAST) +- [Constant Field Values](../../../../constant-values.md) ### RANDOM_ACCESS @@ -223,7 +223,7 @@ public static final long FILE_SIZE_LIMIT Deprecated. in favor of `Parser.Mode.FILE_SIZE_LIMIT` cut-off limit of file size to use buffers for row files **See Also:** -- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXFileParser.FILE_SIZE_LIMIT) +- [Constant Field Values](../../../../constant-values.md) ## Constructor Detail @@ -469,7 +469,7 @@ marks the starting point from which to start counting rows and fields. Position - `row` - the row where the new beginning will occur. This row becomes row 1. **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markEnd @@ -483,7 +483,7 @@ marks the ending point of the file. Position is marked relative to the last mark - `row` - the row where the new ending will occur. This row becomes the last row. **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markBeginningOffset @@ -512,7 +512,7 @@ same as markBeginning with an occurrence value of 1 - `isRegex` - if true, the pattern is a regular expression **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markBeginning @@ -526,7 +526,7 @@ same as markBeginning where the pattern is a regex and occurrence value is 1 - `string` - the pattern that marks the new first line **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markBeginning @@ -544,7 +544,7 @@ marks the starting point from which to start counting rows and fields. Position - `isRegex` - if true, the string is a regular expression. **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markBeginning @@ -560,7 +560,7 @@ marks the starting point from which to start counting rows and fields. Position - `occurrence` - the number of times to search for the pattern. may be negative to search from end **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markEndOffset @@ -589,7 +589,7 @@ same as `markEnd` with an occurrence value of 1 - `isRegex` - if true, the pattern is a regular expression **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markEnd @@ -607,7 +607,7 @@ marks the ending point from which to start counting rows and fields. Position is - `occurrence` - the number of times to search for regex value may be negative to search from beginning **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markEnd @@ -623,7 +623,7 @@ marks the ending point from which to start counting rows and fields. Position is - `occurrence` - the number of times to search for regex value may be negative to search from end **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markBeginningFromEnd @@ -639,7 +639,7 @@ marks the starting point from which to start counting rows. Position is marked r - `isRegex` - if true, the pattern is a regular expression **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### markEndFromEnd @@ -655,7 +655,7 @@ marks the starting point from which to start counting rows and fields. Position - `isRegex` - if true, the pattern is a regular expression **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### clearMarks @@ -685,7 +685,7 @@ gets the token relative to a search string. Indexing starts at 1. - the token found **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### getToken @@ -706,7 +706,7 @@ gets the token relative to a search string. Indexing starts at 1. - the token found **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### getToken @@ -725,7 +725,7 @@ gets the token at the specified row and field. Indexing starts at 1. - the token found at row, field **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### getToken @@ -746,7 +746,7 @@ gets the token at the specified row and column. Indexing starts at 1. - the token between startCol and endCol on row row **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### getToken @@ -769,7 +769,7 @@ gets an array of tokens at the specified row and between start and end fields (a - the token between startField and endField (all inclusive) on row row **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### setToken @@ -791,7 +791,7 @@ gets the token relative to a search string. Indexing starts at 1. - `replacement` - the string to substitute into the field **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### setToken @@ -811,7 +811,7 @@ gets the token relative to a search string. Indexing starts at 1. - `replacement` - the string to substitute into the field **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### setToken @@ -829,7 +829,7 @@ replaces the token at the specified row and field. Indexing starts at 1. - `replacement` - the string to substitute into the field **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### setToken @@ -849,7 +849,7 @@ replaces the token at the specified row and column. Indexing starts at 1. - `replacement` - the string to substitute into the field **Throws:** -- `PHXNoSuchTokenException` - thrown if the token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the token is not found ### addLines @@ -888,7 +888,7 @@ counts the number of tokens on a specified row - the number of tokens on the specified row **Throws:** -- `PHXNoSuchTokenException` - thrown if the row specified is invalid +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if the row specified is invalid ### getColumnArray @@ -909,7 +909,7 @@ gets an array of tokens for the specified range. Indexing starts at 1. - an array of String tokens **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### getRowArray @@ -930,7 +930,7 @@ gets an array of tokens for the specified range. Indexing starts at 1. - an array of String tokens **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### getMatrixArray @@ -953,7 +953,7 @@ gets an array of tokens for the specified range. Indexing starts at 1. - an array of String tokens **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### getMatrixArray2d @@ -976,7 +976,7 @@ gets an array of tokens for the specified range. Indexing starts at 1. - an array of String tokens **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### getMatrixArray @@ -1001,7 +1001,7 @@ gets an array of tokens for the specified range. Indexing starts at 1. Columns a - an array of String tokens **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### setMatrixArray @@ -1023,7 +1023,7 @@ sets an array of tokens for the specified range. Indexing starts at 1. - `array` - the values **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### setMatrixArray @@ -1047,7 +1047,7 @@ sets an array of tokens for the specified range. Indexing starts at 1. - `resizeStyle` - How to resize (RESIZE_DISALLOW, RESIZE_ROWS) **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### setMatrixArray2d @@ -1071,7 +1071,7 @@ sets an array of tokens for the specified range. Indexing starts at 1. - `resizeStyle` - How to resize (RESIZE_DISALLOW, RESIZE_ROWS) **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### setMatrixArray @@ -1095,7 +1095,7 @@ sets an array of tokens for the specified range. Indexing starts at 1. Columns a - `array` - the values **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### setMatrixArray @@ -1121,7 +1121,7 @@ sets an array of tokens for the specified range. Indexing starts at 1. Columns a - `resizeStyle` - How to resize (RESIZE_DISALLOW, RESIZE_ROWS) **Throws:** -- `PHXNoSuchTokenException` - thrown if a token is not found +- [`PHXNoSuchTokenException`](PHXNoSuchTokenException.md) - thrown if a token is not found ### main diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md index 63eac443d4..283b5c0507 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md @@ -27,7 +27,7 @@ extends java.lang.Exception An exception that is thrown when a replacement string cannot be found. **See Also:** -- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.util.PHXNoSuchReplacementException) +- [Serialized Form](../../../../serialized-form.md) ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md index 099b593850..b09976490d 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXNoSuchTokenException.md @@ -27,7 +27,7 @@ extends java.lang.Exception An exception that is thrown when an object cannot be found. **See Also:** -- [Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.util.PHXNoSuchTokenException) +- [Serialized Form](../../../../serialized-form.md) ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md index 8bc3e39d98..0852b3753a 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXProcessInfo.md @@ -16,7 +16,7 @@ public class PHXProcessInfo extends java.lang.Object ``` -This class represents information about a running process on the system. It includes static members for listing all processes. This is done in a semi-platform independent way by using an external program which is platform dependent (although fairly consistent on UNIX systems, ps). See `PHXRuntime` and `PHXProcess` for other convenient ways to use this information. Note that not all platforms will have all information available. +This class represents information about a running process on the system. It includes static members for listing all processes. This is done in a semi-platform independent way by using an external program which is platform dependent (although fairly consistent on UNIX systems, ps). See [`PHXRuntime`](PHXRuntime.md) and [`PHXProcess`](PHXProcess.md) for other convenient ways to use this information. Note that not all platforms will have all information available. ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md index d6a18f7cee..cbf5439825 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXRuntime.md @@ -52,7 +52,7 @@ public static final java.lang.String DEFAULT_SHELL **See Also:** -[Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXRuntime.DEFAULT_SHELL) +[Constant Field Values](../../../../constant-values.md) ## Constructor Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md index 42d5798479..9aa5880cdc 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/PHXStringBuffer.md @@ -25,7 +25,7 @@ Class that behaves like a `java.lang.StringBuffer` but has logic for caching out **See Also:** -[Serialized Form](../../../../serialized-form.html#com.phoenix_int.aserver.util.PHXStringBuffer) +[Serialized Form](../../../../serialized-form.md) ## Field Summary @@ -96,7 +96,7 @@ public static final long SIZECUTOFF **See Also:** -[Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.PHXStringBuffer.SIZECUTOFF) +[Constant Field Values](../../../../constant-values.md) ## Constructor Detail @@ -300,7 +300,7 @@ NOTE: This is very bad performance for large files. Avoid this if possible if yo **See Also:** -[getReader()](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html#getReader--), [getInputStream()](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html#getInputStream--) +[getReader()](PHXStringBuffer.md), [getInputStream()](PHXStringBuffer.md) ### getReader diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md index b6f0ffbce6..7fe38a0944 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.Mode.md @@ -12,10 +12,10 @@ ``` **All Implemented Interfaces:** -- java.io.Serializable, java.lang.Comparable +- `java.io.Serializable`, `java.lang.Comparable` **Enclosing interface:** -- [Parser](../../../../com/phoenix_int/aserver/util/Parser.html) +- [Parser](Parser.md) --- **Declaration** @@ -55,11 +55,11 @@ File-access mode. Moved to type-safe enum from legacy integer constants. ### Methods inherited from class java.lang.Enum -`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf` +`clone`, `compareTo`, `equals`, `finalize`, `getDeclaringClass`, `hashCode`, `name`, `ordinal`, `toString`, `valueOf` ### Methods inherited from class java.lang.Object -`getClass, notify, notifyAll, wait, wait, wait` +`getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait` ## Enum Constant Detail @@ -90,7 +90,7 @@ public static final long FILE_SIZE_LIMIT ``` **See Also:** -- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.aserver.util.Parser.Mode.FILE_SIZE_LIMIT) +- [Constant Field Values](../../../../constant-values.md) ## Method Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md index c94e87844b..5b50084451 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/Parser.md @@ -3,7 +3,7 @@ **Package:** `com.phoenix_int.aserver.util` **All Known Implementing Classes:** -- [PHXFileParser](../../../../com/phoenix_int/aserver/util/PHXFileParser.html) +- [PHXFileParser](PHXFileParser.md) -- diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md index 5879bbf594..871be4abdb 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-summary.md @@ -4,37 +4,37 @@ Provides general purpose utility functions. ## Interface Summary | Interface | Description | | --- | --- | -| [IPHXLineStore](../../../../com/phoenix_int/aserver/util/IPHXLineStore.html) | This is the interface for holding a set of lines. | -| [IPHXStringReplacer](../../../../com/phoenix_int/aserver/util/IPHXStringReplacer.html) | This is the interface for a replacing strings, used by the PHXStringReplacer class | -| [Parser](../../../../com/phoenix_int/aserver/util/Parser.html) | Interface to define the methods of a parser. | +| [IPHXLineStore](IPHXLineStore.md) | This is the interface for holding a set of lines. | +| [IPHXStringReplacer](IPHXStringReplacer.md) | This is the interface for a replacing strings, used by the PHXStringReplacer class | +| [Parser](Parser.md) | Interface to define the methods of a parser. | ## Class Summary | Class | Description | | --- | --- | -| [PHXFileLoader](../../../../com/phoenix_int/aserver/util/PHXFileLoader.html) | This is a utility class for loading data files. | -| [PHXFileName](../../../../com/phoenix_int/aserver/util/PHXFileName.html) | this is a utility class for easily managing file names. | -| [PHXFileParser](../../../../com/phoenix_int/aserver/util/PHXFileParser.html) | This is a utility class for loading data files and extracting data. | -| [PHXIcon](../../../../com/phoenix_int/aserver/util/PHXIcon.html) | This class provides utility functions for loading and creating an icon file | -| [PHXNameDivider](../../../../com/phoenix_int/aserver/util/PHXNameDivider.html) | this is a utility class for breaking down names into smaller parts. | -| [PHXProcess](../../../../com/phoenix_int/aserver/util/PHXProcess.html) | This is a utility class that extends `java.lang.Process` with a system dependent process ID. | -| [PHXProcessInfo](../../../../com/phoenix_int/aserver/util/PHXProcessInfo.html) | This class represents information about a running process on the system. | -| [PHXRuntime](../../../../com/phoenix_int/aserver/util/PHXRuntime.html) | This is a utility class for running processes. | -| [PHXStringBuffer](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html) | Class that behaves like a `java.lang.StringBuffer` but has logic for cacheing out to disk if the size grows over a limit (currently 512K). | -| [PHXStringReplacer](../../../../com/phoenix_int/aserver/util/PHXStringReplacer.html) | This is a utility class for replacing fields within a string. | -| [PHXStringTokenizer](../../../../com/phoenix_int/aserver/util/PHXStringTokenizer.html) | This is a more sophisticated version of the Java StringTokenizer. | +| [PHXFileLoader](PHXFileLoader.md) | This is a utility class for loading data files. | +| [PHXFileName](PHXFileName.md) | this is a utility class for easily managing file names. | +| [PHXFileParser](PHXFileParser.md) | This is a utility class for loading data files and extracting data. | +| [PHXIcon](PHXIcon.md) | This class provides utility functions for loading and creating an icon file | +| [PHXNameDivider](PHXNameDivider.md) | this is a utility class for breaking down names into smaller parts. | +| [PHXProcess](PHXProcess.md) | This is a utility class that extends `java.lang.Process` with a system dependent process ID. | +| [PHXProcessInfo](PHXProcessInfo.md) | This class represents information about a running process on the system. | +| [PHXRuntime](PHXRuntime.md) | This is a utility class for running processes. | +| [PHXStringBuffer](PHXStringBuffer.md) | Class that behaves like a `java.lang.StringBuffer` but has logic for cacheing out to disk if the size grows over a limit (currently 512K). | +| [PHXStringReplacer](PHXStringReplacer.md) | This is a utility class for replacing fields within a string. | +| [PHXStringTokenizer](PHXStringTokenizer.md) | This is a more sophisticated version of the Java StringTokenizer. | ## Enum Summary | Enum | Description | | --- | --- | -| [Parser.Mode](../../../../com/phoenix_int/aserver/util/Parser.Mode.html) | File-access mode
Moved to type-safe enum from legacy integer constants | +| [Parser.Mode](Parser.Mode.md) | File-access mode
Moved to type-safe enum from legacy integer constants | ## Exception Summary | Exception | Description | | --- | --- | -| [PHXClassNotFoundException](../../../../com/phoenix_int/aserver/util/PHXClassNotFoundException.html) | Simple wrapper for `ClassNotFoundException` which can contain additional logging info. | -| [PHXGetByUrlException](../../../../com/phoenix_int/aserver/util/PHXGetByUrlException.html) | An exception that is thrown when encountering an error getting a file's contents via url | -| [PHXNoSuchReplacementException](../../../../com/phoenix_int/aserver/util/PHXNoSuchReplacementException.html) | An exception that is thrown when a replacement string cannot be found | -| [PHXNoSuchTokenException](../../../../com/phoenix_int/aserver/util/PHXNoSuchTokenException.html) | An exception that is thrown when an object cannot be found | +| [PHXClassNotFoundException](PHXClassNotFoundException.md) | Simple wrapper for `ClassNotFoundException` which can contain additional logging info. | +| [PHXGetByUrlException](PHXGetByUrlException.md) | An exception that is thrown when encountering an error getting a file's contents via url | +| [PHXNoSuchReplacementException](PHXNoSuchReplacementException.md) | An exception that is thrown when a replacement string cannot be found | +| [PHXNoSuchTokenException](PHXNoSuchTokenException.md) | An exception that is thrown when an object cannot be found | ## Package com.phoenix_int.aserver.util Description -Provides general purpose utility functions.Put @see and @since tags down here. \ No newline at end of file +Provides general purpose utility functions. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md index c57c6fa244..68b9917728 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/package-tree.md @@ -1,39 +1,39 @@ # Hierarchy For Package com.phoenix_int.aserver.util **Package Hierarchies:** -- [All Packages](../../../../overview-tree.html) +- [All Packages](../../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - - com.phoenix_int.aserver.util.[PHXFileLoader](../../../../com/phoenix_int/aserver/util/PHXFileLoader.html) - - com.phoenix_int.aserver.util.[PHXFileName](../../../../com/phoenix_int/aserver/util/PHXFileName.html) - - com.phoenix_int.aserver.util.[PHXFileParser](../../../../com/phoenix_int/aserver/util/PHXFileParser.html)(implements com.phoenix_int.aserver.util.[Parser](../../../../com/phoenix_int/aserver/util/Parser.html)) - - com.phoenix_int.aserver.util.[PHXIcon](../../../../com/phoenix_int/aserver/util/PHXIcon.html) - - com.phoenix_int.aserver.util.[PHXNameDivider](../../../../com/phoenix_int/aserver/util/PHXNameDivider.html) - - com.phoenix_int.aserver.util.[PHXProcessInfo](../../../../com/phoenix_int/aserver/util/PHXProcessInfo.html) - - com.phoenix_int.aserver.util.[PHXRuntime](../../../../com/phoenix_int/aserver/util/PHXRuntime.html) - - com.phoenix_int.aserver.util.[PHXStringBuffer](../../../../com/phoenix_int/aserver/util/PHXStringBuffer.html)(implements java.io.Serializable) - - com.phoenix_int.aserver.util.[PHXStringReplacer](../../../../com/phoenix_int/aserver/util/PHXStringReplacer.html) - - com.phoenix_int.aserver.util.[PHXStringTokenizer](../../../../com/phoenix_int/aserver/util/PHXStringTokenizer.html)(implements java.util.Enumeration) + - com.phoenix_int.aserver.util.[PHXFileLoader](PHXFileLoader.md) + - com.phoenix_int.aserver.util.[PHXFileName](PHXFileName.md) + - com.phoenix_int.aserver.util.[PHXFileParser](PHXFileParser.md)(implements com.phoenix_int.aserver.util.[Parser](Parser.md)) + - com.phoenix_int.aserver.util.[PHXIcon](PHXIcon.md) + - com.phoenix_int.aserver.util.[PHXNameDivider](PHXNameDivider.md) + - com.phoenix_int.aserver.util.[PHXProcessInfo](PHXProcessInfo.md) + - com.phoenix_int.aserver.util.[PHXRuntime](PHXRuntime.md) + - com.phoenix_int.aserver.util.[PHXStringBuffer](PHXStringBuffer.md)(implements java.io.Serializable) + - com.phoenix_int.aserver.util.[PHXStringReplacer](PHXStringReplacer.md) + - com.phoenix_int.aserver.util.[PHXStringTokenizer](PHXStringTokenizer.md)(implements java.util.Enumeration) - java.lang.Process - - com.phoenix_int.aserver.util.[PHXProcess](../../../../com/phoenix_int/aserver/util/PHXProcess.html)(implements com.phoenix_int.aserver.util.IPHXStreamRegExListener) + - com.phoenix_int.aserver.util.[PHXProcess](PHXProcess.md)(implements com.phoenix_int.aserver.util.IPHXStreamRegExListener) - java.lang.Throwable (implements java.io.Serializable) - java.lang.Exception - - com.phoenix_int.aserver.util.[PHXGetByUrlException](../../../../com/phoenix_int/aserver/util/PHXGetByUrlException.html) - - com.phoenix_int.aserver.util.[PHXNoSuchReplacementException](../../../../com/phoenix_int/aserver/util/PHXNoSuchReplacementException.html) - - com.phoenix_int.aserver.util.[PHXNoSuchTokenException](../../../../com/phoenix_int/aserver/util/PHXNoSuchTokenException.html) + - com.phoenix_int.aserver.util.[PHXGetByUrlException](PHXGetByUrlException.md) + - com.phoenix_int.aserver.util.[PHXNoSuchReplacementException](PHXNoSuchReplacementException.md) + - com.phoenix_int.aserver.util.[PHXNoSuchTokenException](PHXNoSuchTokenException.md) - java.lang.ReflectiveOperationException - java.lang.ClassNotFoundException - - com.phoenix_int.aserver.util.[PHXClassNotFoundException](../../../../com/phoenix_int/aserver/util/PHXClassNotFoundException.html) + - com.phoenix_int.aserver.util.[PHXClassNotFoundException](PHXClassNotFoundException.md) ## Interface Hierarchy -- com.phoenix_int.aserver.util.[IPHXLineStore](../../../../com/phoenix_int/aserver/util/IPHXLineStore.html) -- com.phoenix_int.aserver.util.[IPHXStringReplacer](../../../../com/phoenix_int/aserver/util/IPHXStringReplacer.html) -- com.phoenix_int.aserver.util.[Parser](../../../../com/phoenix_int/aserver/util/Parser.html) +- com.phoenix_int.aserver.util.[IPHXLineStore](IPHXLineStore.md) +- com.phoenix_int.aserver.util.[IPHXStringReplacer](IPHXStringReplacer.md) +- com.phoenix_int.aserver.util.[Parser](Parser.md) ## Enum Hierarchy - java.lang.Object - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) - - com.phoenix_int.aserver.util.[Parser.Mode](../../../../com/phoenix_int/aserver/util/Parser.Mode.html) \ No newline at end of file + - com.phoenix_int.aserver.util.[Parser.Mode](Parser.Mode.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md index 6b065fd46e..d440d7f6cc 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md @@ -11,7 +11,7 @@ **Implemented Interfaces** -- `ParseableFile`, `java.io.Closeable`, `java.lang.AutoCloseable` +- [`ParseableFile`](ParseableFile.md), `java.io.Closeable`, `java.lang.AutoCloseable` **Direct Known Subclasses** @@ -31,7 +31,7 @@ Common implementation for files (not file variables) used in script wrappers. ## Nested Class Summary -### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](ParseableFile.md) `ParseableFile.Mode` ## Field Summary @@ -265,12 +265,12 @@ Perform an action consistent with `ParseableFile.Mode` **Throws:** - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` - `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) ### readTemplate @@ -293,12 +293,12 @@ Read the template. In MCRE 7.1, this method was changed to never throw any excep **Throws:** - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` - `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) ### setFileToGenerateOrParse @@ -373,9 +373,9 @@ Transfer values for variables that have been defined using methods from the conc **Throws:** - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` - `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` \ No newline at end of file +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md index 1beef56c2d..7829de8efa 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md @@ -12,7 +12,7 @@ **Implemented Interfaces** -- `OutputFile2`, `ParseableFile`, `java.io.Closeable`, `java.lang.AutoCloseable` +- [`OutputFile2`](OutputFile2.md), [`ParseableFile`](ParseableFile.md), `java.io.Closeable`, `java.lang.AutoCloseable` --- ## Declaration @@ -28,19 +28,26 @@ This represents a binary output file from a CAE program such as NASTRAN or LSDyn ## Nested Class Summary ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile - `ParseableFile.Mode` + +[`ParseableFile.Mode`](ParseableFile.Mode.md) ## Field Summary ### Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile -`encoding`, `fileName`, `mode`, `parser`, `templateFileName`, `wrapper` + +`encoding`, `fileName`, `mode`, `parser`, `templateFileName`, `wrapper` + +**Related Files:** + +- [`PHXRowFieldFile`](PHXRowFieldFile.md) - Row field file implementation +- [`XPathFile`](XPathFile.md) - XPath file implementation ## Constructor Summary | Constructor and Description | |----------------------------| -| `CAEOutputFile(PHXScriptWrapperObject wrapper, java.io.File file)` | -| `CAEOutputFile(PHXScriptWrapperObject wrapper, java.io.File file, FileType type)` | +| `CAEOutputFile(`[`PHXScriptWrapperObject`](PHXScriptWrapperObject.md)` wrapper, java.io.File file)` | +| `CAEOutputFile(`[`PHXScriptWrapperObject`](PHXScriptWrapperObject.md)` wrapper, java.io.File file, FileType type)` | ## Method Summary @@ -48,10 +55,10 @@ This represents a binary output file from a CAE program such as NASTRAN or LSDyn |-------------------|----------------------| | `void` | `defineArrayVar(java.lang.String name, java.lang.String specifier)` | | `void` | `defineVar(java.lang.String name, java.lang.String specifier)` | -| `protected Parser` | `newParser(java.io.File rFile, Parser.Mode pmode)`
Generate a new parser for the given file and mode | +| `protected` [`Parser`](../../Parser.md) | `newParser(java.io.File rFile,` [`Parser.Mode`](../../Parser.Mode.md) `pmode)`
Generate a new parser for the given file and mode | | `void` | `parse()`
Parse the output file | | `void` | `setFileToParse(java.lang.String fileName)`
Set the file to parse | -| `protected void` | `transferVars(ParseableFile.Mode mode)`
Transfer values for variables that have been defined using methods from the concrete implementation | +| `protected void` | `transferVars(`[`ParseableFile.Mode`](ParseableFile.Mode.md)` mode)`
Transfer values for variables that have been defined using methods from the concrete implementation | ### Methods inherited from class AbstractFile @@ -99,9 +106,10 @@ public void defineArrayVar(java.lang.String name, ``` **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` -- `PHXInvalidTypeException` + +- [`PHXNameAlreadyInUseException`](../../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../../PHXInvalidNameException.md) +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) ### defineVar @@ -114,9 +122,10 @@ public void defineVar(java.lang.String name, ``` **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` -- `PHXInvalidTypeException` + +- [`PHXNameAlreadyInUseException`](../../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../../PHXInvalidNameException.md) +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) ### parse @@ -126,7 +135,7 @@ public void parse() throws java.lang.Exception Parse the output file **Specified by:** -- `parse` in interface `OutputFile2` +- `parse` in interface [`OutputFile2`](OutputFile2.md) **Throws:** - `java.lang.Exception` @@ -141,7 +150,8 @@ protected Parser newParser(java.io.File rFile, Generate a new parser for the given file and mode **Specified by:** -- `newParser` in class `AbstractFile` + +- `newParser` in class [`AbstractFile`](AbstractFile.md) **Parameters:** - `rFile` - The file to open @@ -161,18 +171,20 @@ protected void transferVars(ParseableFile.Mode mode) java.lang.InstantiationException, PHXNumberFormatException ``` -Transfer values for variables that have been defined using methods from the concrete implementation, i.e. `PHXRowFieldFile.defineVar(String, String, boolean, String)`. Variables defined using `PHXScriptWrapperObject.addVariable(String, String, boolean)` must be explicitly transferred using methods of the concrete implementation class +Transfer values for variables that have been defined using methods from the concrete implementation, i.e. [`PHXRowFieldFile.defineVar(String, String, boolean, String)`](PHXRowFieldFile.md). Variables defined using [`PHXScriptWrapperObject.addVariable(String, String, boolean)`](PHXScriptWrapperObject.md) must be explicitly transferred using methods of the concrete implementation class **Specified by:** -- `transferVars` in class `AbstractFile` + +- `transferVars` in class [`AbstractFile`](AbstractFile.md) **Throws:** + - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` +- [`PHXNumberFormatException`](../../../types/PHXNumberFormatException.md) ### setFileToParse @@ -182,7 +194,7 @@ public void setFileToParse(java.lang.String fileName) Set the file to parse **Specified by:** -- `setFileToParse` in interface `OutputFile2` +- `setFileToParse` in interface [`OutputFile2`](OutputFile2.md) **Parameters:** - `fileName` - \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md index 3d84b8ad69..0c52d67ae1 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md @@ -9,7 +9,8 @@ ``` **All Known Implementing Classes:** -[PHXCAERange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.html), [PHXRowFieldRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.html) + +[`PHXCAERange`](PHXCAERange.md), [`PHXRowFieldRange`](PHXRowFieldRange.md) --- **Declaration** @@ -18,6 +19,15 @@ public interface IPHXRange ``` +Interface for defining ranges in script wrapper files. + +**See Also:** + +- [`PHXCAERange`](PHXCAERange.md) - CAE-specific range implementation +- [`PHXRowFieldRange`](PHXRowFieldRange.md) - Row field range implementation +- [`IPHXRangeChangeListener`](IPHXRangeChangeListener.md) - Listener for range change events +- [`PHXRowFieldFile`](PHXRowFieldFile.md) - File class that uses ranges + ## Method Summary | Modifier and Type | Method and Description | diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md index 4bc662b5cd..5c59beca3f 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md @@ -4,11 +4,11 @@ **All Superinterfaces** -- `ParseableFile` +- [`ParseableFile`](ParseableFile.md) **All Known Implementing Classes** -- `PHXRowFieldFile`, `XPathFile` +- [`PHXRowFieldFile`](PHXRowFieldFile.md), [`XPathFile`](XPathFile.md) --- ## Declaration @@ -19,10 +19,17 @@ extends ParseableFile Interface for input files (not file variables) used in script-wrappers +**See Also:** + +- [`ParseableFile`](ParseableFile.md) - Base interface for parseable files +- [`OutputFile`](OutputFile.md), [`OutputFile2`](OutputFile2.md) - Related output file interfaces +- [`PHXScriptWrapperObject`](PHXScriptWrapperObject.md) - Script wrapper object that uses input files + ## Nested Class Summary ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile -`ParseableFile.Mode` + +[`ParseableFile.Mode`](ParseableFile.Mode.md) ## Method Summary @@ -53,14 +60,22 @@ void generate() Generate the input file **Throws:** + - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXNumberFormatException`](../../../types/PHXNumberFormatException.md) +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) + +**See Also:** + +- [`PHXRowFieldFile.generate()`](PHXRowFieldFile.md) - Implementation in PHXRowFieldFile +- [`XPathFile.generate()`](XPathFile.md) - Implementation in XPathFile +- [`PHXBookmark`](PHXBookmark.md) - Related bookmark functionality +- [`PHXSection`](PHXSection.md) - Related section functionality ### setFileToGenerate @@ -70,4 +85,10 @@ void setFileToGenerate(java.lang.String fileName) Set the file to be generated **Parameters:** -- `fileName` - file name \ No newline at end of file + +- `fileName` - file name + +**See Also:** + +- [`PHXRowFieldFile.setFileToGenerate(String)`](PHXRowFieldFile.md) - Implementation in PHXRowFieldFile +- [`XPathFile.setFileToGenerate(String)`](XPathFile.md) - Implementation in XPathFile \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md index a283820cf4..8f28bb00c7 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md @@ -10,12 +10,14 @@ ``` **All Superinterfaces:** -[ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) + +[`ParseableFile`](ParseableFile.md) **All Known Implementing Classes:** -[PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html), [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) -@Deprecated in favor of [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) +[`PHXRowFieldFile`](PHXRowFieldFile.md), [`XPathFile`](XPathFile.md) + +@Deprecated in favor of [`OutputFile2`](OutputFile2.md) --- **Declaration** @@ -31,7 +33,8 @@ Interface for output files (not file variables) used in script-wrappers ## Nested Class Summary ### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile -`ParseableFile.Mode` + +[`ParseableFile.Mode`](ParseableFile.Mode.md) ## Method Summary @@ -41,6 +44,7 @@ Interface for output files (not file variables) used in script-wrappers | `void` | `setFileToParse(java.lang.String fileName)`
@Deprecated. Set the file to be parsed | ### Methods inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile + `backup`, `close`, `delete`, `readTemplate`, `setFileToGenerateOrParse`, `setTempEmbedded`, `setTemplateFile`, `setVariable` ## Method Detail @@ -61,14 +65,15 @@ void parse() @Deprecated. Parse the output file **Throws:** + - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXNumberFormatException`](../../../types/PHXNumberFormatException.md) +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) ### setFileToParse diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md index 327f483b1e..cc42b7d899 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md @@ -9,7 +9,8 @@ ``` **All Known Implementing Classes:** -[CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html), [PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html), [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) + +[`CAEOutputFile`](CAEOutputFile.md), [`PHXRowFieldFile`](PHXRowFieldFile.md), [`XPathFile`](XPathFile.md) --- **Declaration** @@ -44,7 +45,7 @@ Parse the output file ```java void setFileToParse(java.lang.String fileName) ``` -Sets the file that will be parsed. Usually this is synonymous with [ParseableFile.setFileToGenerateOrParse(String)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html#setFileToGenerateOrParse-java.lang.String-) +Sets the file that will be parsed. Usually this is synonymous with [`ParseableFile.setFileToGenerateOrParse(String)`](ParseableFile.md) **Parameters:** - `fileName` - The file to parse \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md index 5eb2b0749c..def9edb273 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md @@ -25,7 +25,7 @@ extends java.lang.Exception ``` **See Also:** -- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXBookmarkNotFoundException) +- [Serialized Form](../../../../../../serialized-form.md) ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md index cb741798f2..6d307d1909 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md @@ -12,7 +12,7 @@ **Implemented Interfaces** -- [IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) +- [IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md) ---- @@ -62,7 +62,8 @@ public static final java.lang.String NAME_SEPARATOR ``` **See Also:** -- [Constant Field Values](../../../../../../constant-values.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXCAERange.NAME_SEPARATOR) + +- [Constant Field Values](../../../../../constant-values.md) ## Constructor Detail @@ -94,7 +95,8 @@ public void fromString(java.lang.String str) ``` **Specified by:** -- `fromString` in interface `IPHXRange` + +- `fromString` in interface [`IPHXRange`](IPHXRange.md) ### toString @@ -103,9 +105,11 @@ public java.lang.String toString() ``` **Specified by:** -- `toString` in interface `IPHXRange` + +- `toString` in interface [`IPHXRange`](IPHXRange.md) **Overrides:** + - `toString` in class `java.lang.Object` ### toString @@ -115,7 +119,8 @@ public java.lang.String toString(boolean fullName) ``` **Specified by:** -- `toString` in interface `IPHXRange` + +- `toString` in interface [`IPHXRange`](IPHXRange.md) ### assertEquals @@ -125,7 +130,8 @@ public void assertEquals(IPHXRange other) ``` **Specified by:** -- `assertEquals` in interface `IPHXRange` + +- `assertEquals` in interface [`IPHXRange`](IPHXRange.md) **Throws:** - `java.lang.Exception` @@ -143,4 +149,5 @@ public java.lang.String getPageName() ``` **Specified by:** -- `getPageName` in interface `IPHXRange` \ No newline at end of file + +- `getPageName` in interface [`IPHXRange`](IPHXRange.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md index 101f84b484..56398df93b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md @@ -13,10 +13,10 @@ **Implemented Interfaces** -- [InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html) -- [OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) -- [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) -- [ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) +- [InputFile](InputFile.md) +- [OutputFile](OutputFile.md) +- [OutputFile2](OutputFile2.md) +- [ParseableFile](ParseableFile.md) - java.io.Closeable - java.lang.AutoCloseable @@ -69,9 +69,9 @@ Example usage from a java scriptwrapper (Comments show fileWrapper equivalents): | Modifier and Type | Field and Description | |-------------------|----------------------| -| `static int` | `GENERATE`
Deprecated. in favor of [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) | -| `static int` | `PARSE`
Deprecated. in favor of [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE) | -| `static int` | `READ_TEMPLATE`
Deprecated. in favor of [ParseableFile.Mode.READ_TEMPLATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#READ_TEMPLATE) | +| `static int` | `GENERATE`
Deprecated. in favor of [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) | +| `static int` | `PARSE`
Deprecated. in favor of [ParseableFile.Mode.PARSE](ParseableFile.Mode.md) | +| `static int` | `READ_TEMPLATE`
Deprecated. in favor of [ParseableFile.Mode.READ_TEMPLATE](ParseableFile.Mode.md) | ### Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile @@ -81,8 +81,8 @@ Example usage from a java scriptwrapper (Comments show fileWrapper equivalents): | Constructor and Description | |----------------------------| -| `PHXRowFieldFile(PHXScriptWrapperObject wrapper)`
Defaults to [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) | -| `PHXRowFieldFile(PHXScriptWrapperObject wrapper, int mode)`
Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#PHXRowFieldFile-com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject-com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode-) | +| `PHXRowFieldFile(PHXScriptWrapperObject wrapper)`
Defaults to [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) | +| `PHXRowFieldFile(PHXScriptWrapperObject wrapper, int mode)`
Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](PHXRowFieldFile.md) | | `PHXRowFieldFile(PHXScriptWrapperObject wrapper, ParseableFile.Mode mode)` | | `PHXRowFieldFile(java.lang.String baseDirectory, int mode)`
Legacy (pre-QW) constructor. | @@ -90,7 +90,7 @@ Example usage from a java scriptwrapper (Comments show fileWrapper equivalents): | Modifier and Type | Method and Description | |-------------------|----------------------| -| `void` | `clearMarks()`
Removes effects of any previous markAsBeginning() or markAsEnd() calls | +| `void` | `clearMarks()`
Removes effects of any previous `markAsBeginning()` or `markAsEnd()` calls | | `void` | `defineBookmark(java.lang.String name, java.lang.String parent, java.lang.String start)` | | `void` | `defineSection(java.lang.String name, java.lang.String start, java.lang.String end, java.lang.String delimiters)` | | `void` | `defineVar(java.lang.String name, java.lang.String type, boolean isInput, java.lang.String rangeStr)` | @@ -146,7 +146,7 @@ Example usage from a java scriptwrapper (Comments show fileWrapper equivalents): @Deprecated public static final int GENERATE ``` -Deprecated. in favor of [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) +Deprecated. in favor of [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) This mode makes the row field file prepare to generate the output file by reading the template file, then replacing the specified values passed to `transferVar()`. @@ -156,7 +156,7 @@ This mode makes the row field file prepare to generate the output file by readin @Deprecated public static final int PARSE ``` -Deprecated. in favor of [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE) +Deprecated. in favor of [ParseableFile.Mode.PARSE](ParseableFile.Mode.md) This mode makes the row field file read in values from the `fileToParse` when `transferVar()` is called. ### READ_TEMPLATE @@ -165,7 +165,7 @@ This mode makes the row field file read in values from the `fileToParse` when `t @Deprecated public static final int READ_TEMPLATE ``` -Deprecated. in favor of [ParseableFile.Mode.READ_TEMPLATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#READ_TEMPLATE) +Deprecated. in favor of [ParseableFile.Mode.READ_TEMPLATE](ParseableFile.Mode.md) This mode makes the row field file read in values from the template file when `transferVar()` is called. @@ -176,7 +176,7 @@ This mode makes the row field file read in values from the template file when `t ```java public PHXRowFieldFile(PHXScriptWrapperObject wrapper) ``` -Defaults to [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) +Defaults to [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) **Parameters:** - `wrapper` - script-wrapper object @@ -193,7 +193,7 @@ public PHXRowFieldFile(PHXScriptWrapperObject wrapper, ParseableFile.Mode mode) @Deprecated public PHXRowFieldFile(PHXScriptWrapperObject wrapper, int mode) ``` -Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#PHXRowFieldFile-com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperObject-com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode-) +Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](PHXRowFieldFile.md) **Parameters:** - `wrapper` - The row field file will find files relative to the run directory specified in this wrapper object. @@ -206,7 +206,7 @@ public PHXRowFieldFile(java.lang.String baseDirectory, int mode) ``` Legacy (pre-QW) constructor. -Note: Using this constructor will make the resultant object incompatible with certain methods. This was necessary for compatibility with QuickWrap. The new constructors accept [PHXScriptWrapperObject](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html). This constructor passes `null` instead. +Note: Using this constructor will make the resultant object incompatible with certain methods. This was necessary for compatibility with QuickWrap. The new constructors accept [PHXScriptWrapperObject](PHXScriptWrapperObject.md). This constructor passes `null` instead. **Parameters:** - `baseDirectory` - All files will be relative to this directory @@ -441,9 +441,9 @@ protected void transferVars(ParseableFile.Mode mode) ``` Note that if wrapper is null, variable collection should be empty, and there should be no harm in calling this method. -Transfer values for variables that have been defined using methods from the concrete implementation, i.e. [defineVar(String, String, boolean, String)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#defineVar-java.lang.String-java.lang.String-boolean-java.lang.String-) +Transfer values for variables that have been defined using methods from the concrete implementation, i.e. [defineVar(String, String, boolean, String)](PHXRowFieldFile.md) -Variables defined using [PHXScriptWrapperObject.addVariable(String, String, boolean)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html#addVariable-java.lang.String-java.lang.String-boolean-) must be explicitly transferred using methods of the concrete implementation class. +Variables defined using [PHXScriptWrapperObject.addVariable(String, String, boolean)](PHXScriptWrapperObject.md) must be explicitly transferred using methods of the concrete implementation class. **Specified by:** - `transferVars` in class `AbstractFile` @@ -472,7 +472,7 @@ public void transferVar(PHXSimpleType var, PHXSectionNotFoundException, com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException ``` -Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The variable to read or write @@ -525,7 +525,7 @@ public void transferVar(PHXSimpleType var, PHXSectionNotFoundException, com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException ``` -Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The variable to read or write @@ -584,7 +584,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The array to read or write @@ -617,7 +617,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The array to read or write @@ -652,7 +652,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The array to read or write @@ -660,7 +660,7 @@ Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENER - `rowend` - The ending row in the file to read/write from/to - `fieldstart` - The starting field within the row to read/write from/to - `fieldend` - The ending field within the row to read/write from/to -- `resizable` - Whether or not the array is resizable when using [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE). +- `resizable` - Whether or not the array is resizable when using [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md). - `fformat` - The fortran style format string to apply. Pass null for standard formatting. **Throws:** @@ -689,7 +689,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The array to read or write @@ -697,7 +697,7 @@ Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENER - `rowend` - The ending row in the file to read/write from/to - `fieldstart` - The starting field within the row to read/write from/to - `fieldend` - The ending field within the row to read/write from/to -- `resizable` - Whether or not the array is resizable when using [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE). +- `resizable` - Whether or not the array is resizable when using [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md). - `fformat` - The fortran style format string to apply. Pass null for standard formatting. - `numDimensions` - The number of dimensions to read the array as. Must be 1 or 2. @@ -719,7 +719,7 @@ public void transferKeyVar(PHXSimpleType var, PHXNoSuchTokenException, PHXNumberFormatException ``` -Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The variable to read or write @@ -745,7 +745,7 @@ public void transferKeyVar(PHXSimpleType var, PHXNoSuchTokenException, PHXNumberFormatException ``` -Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE) data is read from the var and put into the file, otherwise data is read from the file into the variable. +Transfers the data for a particular variable. If mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) data is read from the var and put into the file, otherwise data is read from the file into the variable. **Parameters:** - `var` - The variable to read or write @@ -773,7 +773,7 @@ public java.lang.String readValue(int row, PHXSectionNotFoundException, com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException ``` -Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE), the input file is the fileToParse, otherwise it is the template file. +Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](ParseableFile.Mode.md), the input file is the fileToParse, otherwise it is the template file. **Parameters:** - `row` - The row of the file to read from @@ -801,7 +801,7 @@ public long readLong(int row, PHXSectionNotFoundException, com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException ``` -Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE), the input file is the fileToParse, otherwise it is the template file. Returns it as a long value. +Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](ParseableFile.Mode.md), the input file is the fileToParse, otherwise it is the template file. Returns it as a long value. **Parameters:** - `row` - The row of the file to read from @@ -830,7 +830,7 @@ public double readDouble(int row, PHXSectionNotFoundException, com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException ``` -Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#PARSE), the input file is the fileToParse, otherwise it is the template file. Returns it as a double value. +Reads a value out of the input file. If mode is [ParseableFile.Mode.PARSE](ParseableFile.Mode.md), the input file is the fileToParse, otherwise it is the template file. Returns it as a double value. **Parameters:** - `row` - The row of the file to read from @@ -855,7 +855,7 @@ public void writeValue(int row, throws java.io.IOException, PHXNoSuchTokenException ``` -Writes a token out to the output file. This is only useful if mode is [ParseableFile.Mode.GENERATE](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html#GENERATE). +Writes a token out to the output file. This is only useful if mode is [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md). **Parameters:** - `row` - The row of the file to read from diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md index a9822fc66b..57092cdded 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md @@ -12,7 +12,7 @@ **Implemented Interfaces** -- [IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) +- [IPHXRange](IPHXRange.md) --- **Declaration** @@ -49,9 +49,9 @@ implements IPHXRange | Modifier and Type | Method and Description | |-------------------|----------------------| -| `int` | `absoluteEndRow(IPHXLineStore lines, java.util.Vector bookmarks, java.util.Vector sections)` | -| `int` | `absoluteStartRow(IPHXLineStore lines, java.util.Vector bookmarks, java.util.Vector sections)`
Returns the actual starting row number | -| `void` | `assertEquals(IPHXRange other)`
Test comparison function. | +| `int` | `absoluteEndRow(`[`IPHXLineStore`](../IPHXLineStore.md)` lines, java.util.Vector bookmarks, java.util.Vector sections)` | +| `int` | `absoluteStartRow(`[`IPHXLineStore`](../IPHXLineStore.md)` lines, java.util.Vector bookmarks, java.util.Vector sections)`
Returns the actual starting row number | +| `void` | `assertEquals(`[`IPHXRange`](IPHXRange.md)` other)`
Test comparison function. | | `void` | `clearEndingMark()` | | `void` | `clearStartingMark()` | | `void` | `fromString(java.lang.String str)` | @@ -108,7 +108,7 @@ public static final java.lang.String RANGE_SEPARATOR ``` **See Also:** -- [Constant Field Values](../../../../../../constant-values.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange.RANGE_SEPARATOR) +- [Constant Field Values](../../../../../../constant-values.md) ### NAME_SEPARATOR @@ -117,7 +117,7 @@ public static final java.lang.String NAME_SEPARATOR ``` **See Also:** -- [Constant Field Values](../../../../../../constant-values.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange.NAME_SEPARATOR) +- [Constant Field Values](../../../../../../constant-values.md) ## Constructor Detail @@ -218,17 +218,17 @@ public void generate() Generate the input file **Specified by:** -- `generate` in interface `InputFile` +- `generate` in interface [`InputFile`](InputFile.md) **Throws:** - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXNumberFormatException`](../../types/PHXNumberFormatException.md) +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) - `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` ### setFileToGenerate @@ -239,7 +239,7 @@ public void setFileToGenerate(java.lang.String fileName) Set the file to be generated **Specified by:** -- `setFileToGenerate` in interface `InputFile` +- `setFileToGenerate` in interface [`InputFile`](InputFile.md) **Parameters:** - `fileName` - file name @@ -261,18 +261,18 @@ public void parse() Parse the output file **Specified by:** -- `parse` in interface `OutputFile` -- `parse` in interface `OutputFile2` +- `parse` in interface [`OutputFile`](OutputFile.md) +- `parse` in interface [`OutputFile2`](OutputFile2.md) **Throws:** - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXNumberFormatException`](../../types/PHXNumberFormatException.md) +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) - `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` ### setFileToParse @@ -283,8 +283,8 @@ public void setFileToParse(java.lang.String fileName) Set the file to be parsed **Specified by:** -- `setFileToParse` in interface `OutputFile` -- `setFileToParse` in interface `OutputFile2` +- `setFileToParse` in interface [`OutputFile`](OutputFile.md) +- `setFileToParse` in interface [`OutputFile2`](OutputFile2.md) **Parameters:** - `fileName` - file name @@ -292,14 +292,14 @@ Set the file to be parsed ### newParser ```java -protected Parser newParser(java.io.File rFile, - Parser.Mode pmode) +protected [`Parser`](../Parser.md) newParser(java.io.File rFile, + [`Parser.Mode`](../Parser.Mode.md) pmode) throws java.io.IOException ``` Generate a new parser for the given file and mode **Specified by:** -- `newParser` in class `AbstractFile` +- `newParser` in class [`AbstractFile`](AbstractFile.md) **Parameters:** - `rFile` - The file to open @@ -317,7 +317,7 @@ protected void ensureFileParser(ParseableFile.Mode mode) Ensure there is a valid parser **Overrides:** -- `ensureFileParser` in class `AbstractFile` +- `ensureFileParser` in class [`AbstractFile`](AbstractFile.md) **Parameters:** - `mode` - parser mode in current context @@ -359,9 +359,9 @@ public void defineVar(java.lang.String name, ``` **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` -- `PHXInvalidTypeException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) +- [`PHXInvalidTypeException`](../../types/PHXInvalidTypeException.md) ### defineVar @@ -383,9 +383,9 @@ public void defineVar(java.lang.String name, ``` **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` -- `PHXInvalidTypeException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) +- [`PHXInvalidTypeException`](../../types/PHXInvalidTypeException.md) ### defineVar @@ -408,9 +408,9 @@ public void defineVar(java.lang.String name, ``` **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` -- `PHXInvalidTypeException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) +- [`PHXInvalidTypeException`](../../types/PHXInvalidTypeException.md) ### transferVars @@ -428,20 +428,20 @@ protected void transferVars(ParseableFile.Mode mode) ``` Note that if wrapper is null, variable collection should be empty, and there should be no harm in calling this method -Transfer values for variables that have been defined using methods from the concrete implementation, i.e. [defineVar(String, String, boolean, String)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#defineVar-java.lang.String-java.lang.String-boolean-java.lang.String-) +Transfer values for variables that have been defined using methods from the concrete implementation, i.e. [`defineVar(String, String, boolean, String)`](PHXRowFieldFile.md) -Variables defined using [PHXScriptWrapperObject.addVariable(String, String, boolean)](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html#addVariable-java.lang.String-java.lang.String-boolean-) must be explicitly transferred using methods of the concrete implementation class +Variables defined using [`PHXScriptWrapperObject.addVariable(String, String, boolean)`](PHXScriptWrapperObject.md) must be explicitly transferred using methods of the concrete implementation class **Specified by:** -- `transferVars` in class `AbstractFile` +- `transferVars` in class [`AbstractFile`](AbstractFile.md) **Throws:** - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXNumberFormatException`](../../types/PHXNumberFormatException.md) +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) - `com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldOutOfFileException` \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md index 169603845a..d4cb7b8a1f 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md @@ -26,7 +26,7 @@ Represents a problem with transferring data in a `PHXRowFieldFile` object. **See Also:** -- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXScriptWrapperAPIException) +- [Serialized Form](../../../../../../serialized-form.md) ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md index 7dd9cd6b23..c9599284c8 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md @@ -86,8 +86,8 @@ Publicizes a method to our clients. There must be a method defined in the script **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) ### addMethod @@ -106,8 +106,8 @@ Publicizes a method to our clients. There must be a method defined in the script **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) ### addMethod @@ -126,8 +126,8 @@ Publicizes a method to our clients. There must be a method defined in the script **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) ### addMethod @@ -148,8 +148,8 @@ Publicizes a method to our clients. There must be a method defined in the script **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) ### addVariable @@ -172,7 +172,7 @@ Adds a variable to this component. Returns a reference to the new variable. Vali | geometry | geom | PHXGeometry | | file | | PHXRawFile | -All types except `PHXGeometry` and `PHXRawFile` may be made into arrays by adding [] at the end of the type string. In that case, the associated `PHXArray` class is used to represent a resizable, multi-dimensional array. +All types except `PHXGeometry` and `PHXRawFile` may be made into arrays by adding `[]` at the end of the type string. In that case, the associated `PHXArray` class is used to represent a resizable, multi-dimensional array. **Parameters:** @@ -182,9 +182,9 @@ All types except `PHXGeometry` and `PHXRawFile` may be made into arrays by addin **Throws:** -- `PHXNameAlreadyInUseException` - Thrown if there is already a variable by that name. -- `PHXInvalidNameException` - Thrown if the name uses invalid characters like space. -- `PHXInvalidTypeException` - Thrown if the type string is not understood +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) - Thrown if there is already a variable by that name. +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) - Thrown if the name uses invalid characters like space. +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) - Thrown if the type string is not understood ### getVariable @@ -196,7 +196,7 @@ Returns a reference to the named variable. **Throws:** -- `PHXNoSuchObjectException` +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) ### removeVariable @@ -208,7 +208,7 @@ Dynamically removes a variable from this component **Throws:** -- `PHXNoSuchObjectException` +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) ### addConsoleVariables @@ -221,9 +221,9 @@ public void addConsoleVariables() **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` -- `PHXInvalidTypeException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) ### updateConsoleVariables @@ -234,7 +234,7 @@ public void updateConsoleVariables() **Throws:** -- `PHXNoSuchObjectException` +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) ### getDirectory @@ -248,7 +248,7 @@ Returns the directory where this component was loaded from ```java public PHXRunShareContext getRunShare() ``` -Returns the PHXRunShareContext object used for process control and monitoring with this component +Returns the [`PHXRunShareContext`](PHXRunShareContext.md) object used for process control and monitoring with this component ### getRunDirectory @@ -308,8 +308,8 @@ Make a given file variable binary **Throws:** -- `PHXInvalidTypeException` -- `PHXNoSuchObjectException` +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) ### writeFile @@ -329,8 +329,8 @@ Write the given file variable out to the specified file **Throws:** -- `PHXInvalidTypeException` -- `PHXNoSuchObjectException` +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) - `java.io.IOException` ### parseFile @@ -352,8 +352,8 @@ Read the given file variable from the specified file **Throws:** -- `PHXInvalidTypeException` -- `PHXNoSuchObjectException` +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) - `java.io.IOException` ### deleteFile @@ -374,8 +374,8 @@ Deletes the given file variable's file **Throws:** -- `PHXInvalidTypeException` -- `PHXNoSuchObjectException` +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) - `java.io.IOException` ### backupFile @@ -396,8 +396,8 @@ Backup the file on disk. File is at the same location with ".bac" appended to th **Throws:** -- `PHXInvalidTypeException` -- `PHXNoSuchObjectException` +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) +- [`PHXNoSuchObjectException`](../../PHXNoSuchObjectException.md) - `java.io.IOException` ### defaultExecutableMapping @@ -434,7 +434,7 @@ Verifies we're running a compatible version of ModelCenter Remote Execution **Throws:** -- `PHXVersionException` +- [`PHXVersionException`](PHXVersionException.md) ### addAutoClose diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md index 02ea7b96f3..a5d901a9ab 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md @@ -134,8 +134,7 @@ public void setDelimiters(java.lang.String delimiters) public void assertEquals(PHXSection other) throws java.lang.Exception ``` -Test comparison function. If the two objects are not equal, an - exception is thrown +Test comparison function. If the two objects are not equal, an exception is thrown **Parameters:** - `other`- the data model to compare this to diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md index 42ca75f1bd..0a51834152 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md @@ -26,7 +26,7 @@ extends java.lang.Exception **See Also:** -- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXSectionNotFoundException) +- [Serialized Form](../../../../../../serialized-form.md) ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md index 3ffe427e7c..0fb2baeab2 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md @@ -26,7 +26,7 @@ extends java.lang.Exception **See Also:** -- [Serialized Form](../../../../../../serialized-form.html#com.phoenix_int.aserver.util.scriptwrapper.api.PHXVersionException) +- [Serialized Form](../../../../../../serialized-form.md) ## Constructor Summary diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md index 755549366e..bce8f24b3e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md @@ -3,7 +3,8 @@ **Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` **Enclosing interface:** -- [ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) + +- [`ParseableFile`](ParseableFile.md) **Class Hierarchy** diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md index 01b9a7da93..cf0cbcdc40 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md @@ -3,10 +3,12 @@ **Package:** `com.phoenix_int.aserver.util.scriptwrapper.api` **All Known Subinterfaces:** -: [InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), [OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) + +[`InputFile`](InputFile.md), [`OutputFile`](OutputFile.md) **All Known Implementing Classes:** -: [AbstractFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.html), [CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html), [PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html), [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) + +[`AbstractFile`](AbstractFile.md), [`CAEOutputFile`](CAEOutputFile.md), [`PHXRowFieldFile`](PHXRowFieldFile.md), [`XPathFile`](XPathFile.md) --- **Declaration:** @@ -20,7 +22,7 @@ Interface for files (not file variables) used in script wrappers | Modifier and Type | Interface and Description | |-------------------|-------------------------| -| `static class` | `ParseableFile.Mode`
File mode. Moved to type-safe enum from legacy integer constants | +| `static class` | [`ParseableFile.Mode`](ParseableFile.Mode.md)
File mode. Moved to type-safe enum from legacy integer constants | ## Method Summary @@ -74,14 +76,15 @@ void readTemplate() Read the template. In MCRE 7.1, this method was changed to never throw any exceptions. Reading the templates allows you to fill in default values if you can, but is not mandatory. **Throws:** + - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` -- `PHXBookmarkNotFoundException` -- `PHXSectionNotFoundException` +- [`PHXNumberFormatException`](../../../types/PHXNumberFormatException.md) +- [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) +- [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) ### setFileToGenerateOrParse @@ -105,7 +108,7 @@ This method applies only to ModelCenter and has no function in ModelCenter Remot ```java void setTemplateFile(java.lang.String templateFileName) ``` -Set the template file to read. If the template file is not specified, it defaults to the file that is parsed or generated, for `Mode.PARSE` or `Mode.GENERATE`, respectively. +Set the template file to read. If the template file is not specified, it defaults to the file that is parsed or generated, for [`Mode.PARSE`](ParseableFile.Mode.md) or [`Mode.GENERATE`](ParseableFile.Mode.md), respectively. **Parameters:** - `templateFileName` - file name @@ -124,4 +127,5 @@ Sets the value of a variable - `value` - variable value as a string **Throws:** -- `PHXNoSuchObjectException` \ No newline at end of file + +- [`PHXNoSuchObjectException`](../../../PHXNoSuchObjectException.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md index 499ef8da92..f140a863d4 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md @@ -12,7 +12,7 @@ **Implemented Interfaces** -- `InputFile`, `OutputFile`, `OutputFile2`, `ParseableFile`, `java.io.Closeable`, `java.lang.AutoCloseable` +- [`InputFile`](InputFile.md), [`OutputFile`](OutputFile.md), [`OutputFile2`](OutputFile2.md), [`ParseableFile`](ParseableFile.md), `java.io.Closeable`, `java.lang.AutoCloseable` --- **Declaration** @@ -27,12 +27,12 @@ Represents an XML file (not a file variable) used in a script wrapper, with acce ## Nested Class Summary -### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](ParseableFile.md) `ParseableFile.Mode` ## Field Summary -### Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile +### Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.[AbstractFile](AbstractFile.md) `encoding`, `fileName`, `mode`, `parser`, `templateFileName`, `wrapper` ## Constructor Summary @@ -108,9 +108,9 @@ Add a variable to the wrapper. The transfer of variable values will be handled a **Throws:** -- `PHXNameAlreadyInUseException` -- `PHXInvalidNameException` -- `PHXInvalidTypeException` +- [`PHXNameAlreadyInUseException`](../../PHXNameAlreadyInUseException.md) +- [`PHXInvalidNameException`](../../PHXInvalidNameException.md) +- [`PHXInvalidTypeException`](../../../types/PHXInvalidTypeException.md) ### newParser @@ -193,10 +193,10 @@ Variables defined using[PHXScriptWrapperObject.addVariable(String, String, boole - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` +- [`PHXNumberFormatException`](../../../types/PHXNumberFormatException.md) ### transferArray @@ -216,7 +216,7 @@ Transfer an array of values, either from the file to the variable, or vice-versa **Throws:** -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.io.IOException` - `javax.xml.xpath.XPathExpressionException` @@ -239,7 +239,7 @@ Transfer a value, either from the file to the variable, or vice-versa, depending **Throws:** - `javax.xml.xpath.XPathExpressionException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.io.IOException` ### parse @@ -264,10 +264,10 @@ Parse the output file - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` +- [`PHXNumberFormatException`](../../../types/PHXNumberFormatException.md) ### setFileToParse @@ -306,10 +306,10 @@ Generate the input file - `java.io.IOException` - `com.phoenix_int.aserver.util.PHXInvalidFormatException` -- `PHXNoSuchTokenException` +- [`PHXNoSuchTokenException`](../../PHXNoSuchTokenException.md) - `java.lang.IllegalAccessException` - `java.lang.InstantiationException` -- `PHXNumberFormatException` +- [`PHXNumberFormatException`](../../../types/PHXNumberFormatException.md) ### setFileToGenerate diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md index da6f8e5112..cded799b7d 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md @@ -1,47 +1,44 @@ # Package com.phoenix_int.aserver.util.scriptwrapper.api -Provides utilities which are designed to make writing ScriptWrappers -with FileWrapper-like capabilities. +Provides utilities which are designed to make writing ScriptWrappers with FileWrapper-like capabilities. ## Interface Summary | Interface | Description | | --- | --- | -| [InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html) | Interface for input files (not file variables) used in script-wrappers | -| [IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) | | -| [IPHXRangeChangeListener](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.html) | | -| [OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) | Deprecatedin favor of [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) | -| [OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) | Interface for output files (not file variables) used in script-wrappers | -| [ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) | Interface for files (not file variables) used in script wrappers | +| [`InputFile`](InputFile.md) | Interface for input files (not file variables) used in script-wrappers | +| [`IPHXRange`](IPHXRange.md) | | +| [`IPHXRangeChangeListener`](IPHXRangeChangeListener.md) | | +| [`OutputFile`](OutputFile.md) | Deprecated in favor of [`OutputFile2`](OutputFile2.md) | +| [`OutputFile2`](OutputFile2.md) | Interface for output files (not file variables) used in script-wrappers | +| [`ParseableFile`](ParseableFile.md) | Interface for files (not file variables) used in script wrappers | ## Class Summary | Class | Description | | --- | --- | -| [AbstractFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.html) | Common implementation for files (not file variables) used in script wrappers. | -| [CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html) | This represents a binary output file from a CAE program such as NASTRAN or LSDyna. | -| [PHXBookmark](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.html) | | -| [PHXCAERange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.html) | | -| [PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html) | Class implements the parsing capabilities of the RowField type files from the fileWrapper facility. | -| [PHXRowFieldRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.html) | | -| [PHXRunShareContext](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.html) | This class handles runshare capabilities for any component which needs it. | -| [PHXScriptWrapperObject](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html) | This object is passed to Script Wrapper scripts and provides the "wrapper" global object which provides runtime services for the wrapper. | -| [PHXSection](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.html) | | -| [XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html) | Represents an XML file (not a file variable) used in a script wrapper, with access to the XML node values via XPath statements | +| [`AbstractFile`](AbstractFile.md) | Common implementation for files (not file variables) used in script wrappers. | +| [`CAEOutputFile`](CAEOutputFile.md) | This represents a binary output file from a CAE program such as NASTRAN or LSDyna. | +| [`PHXBookmark`](PHXBookmark.md) | | +| [`PHXCAERange`](PHXCAERange.md) | | +| [`PHXRowFieldFile`](PHXRowFieldFile.md) | Class implements the parsing capabilities of the RowField type files from the fileWrapper facility. | +| [`PHXRowFieldRange`](PHXRowFieldRange.md) | | +| [`PHXRunShareContext`](PHXRunShareContext.md) | This class handles runshare capabilities for any component which needs it. | +| [`PHXScriptWrapperObject`](PHXScriptWrapperObject.md) | This object is passed to Script Wrapper scripts and provides the "wrapper" global object which provides runtime services for the wrapper. | +| [`PHXSection`](PHXSection.md) | | +| [`XPathFile`](XPathFile.md) | Represents an XML file (not a file variable) used in a script wrapper, with access to the XML node values via XPath statements | ## Enum Summary | Enum | Description | | --- | --- | -| [ParseableFile.Mode](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html) | File mode +| [`ParseableFile.Mode`](ParseableFile.Mode.md) | File mode Moved to type-safe enum from legacy integer constants | ## Exception Summary | Exception | Description | | --- | --- | -| [PHXBookmarkNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.html) | | -| [PHXScriptWrapperAPIException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.html) | Represents a problem with transferring data in a `PHXRowFieldFile` object. | -| [PHXSectionNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.html) | | -| [PHXVersionException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.html) | | +| [`PHXBookmarkNotFoundException`](PHXBookmarkNotFoundException.md) | | +| [`PHXScriptWrapperAPIException`](PHXScriptWrapperAPIException.md) | Represents a problem with transferring data in a [`PHXRowFieldFile`](PHXRowFieldFile.md) object. | +| [`PHXSectionNotFoundException`](PHXSectionNotFoundException.md) | | +| [`PHXVersionException`](PHXVersionException.md) | | ## Package com.phoenix_int.aserver.util.scriptwrapper.api Description -Provides utilities which are designed to make writing ScriptWrappers -with FileWrapper-like capabilities. These classes may also be used -from Java Components. \ No newline at end of file +Provides utilities which are designed to make writing ScriptWrappers with FileWrapper-like capabilities. These classes may also be used from Java Components. \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md index c1fb0f48fd..c0f69460fb 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md @@ -1,39 +1,39 @@ # Hierarchy For Package com.phoenix_int.aserver.util.scriptwrapper.api **Package Hierarchies:** -- [All Packages](../../../../../../overview-tree.html) +- [All Packages](../../../../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - - com.phoenix_int.aserver.util.scriptwrapper.api.[AbstractFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.html)(implements java.io.Closeable, com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html)) - - com.phoenix_int.aserver.util.scriptwrapper.api.[CAEOutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) - - com.phoenix_int.aserver.util.scriptwrapper.api.[XPathFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html)) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmark](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXCAERange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html)) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.html)(implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html)) - - com.phoenix_int.aserver.[PHXRunShare](../../../../../../com/phoenix_int/aserver/PHXRunShare.html)(implements com.phoenix_int.aserver.[IPHXMonitorable](../../../../../../com/phoenix_int/aserver/IPHXMonitorable.html), com.phoenix_int.aserver.trace.IPHXTraceGenerator) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRunShareContext](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperObject](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSection](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.html)(implements java.lang.Cloneable) + - com.phoenix_int.aserver.util.scriptwrapper.api.[AbstractFile](AbstractFile.md) (implements java.io.Closeable, com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](ParseableFile.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[CAEOutputFile](CAEOutputFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](OutputFile2.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldFile](PHXRowFieldFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](InputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](OutputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](OutputFile2.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[XPathFile](XPathFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](InputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](OutputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](OutputFile2.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmark](PHXBookmark.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXCAERange](PHXCAERange.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](IPHXRange.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](PHXRowFieldRange.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](IPHXRange.md)) + - com.phoenix_int.aserver.[PHXRunShare](../../../PHXRunShare.md) (implements com.phoenix_int.aserver.[IPHXMonitorable](../../../IPHXMonitorable.md), com.phoenix_int.aserver.trace.IPHXTraceGenerator) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRunShareContext](PHXRunShareContext.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperObject](PHXScriptWrapperObject.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSection](PHXSection.md) (implements java.lang.Cloneable) - java.lang.Throwable (implements java.io.Serializable) - java.lang.Exception - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmarkNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperAPIException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSectionNotFoundException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXVersionException](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.html) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmarkNotFoundException](PHXBookmarkNotFoundException.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperAPIException](PHXScriptWrapperAPIException.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSectionNotFoundException](PHXSectionNotFoundException.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXVersionException](PHXVersionException.md) ## Interface Hierarchy -- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.html) -- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRangeChangeListener](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.html) -- com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.html) -- com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.html) - - com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html) +- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](IPHXRange.md) +- com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRangeChangeListener](IPHXRangeChangeListener.md) +- com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](OutputFile2.md) +- com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](ParseableFile.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](InputFile.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](OutputFile.md) ## Enum Hierarchy - java.lang.Object - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) - - com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile.Mode](../../../../../../com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.html) \ No newline at end of file + - com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile.Mode](ParseableFile.Mode.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md index d4f3cbee8c..2c8bc5788d 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/Environment.md @@ -16,7 +16,7 @@ - `java.io.Serializable`, `java.lang.Cloneable`, `java.util.Map` --- -**Deprecated:** see `com.phoenix_int.pacz.api.v2.Environment` +**Deprecated:** see [`com.phoenix_int.pacz.api.v2.Environment`](v2/Environment.md) ```java @Deprecated @@ -76,7 +76,7 @@ public static final java.lang.String COMPONENT_DIR **Deprecated.** Pre-defined component directory environment variable **See Also:** -- [Constant Field Values](../../../../constant-values.html#com.phoenix_int.pacz.api.Environment.COMPONENT_DIR) +- [Constant Field Values](../../../../constant-values.md) ## Constructor Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md index 003bfdee0a..52bbdb40f2 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IComponentConfig.md @@ -3,7 +3,7 @@ **Package:** `com.phoenix_int.pacz.api` --- -**Deprecated:** see `com.phoenix_int.pacz.api.v2.IComponentConfig` +**Deprecated:** see [`com.phoenix_int.pacz.api.v2.IComponentConfig`](v2/IComponentConfig.md) ```java @Deprecated @@ -50,7 +50,7 @@ Environment getEnvironment() - component environment **See Also:** -- [Environment](../../../../com/phoenix_int/pacz/api/Environment.html) +- [Environment](Environment.md) ### getRunFolderPreference @@ -63,7 +63,7 @@ RunFolderPreference getRunFolderPreference() - component run folder preference **See Also:** -- [RunFolderPreference](../../../../com/phoenix_int/pacz/api/RunFolderPreference.html) +- [RunFolderPreference](RunFolderPreference.md) ### getVersion @@ -156,7 +156,7 @@ java.util.List getInputs() - list of component inputs **See Also:** -- [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) +- [IRuntimeVariable](IRuntimeVariable.md) ### getOutputs @@ -169,7 +169,7 @@ java.util.List getOutputs() - list of component outputs **See Also:** -- [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) +- [IRuntimeVariable](IRuntimeVariable.md) ### getInstanceFiles @@ -182,7 +182,7 @@ java.util.List getInstanceFiles() - list of component instance files **See Also:** -- [IInstanceFile](../../../../com/phoenix_int/pacz/api/IInstanceFile.html) +- [IInstanceFile](IInstanceFile.md) ### getProperties diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md index 6699af38bb..f17e7f5b3e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IInstanceFile.md @@ -3,7 +3,7 @@ **Package:** `com.phoenix_int.pacz.api` --- -**Deprecated:** see `com.phoenix_int.pacz.api.v2.IInstanceFile` +**Deprecated:** see [`com.phoenix_int.pacz.api.v2.IInstanceFile`](v2/IInstanceFile.md`) ```java @Deprecated diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md index 72048bb066..1cc06df6fb 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/IRuntimeVariable.md @@ -3,7 +3,7 @@ **Package:** `com.phoenix_int.pacz.api` --- -**Deprecated:** see `com.phoenix_int.pacz.api.v2.IRuntimeVariable` +**Deprecated:** see [`com.phoenix_int.pacz.api.v2.IRuntimeVariable`](v2/IRuntimeVariable.md) ```java @Deprecated diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md index 855f353db3..000cb999fd 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/RunFolderPreference.md @@ -17,7 +17,7 @@ **Deprecated.** -See `com.phoenix_int.pacz.api.v2.RunFolderPreferece` +See [`com.phoenix_int.pacz.api.v2.RunFolderPreferece`](v2/RunFolderPreference.md) ```java @Deprecated diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md index 30078ec61f..3dc7b8cb57 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/VariableDataType.md @@ -17,12 +17,12 @@ **Deprecated.** -IRuntimeVariables are now using the canonical PHX type identifiers which are literal strings (see `com.phoenix_int.pacz.api.v2`) +`IRuntimeVariables` are now using the canonical PHX type identifiers which are literal strings (see [`com.phoenix_int.pacz.api.v2.IRuntimeVariables`](v2/IRuntimeVariable.md)) ```java @Deprecated public enum VariableDataType - extends java.lang.Enum +extends java.lang.Enum ``` Supported variable data types diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md index 04ee173cff..39d4e79f6b 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-summary.md @@ -6,20 +6,20 @@ PACZ (extension .pacz) is a universal component/workflow format for use in the P ## Interface Summary | Interface | Description | | --- | --- | -| [IComponentConfig](../../../../com/phoenix_int/pacz/api/IComponentConfig.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.IComponentConfig` | -| [IInstanceFile](../../../../com/phoenix_int/pacz/api/IInstanceFile.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.IInstanceFile` | -| [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.IRuntimeVariable` | +| [IComponentConfig](IComponentConfig.md) | Deprecated
see [`com.phoenix_int.pacz.api.v2.IComponentConfig`](v2/IComponentConfig.md) | +| [IInstanceFile](IInstanceFile.md) | Deprecated
see [`com.phoenix_int.pacz.api.v2.IInstanceFile`](v2/IInstanceFile.md) | +| [IRuntimeVariable](IRuntimeVariable.md) | Deprecated
see [`com.phoenix_int.pacz.api.v2.IRuntimeVariable`](v2/IRuntimeVariable.md) | ## Class Summary | Class | Description | | --- | --- | -| [Environment](../../../../com/phoenix_int/pacz/api/Environment.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.Environment` | +| [Environment](Environment.md) | Deprecated
see [`com.phoenix_int.pacz.api.v2.Environment`](v2/Environment.md) | ## Enum Summary | Enum | Description | | --- | --- | -| [RunFolderPreference](../../../../com/phoenix_int/pacz/api/RunFolderPreference.html) | Deprecated
see `com.phoenix_int.pacz.api.v2.RunFolderPreferece` | -| [VariableDataType](../../../../com/phoenix_int/pacz/api/VariableDataType.html) | Deprecated
`IRuntimeVariables` are now using the canonical PHX type identifiers which are literal strings (see `com.phoenix_int.pacz.api.v2`) | +| [RunFolderPreference](RunFolderPreference.md) | Deprecated
see [`com.phoenix_int.pacz.api.v2.RunFolderPreference`](v2/RunFolderPreference.md) | +| [VariableDataType](VariableDataType.md) | Deprecated
`IRuntimeVariables` are now using the canonical PHX type identifiers which are literal strings (see [`com.phoenix_int.pacz.api.v2.IRuntimeVariable`](v2/IRuntimeVariable.md)) | ## Package com.phoenix_int.pacz.api Description PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products ModelCenter Remote Execution and ModelCenter Server. A PACZ is a zip archive with component files and a file containing metadata (extension ".pacj"; see below for details) that specifies its usage. @@ -36,24 +36,24 @@ Each PACJ file is broken into three sections: component-specific metadata, infor Component-specific metadata contains information about the component from a high level. This information includes a description of the component, what version it is, who authored it, and what icon to present to the user. -See [IComponentConfig](../../../../com/phoenix_int/pacz/api/IComponentConfig.html)for the interface representing the component configuration metadata +See [IComponentConfig](IComponentConfig.md)for the interface representing the component configuration metadata All fields listed below should be used in the component-specific configuration, unless otherwise specified: | Field name | Description | Corresponding method | | --- | --- | --- | | Field name | Description | Corresponding method | -| `version` | A human-readable string of the version info | [IComponentConfig.getVersion()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getVersion--) | +| `version` | A human-readable string of the version info | [IComponentConfig.getVersion()](IComponentConfig.md) | | `author` | The author of this component | Not currently implemented | -| `description` | A description of this component | [IComponentConfig.getDescription()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getDescription--) | -| `ASComponent` | The MCRE name of the underlying component | [IComponentConfig.getASComponent()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getASComponent--) | -| `icon` | The file relative to the ".pacj" file (usually stored in the ".pacz" file) to be used as an icon (optional) | [IComponentConfig.getIconUri()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getIconUri--) | -| `commandArgs` | Reserved for future use. Do not specify. | [IComponentConfig.getCommandLineArguments()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getCommandLineArguments--) | -| `requires` | Reserved for future use. Must currently be specified as ["analysisserver"] | [IComponentConfig.getRequiredFeatures()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getRequiredFeatures--) | -| `properties` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getProperties()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getProperties--) | -| `inputs` | A list of all input variables.See below for variable definitions. | [IComponentConfig.getInputs()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getInputs--) | -| `outputs` | A list of all output variables.See below for variable definitions. | [IComponentConfig.getOutputs()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getOutputs--) | -| `instanceFiles` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getInstanceFiles()](../../../../com/phoenix_int/pacz/api/IComponentConfig.html#getInstanceFiles--) | +| `description` | A description of this component | [IComponentConfig.getDescription()](IComponentConfig.md) | +| `ASComponent` | The MCRE name of the underlying component | [IComponentConfig.getASComponent()](IComponentConfig.md) | +| `icon` | The file relative to the ".pacj" file (usually stored in the ".pacz" file) to be used as an icon (optional) | [IComponentConfig.getIconUri()](IComponentConfig.md) | +| `commandArgs` | Reserved for future use. Do not specify. | [IComponentConfig.getCommandLineArguments()](IComponentConfig.md) | +| `requires` | Reserved for future use. Must currently be specified as ["analysisserver"] | [IComponentConfig.getRequiredFeatures()](IComponentConfig.md) | +| `properties` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getProperties()](IComponentConfig.md) | +| `inputs` | A list of all input variables.See below for variable definitions. | [IComponentConfig.getInputs()](IComponentConfig.md) | +| `outputs` | A list of all output variables.See below for variable definitions. | [IComponentConfig.getOutputs()](IComponentConfig.md) | +| `instanceFiles` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getInstanceFiles()](IComponentConfig.md) | ### Variables section @@ -61,21 +61,21 @@ The Variables section is specified by the`inputs`and`outputs`properties and cont Input variables should be specified in an array in the field `inputs`and output variables should be specified in an array in the field `outputs`. -See [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html)for the interface describing variables. +See [IRuntimeVariable](IRuntimeVariable.md) for the interface describing variables. All fields listed below should be used for each variable, unless otherwise specified: | Field name | Description | Corresponding method | | --- | --- | --- | -| `name` | The name of the variable. (in dotted notation) | [IRuntimeVariable.getName()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getName--) | -| `type` | The type of the variable. (See [VariableDataType](../../../../com/phoenix_int/pacz/api/VariableDataType.html)) | [IRuntimeVariable.getType()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getType--) | -| `enumAliases` | An array containing names for enumerated lists. If this property is specified, `enumValues`must also be specified. (optional) | [IRuntimeVariable.getEnumAliases()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getEnumAliases--) | -| `enumValues` | An array containing values for enumerated lists. If this property is specified, `enumAliases`must also be specified. (optional) | [IRuntimeVariable.getEnumValues()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getEnumValues--) | -| `upperBound` | The upper bound for this variable. (optional) | [IRuntimeVariable.getUpperBound()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getUpperBound--) | -| `lowerBound` | The lower bound for this variable. (optional) | [IRuntimeVariable.getLowerBound()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getLowerBound--) | -| `units` | The units for this variable. (optional) | [IRuntimeVariable.getUnits()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getUnits--) | -| `description` | The description for this variable. (optional) | [IRuntimeVariable.getDescription()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getDescription--) | -| `defaultValue` | A default value to present to the user | [IRuntimeVariable.getDefaultValue()](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html#getDefaultValue--) | +| `name` | The name of the variable. (in dotted notation) | [IRuntimeVariable.getName()](IRuntimeVariable.md) | +| `type` | The type of the variable. (See [VariableDataType](VariableDataType.md)) | [IRuntimeVariable.getType()](IRuntimeVariable.md) | +| `enumAliases` | An array containing names for enumerated lists. If this property is specified, `enumValues`must also be specified. (optional) | [IRuntimeVariable.getEnumAliases()](IRuntimeVariable.md) | +| `enumValues` | An array containing values for enumerated lists. If this property is specified, `enumAliases`must also be specified. (optional) | [IRuntimeVariable.getEnumValues()](IRuntimeVariable.md) | +| `upperBound` | The upper bound for this variable. (optional) | [IRuntimeVariable.getUpperBound()](IRuntimeVariable.md) | +| `lowerBound` | The lower bound for this variable. (optional) | [IRuntimeVariable.getLowerBound()](IRuntimeVariable.md) | +| `units` | The units for this variable. (optional) | [IRuntimeVariable.getUnits()](IRuntimeVariable.md) | +| `description` | The description for this variable. (optional) | [IRuntimeVariable.getDescription()](IRuntimeVariable.md) | +| `defaultValue` | A default value to present to the user | [IRuntimeVariable.getDefaultValue()](IRuntimeVariable.md) | Variable type may be specified using one of the following types. Types are case-sensitive and must be written exactly as listed. @@ -96,7 +96,7 @@ Variable type may be specified using one of the following types. Types are case- - Default values are not currently supported for variables of type`File`or`FileArray`and should be omitted. - Array default values should be specified by a string that contains the bounding dimensions of the array enclosed in square - brackets, followed by a comma-separated list of values enclosed in curly braces. For more information, see how to[specify array values.](../../../../../QuickWrap/specifyArrayValues.html) + brackets, followed by a comma-separated list of values enclosed in curly braces. - Enumerated values should be specified in standard JSON format, using square brackets and a list of comma-separated values, with special characters such as quotes escaped by a backslash, for example, "Hi! I\'m a PACJ enum value". Note that this format is different from the format used in components and wrappers. - PACJ files must be encoded in UTF-8. @@ -105,14 +105,14 @@ Variable type may be specified using one of the following types. Types are case- The Instance Files section specifies exactly which files inside of the PACZ archive are important to running the component. This feature is currently unimplemented and will be entirely ignored. However, this feature may be implemented at any time and therefore should be used to help document the internal component. -See [IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html)for the interface describing instance files. +See [IRuntimeVariable](IRuntimeVariable.md) for the interface describing instance files. -Instance files should be located in a field called`instanceFiles`and should be an array of objects, each containing the following values: +Instance files should be located in a field called `instanceFiles` and should be an array of objects, each containing the following values: | Field name | Description | Corresponding method | | --- | --- | --- | -| `name` | The name of the instance file | [IInstanceFile.getName()](../../../../com/phoenix_int/pacz/api/IInstanceFile.html#getName--) | -| `path` | The path to the instance file. The environment variable `COMPONENT_DIR` (which can be substituted in strings using the syntax `${COMPONENT_DIR}`) should be used to point to the file relative to the root of the PACZ. | [IInstanceFile.getPath()](../../../../com/phoenix_int/pacz/api/IInstanceFile.html#getPath--) | +| `name` | The name of the instance file | [IInstanceFile.getName()](IInstanceFile.md) | +| `path` | The path to the instance file. The environment variable `COMPONENT_DIR` (which can be substituted in strings using the syntax `${COMPONENT_DIR}`) should be used to point to the file relative to the root of the PACZ. | [IInstanceFile.getPath()](IInstanceFile.md) | ## Validation @@ -122,8 +122,7 @@ When ModelCenter Remote Execution or ModelCenter Server attempts to load a PACZ - All variables that are specified in the PACJ configuration must be present in the component. - The names of the variables must match between the PACJ configuration and the component. - The variable types must match between the PACJ configuration and the component. -- All variables specified as inputs in the PACJ must be inputs in the configuration, and all output variables in the - PACJ must be outputs in the component. +- All variables specified as inputs in the PACJ must be inputs in the configuration, and all output variables in the PACJ must be outputs in the component. - The default values of variables specified in the PACJ configuration must match the default (or initial) values of variables in the component. ## Example PACJ Configuration File diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md index a07c712209..30b21f2d35 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/package-tree.md @@ -1,23 +1,23 @@ # Hierarchy For Package com.phoenix_int.pacz.api **Package Hierarchies:** -- [All Packages](../../../../overview-tree.html) +- [All Packages](../../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - java.util.AbstractMap`` (implements java.util.Map``) - java.util.HashMap`` (implements java.lang.Cloneable, java.util.Map``, java.io.Serializable) - - com.phoenix_int.pacz.api.[Environment](../../../../com/phoenix_int/pacz/api/Environment.html) + - com.phoenix_int.pacz.api.[Environment](Environment.md) ## Interface Hierarchy -- com.phoenix_int.pacz.api.[IComponentConfig](../../../../com/phoenix_int/pacz/api/IComponentConfig.html) -- com.phoenix_int.pacz.api.[IInstanceFile](../../../../com/phoenix_int/pacz/api/IInstanceFile.html) -- com.phoenix_int.pacz.api.[IRuntimeVariable](../../../../com/phoenix_int/pacz/api/IRuntimeVariable.html) +- com.phoenix_int.pacz.api.[IComponentConfig](IComponentConfig.md) +- com.phoenix_int.pacz.api.[IInstanceFile](IInstanceFile.md) +- com.phoenix_int.pacz.api.[IRuntimeVariable](IRuntimeVariable.md) ## Enum Hierarchy - java.lang.Object - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) - - com.phoenix_int.pacz.api.[RunFolderPreference](../../../../com/phoenix_int/pacz/api/RunFolderPreference.html) - - com.phoenix_int.pacz.api.[VariableDataType](../../../../com/phoenix_int/pacz/api/VariableDataType.html) \ No newline at end of file + - com.phoenix_int.pacz.api.[RunFolderPreference](RunFolderPreference.md) + - com.phoenix_int.pacz.api.[VariableDataType](VariableDataType.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md index 7aba794909..1c67cc0f09 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/Environment.md @@ -20,13 +20,13 @@ ```java public class Environment - extends java.util.HashMap +extends java.util.HashMap ``` Environment variables for component configuration **See Also:** -- [Serialized Form](../../../../../serialized-form.html#com.phoenix_int.pacz.api.v2.Environment) +- [Serialized Form](../../../../../serialized-form.html) ## Nested Class Summary @@ -78,7 +78,7 @@ public static final java.lang.String COMPONENT_DIR Pre-defined component directory environment variable **See Also:** -- [Constant Field Values](../../../../../constant-values.html#com.phoenix_int.pacz.api.v2.Environment.COMPONENT_DIR) +- [Constant Field Values](../../../../../constant-values.html) ## Constructor Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md index ed2218ae84..9d2d02bcd7 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IComponentConfig.md @@ -57,7 +57,7 @@ Get component environment - component environment **See Also:** -- [Environment](../../../../../com/phoenix_int/pacz/api/v2/Environment.html) +- [Environment](Environment.md) ### getRunFolderPreference @@ -70,7 +70,7 @@ Get run folder preference for component - component run folder preference **See Also:** -- [RunFolderPreference](../../../../../com/phoenix_int/pacz/api/v2/RunFolderPreference.html) +- [RunFolderPreference](RunFolderPreference.md) ### getVersion @@ -163,7 +163,7 @@ Get component inputs - list of component inputs **See Also:** -- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) +- [IRuntimeVariable](IRuntimeVariable.md) ### setInputs @@ -176,7 +176,7 @@ Set component inputs - `inputs` - list of component inputs to use **See Also:** -- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) +- [IRuntimeVariable](IRuntimeVariable.md) ### getOutputs @@ -189,7 +189,7 @@ Get component outputs - list of component outputs **See Also:** -- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) +- [IRuntimeVariable](IRuntimeVariable.md) ### setOutputs @@ -202,7 +202,7 @@ Set component outputs - `outputs` - list of component outputs to use **See Also:** -- [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) +- [IRuntimeVariable](IRuntimeVariable.md) ### getInstanceFiles @@ -215,7 +215,7 @@ Get component instance files - list of component instance files **See Also:** -- [IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) +- [IInstanceFile](IInstanceFile.md) ### setInstanceFiles @@ -228,7 +228,7 @@ Set component instance files - `instanceFiles` - list of component instance files to use **See Also:** -- [IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) +- [IInstanceFile](IInstanceFile.md) ### getProperties diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md index 8440c3d116..89cf667117 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/IRuntimeVariable.md @@ -4,9 +4,9 @@ **All Superinterfaces** -- [IPHXType](../../../../../com/phoenix_int/aserver/types/IPHXType.html) -- [IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html) -- [IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html) +- [IPHXType](../../../aserver/types/IPHXType.md) +- [IPHXType2](../../../aserver/types/IPHXType2.md) +- [IPHXUnits](../../../aserver/types/IPHXUnits.md) - com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata --- @@ -20,7 +20,7 @@ Component variable interface ## Nested Class Summary -### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2 +### Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.[IPHXType2](../../../aserver/types/IPHXType2.md) `IPHXType2.IVisitor` ## Method Summary @@ -40,13 +40,13 @@ Component variable interface | `void` | `setVariableName(java.lang.String name)`
Set variable name | | `PHXSimpleType` | `toPHXSimpleType()`
Get the PHXSimpleType version of variable | -#### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType2 +#### Methods inherited from interface com.phoenix_int.aserver.types.[IPHXType2](../../../aserver/types/IPHXType2.md) `Accept`, `fromString2`, `toString2` -#### Methods inherited from interface com.phoenix_int.aserver.types.IPHXType +#### Methods inherited from interface com.phoenix_int.aserver.types.[IPHXType](../../../aserver/types/IPHXType.md) `fromString`, `toString` -#### Methods inherited from interface com.phoenix_int.aserver.types.IPHXUnits +#### Methods inherited from interface com.phoenix_int.aserver.types.[IPHXUnits](../../../aserver/types/IPHXUnits.md) `getUnits`, `setUnits` #### Methods inherited from interface com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata @@ -105,7 +105,7 @@ Get variable data type - variable data type **See Also:** -- [PHXTypeFactory.getVarType(java.lang.String)](../../../../../com/phoenix_int/aserver/types/PHXTypeFactory.html#getVarType-java.lang.String-) +- [PHXTypeFactory.getVarType(java.lang.String)](../../../aserver/types/PHXTypeFactory.md) ### getMetaData diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md index 208eae8fff..b77cb94de9 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-summary.md @@ -4,20 +4,20 @@ PACZ (extension .pacz) is a universal component/workflow format for use in the P ## Interface Summary | Interface | Description | | --- | --- | -| [IComponentConfig](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html) | Configuration for PACZ file | -| [IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) | Instance file within a component | -| [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) | Component variable interface | +| [IComponentConfig](IComponentConfig.md) | Configuration for PACZ file | +| [IInstanceFile](IInstanceFile.md) | Instance file within a component | +| [IRuntimeVariable](IRuntimeVariable.md) | Component variable interface | ## Class Summary | Class | Description | | --- | --- | -| [Environment](../../../../../com/phoenix_int/pacz/api/v2/Environment.html) | Environment variables for component configuration | +| [Environment](Environment.md) | Environment variables for component configuration | ## Enum Summary | Enum | Description | | --- | --- | -| [RunFolderPreference](../../../../../com/phoenix_int/pacz/api/v2/RunFolderPreference.html) | Preference for how files within the .pacz should be handled when running a component. | +| [RunFolderPreference](RunFolderPreference.md) | Preference for how files within the .pacz should be handled when running a component. | ## Package com.phoenix_int.pacz.api.v2 Description PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products ModelCeter Remote Execution and ModelCenter Server. A PACZ is a zip archive with component files and a file containing metadata (extension ".pacj"; see below for details) that specifies its usage. @@ -34,23 +34,23 @@ Each PACJ file is broken into three sections: component-specific metadata, infor Component-specific metadata contains information about the component from a high level. This information includes a description of the component, what version it is, who authored it, and what icon to present to the user. -See [IComponentConfig](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html) for the interface representing the component configuration metadata +See [IComponentConfig](IComponentConfig.md) for the interface representing the component configuration metadata All fields listed below should be used in the component-specific configuration, unless otherwise specified: | Field name | Description | Corresponding method | | --- | --- | --- | -| `version` | A human-readable string of the version info | [IComponentConfig.getVersion()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getVersion--) | -| `author` | The author of this component | [IComponentConfig.getAuthor()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getAuthor--) | -| `description` | A description of this component | [IComponentConfig.getDescription()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getDescription--) | -| `ASComponent` | The MCRE name of the underlying component | [IComponentConfig.getASComponent()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getASComponent--) | -| `icon` | The file relative to the ".pacj" file (usually stored in the ".pacz" file) to be used as an icon (optional) | [IComponentConfig.getIconUri()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getIconUri--) | -| `commandArgs` | Reserved for future use. Do not specify. | [IComponentConfig.getCommandLineArguments()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getCommandLineArguments--) | -| `requires` | Reserved for future use. Must currently be specified as ["analysisserver"] | [IComponentConfig.getRequiredFeatures()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getRequiredFeatures--) | -| `properties` | An arbitrary dictionary of values that allows a plug-in writer to store data about the instance without needing to create additional files in the pacz. See the **Properties** section for more details. | [IComponentConfig.getProperties()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getProperties--) | -| `inputs` | A list of all input variables.See below for variable definitions. | [IComponentConfig.getInputs()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getInputs--) | -| `outputs` | A list of all output variables.See below for variable definitions. | [IComponentConfig.getOutputs()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getOutputs--) | -| `instanceFiles` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getInstanceFiles()](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html#getInstanceFiles--) | +| `version` | A human-readable string of the version info | [IComponentConfig.getVersion()](IComponentConfig.md) | +| `author` | The author of this component | [IComponentConfig.getAuthor()](IComponentConfig.md) | +| `description` | A description of this component | [IComponentConfig.getDescription()](IComponentConfig.md) | +| `ASComponent` | The MCRE name of the underlying component | [IComponentConfig.getASComponent()](IComponentConfig.md) | +| `icon` | The file relative to the ".pacj" file (usually stored in the ".pacz" file) to be used as an icon (optional) | [IComponentConfig.getIconUri()](IComponentConfig.md) | +| `commandArgs` | Reserved for future use. Do not specify. | [IComponentConfig.getCommandLineArguments()](IComponentConfig.md) | +| `requires` | Reserved for future use. Must currently be specified as ["analysisserver"] | [IComponentConfig.getRequiredFeatures()](IComponentConfig.md) | +| `properties` | An arbitrary dictionary of values that allows a plug-in writer to store data about the instance without needing to create additional files in the pacz. See the **Properties** section for more details. | [IComponentConfig.getProperties()](IComponentConfig.md) | +| `inputs` | A list of all input variables.See below for variable definitions. | [IComponentConfig.getInputs()](IComponentConfig.md) | +| `outputs` | A list of all output variables.See below for variable definitions. | [IComponentConfig.getOutputs()](IComponentConfig.md) | +| `instanceFiles` | Reserved for future use. Any specified values will be ignored. | [IComponentConfig.getInstanceFiles()](IComponentConfig.md) | ### Variables section @@ -58,21 +58,21 @@ The Variables section is specified by the `inputs` and `outputs` properties and Input variables should be specified in an array in the field `inputs` and output variables should be specified in an array in the field `outputs`. -See [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) for the interface describing variables. +See [IRuntimeVariable](IRuntimeVariable.md) for the interface describing variables. All fields listed below should be used for each variable, unless otherwise specified: | Field name | Description | Corresponding method | | --- | --- | --- | -| `name` | The name of the variable. (in dotted notation) | [IRuntimeVariable.getVariableName()](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html#getVariableName--) | -| `type` | The type of the variable. (See`String`) | [IRuntimeVariable.getType()](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html#getType--) | +| `name` | The name of the variable. (in dotted notation) | [IRuntimeVariable.getVariableName()](IRuntimeVariable.md) | +| `type` | The type of the variable. (See`String`) | [IRuntimeVariable.getType()](IRuntimeVariable.md) | | `enumAliases` | An array containing names for enumerated lists. If this property is specified,`enumValues`must also be specified. (optional) | `IRuntimeVariableMetadata.getOptionalEnumAliases()` | | `enumValues` | An array containing values for enumerated lists. If this property is specified,`enumAliases`must also be specified. (optional) | `IRuntimeVariableMetadata.getOptionalEnumValues()` | | `upperBound` | The upper bound for this variable. (optional) | `IRuntimeVariableMetadata.getOptionalUpperBound()` | | `lowerBound` | The lower bound for this variable. (optional) | `IRuntimeVariableMetadata.getOptionalLowerBound()` | -| `units` | The units for this variable. (optional) | [IPHXUnits.getUnits()](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html#getUnits--) | -| `description` | The description for this variable. (optional) | [IRuntimeVariable.getDescription()](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html#getDescription--) | -| `defaultValue` | A default value to present to the user. | [IPHXType2.Accept(IVisitor)](../../../../../com/phoenix_int/aserver/types/IPHXType2.html#Accept-com.phoenix_int.aserver.types.IPHXType2.IVisitor-) | +| `units` | The units for this variable. (optional) | [IPHXUnits.getUnits()](../../../aserver/types/IPHXUnits.md) | +| `description` | The description for this variable. (optional) | [IRuntimeVariable.getDescription()](IRuntimeVariable.md) | +| `defaultValue` | A default value to present to the user. | [IPHXType2.Accept(IVisitor)](../../../aserver/types/IPHXType2.md) | Variable type may be specified using one of the following types. Types are case-sensitive and must be written exactly as listed. @@ -92,7 +92,7 @@ Variable type may be specified using one of the following types. Types are case- **Notes:** - Default values are not currently supported for variables of type`File`or`FileArray`and should be omitted. -- Array default values should be specified by a string that contains the bounding dimensions of the array enclosed in square brackets, followed by a comma-separated list of values enclosed in curly braces. For more information, see how to [specify array values.](../../../../../QuickWrap/specifyArrayValues.html) +- Array default values should be specified by a string that contains the bounding dimensions of the array enclosed in square brackets, followed by a comma-separated list of values enclosed in curly braces. - Enumerated values should be specified in standard JSON format, using square brackets and a list of comma-separated values, with special characters such as quotes escaped by a backslash, for example, "Hi! I\'m a PACJ enum value". Note that this format is different from the format used in components and wrappers. - PACJ files must be encoded in UTF-8. @@ -100,14 +100,14 @@ Variable type may be specified using one of the following types. Types are case- The Instance Files section specifies exactly which files inside of the PACZ archive are important to running the component. This feature is currently unimplemented and will be entirely ignored. However, this feature may be implemented at any time and therefore should be used to help document the internal component. -See [IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html) for the interface describing instance files. +See [IRuntimeVariable](IRuntimeVariable.md) for the interface describing instance files. Instance files should be located in a field called `instanceFiles` and should be an array of objects, each containing the following values: | Field name | Description | Corresponding method | | --- | --- | --- | -| `name` | The name of the instance file | [IInstanceFile.getName()](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html#getName--) | -| `path` | The path to the instance file. The environment variable `COMPONENT_DIR` (which can be substituted in strings using the syntax `${COMPONENT_DIR}`) should be used to point to the file relative to the root of the PACZ. | [IInstanceFile.getPath()](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html#getPath--) | +| `name` | The name of the instance file | [IInstanceFile.getName()](IInstanceFile.md) | +| `path` | The path to the instance file. The environment variable `COMPONENT_DIR` (which can be substituted in strings using the syntax `${COMPONENT_DIR}`) should be used to point to the file relative to the root of the PACZ. | [IInstanceFile.getPath()](IInstanceFile.md) | ### Properties section diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md index 703cbbd081..27d87fe9f6 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/pacz/api/v2/package-tree.md @@ -1,29 +1,29 @@ # Hierarchy For Package com.phoenix_int.pacz.api.v2 **Package Hierarchies:** -- [All Packages](../../../../../overview-tree.html) +- [All Packages](../../../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - java.util.AbstractMap`` (implements java.util.Map``) - java.util.HashMap`` (implements java.lang.Cloneable, java.util.Map``, java.io.Serializable) - - com.phoenix_int.pacz.api.v2.[Environment](../../../../../com/phoenix_int/pacz/api/v2/Environment.html) + - com.phoenix_int.pacz.api.v2.[Environment](Environment.md) ## Interface Hierarchy -- com.phoenix_int.pacz.api.v2.[IComponentConfig](../../../../../com/phoenix_int/pacz/api/v2/IComponentConfig.html) -- com.phoenix_int.pacz.api.v2.[IInstanceFile](../../../../../com/phoenix_int/pacz/api/v2/IInstanceFile.html) -- com.phoenix_int.aserver.types.[IPHXType](../../../../../com/phoenix_int/aserver/types/IPHXType.html) - - com.phoenix_int.aserver.types.[IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html) - - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html)(also extends com.phoenix_int.aserver.types.[IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) -- com.phoenix_int.aserver.types.[IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html) - - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html)(also extends com.phoenix_int.aserver.types.[IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) +- com.phoenix_int.pacz.api.v2.[IComponentConfig](IComponentConfig.md) +- com.phoenix_int.pacz.api.v2.[IInstanceFile](IInstanceFile.md) +- com.phoenix_int.aserver.types.[IPHXType](../../../aserver/types/IPHXType.md) + - com.phoenix_int.aserver.types.[IPHXType2](../../../aserver/types/IPHXType2.md) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](IRuntimeVariable.md)(also extends com.phoenix_int.aserver.types.[IPHXUnits](../../../aserver/types/IPHXUnits.md), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) +- com.phoenix_int.aserver.types.[IPHXUnits](../../../aserver/types/IPHXUnits.md) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](IRuntimeVariable.md)(also extends com.phoenix_int.aserver.types.[IPHXType2](../../../aserver/types/IPHXType2.md), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) - com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata - - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](../../../../../com/phoenix_int/pacz/api/v2/IRuntimeVariable.html)(also extends com.phoenix_int.aserver.types.[IPHXType2](../../../../../com/phoenix_int/aserver/types/IPHXType2.html), com.phoenix_int.aserver.types.[IPHXUnits](../../../../../com/phoenix_int/aserver/types/IPHXUnits.html)) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](IRuntimeVariable.md)(also extends com.phoenix_int.aserver.types.[IPHXType2](../../../aserver/types/IPHXType2.md), com.phoenix_int.aserver.types.[IPHXUnits](../../../aserver/types/IPHXUnits.md)) ## Enum Hierarchy - java.lang.Object - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) - - com.phoenix_int.pacz.api.v2.[RunFolderPreference](../../../../../com/phoenix_int/pacz/api/v2/RunFolderPreference.html) \ No newline at end of file + - com.phoenix_int.pacz.api.v2.[RunFolderPreference](RunFolderPreference.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md index 953ac61c7c..34d28b1f5e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXBlocker.md @@ -97,7 +97,7 @@ public static final java.lang.String rcsid ``` **See Also:** -- [Constant Field Values](../../../constant-values.html#com.phoenix_int.util.PHXBlocker.rcsid) +- [Constant Field Values](../../../constant-values.html) ## Constructor Detail diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md index af453f8f7c..a20d6fc415 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.md @@ -1,7 +1,7 @@ # Interface: PHXInternationalize.InternationalizedMessage **Enclosing class:** -[PHXInternationalize](../../../com/phoenix_int/util/PHXInternationalize.html) +[PHXInternationalize](PHXInternationalize.md) **Functional Interface:** This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md index 64c89806a5..8c1a733eda 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-summary.md @@ -3,13 +3,13 @@ ## Interface Summary | Interface | Description | | --- | --- | -| [PHXInternationalize.InternationalizedMessage](../../../com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.html) | Interface for a lazily computed translation message. | +| [PHXInternationalize.InternationalizedMessage](PHXInternationalize.InternationalizedMessage.md) | Interface for a lazily computed translation message. | ## Class Summary | Class | Description | | --- | --- | -| [BufferedRandomAccessFile](../../../com/phoenix_int/util/BufferedRandomAccessFile.html) | Replacement for `RandomAccessFile` to use buffered I/O as much as possible. | -| [PHXBlocker](../../../com/phoenix_int/util/PHXBlocker.html) | Class to simplify wait and notify calls. | -| [PHXInternationalize](../../../com/phoenix_int/util/PHXInternationalize.html) | Helper class to do internationalization. | -| [PHXNewLineAddFilter](../../../com/phoenix_int/util/PHXNewLineAddFilter.html) | Implementation of a `FilterReader` that basically does the opposite of the `PHXNewLineFilter`, adding in the platform dependent newlines from java style newlines '\n'. | -| [PHXNewLineFilter](../../../com/phoenix_int/util/PHXNewLineFilter.html) | Implementation of a `FilterReader` that processes out newlines into Java style newlines '\n' with the same logic as `BufferedReader.readLine()` | \ No newline at end of file +| [BufferedRandomAccessFile](BufferedRandomAccessFile.md) | Replacement for `RandomAccessFile` to use buffered I/O as much as possible. | +| [PHXBlocker](PHXBlocker.md) | Class to simplify wait and notify calls. | +| [PHXInternationalize](PHXInternationalize.md) | Helper class to do internationalization. | +| [PHXNewLineAddFilter](PHXNewLineAddFilter.md) | Implementation of a `FilterReader` that basically does the opposite of the `PHXNewLineFilter`, adding in the platform dependent newlines from java style newlines '\n'. | +| [PHXNewLineFilter](PHXNewLineFilter.md) | Implementation of a `FilterReader` that processes out newlines into Java style newlines '\n' with the same logic as `BufferedReader.readLine()` | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md index c212f8dfc9..696b2867c8 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/package-tree.md @@ -1,17 +1,17 @@ # Hierarchy For Package com.phoenix_int.util **Package Hierarchies:** -- [All Packages](../../../overview-tree.html) +- [All Packages](../../../overview-tree.md) ## Class Hierarchy - java.lang.Object - - com.phoenix_int.util.[BufferedRandomAccessFile](../../../com/phoenix_int/util/BufferedRandomAccessFile.html) - - com.phoenix_int.util.[PHXBlocker](../../../com/phoenix_int/util/PHXBlocker.html) - - com.phoenix_int.util.[PHXInternationalize](../../../com/phoenix_int/util/PHXInternationalize.html) + - com.phoenix_int.util.[BufferedRandomAccessFile](BufferedRandomAccessFile.md) + - com.phoenix_int.util.[PHXBlocker](PHXBlocker.md) + - com.phoenix_int.util.[PHXInternationalize](PHXInternationalize.md) - java.io.Reader (implements java.io.Closeable, java.lang.Readable) - - com.phoenix_int.util.[PHXNewLineAddFilter](../../../com/phoenix_int/util/PHXNewLineAddFilter.html) - - com.phoenix_int.util.[PHXNewLineFilter](../../../com/phoenix_int/util/PHXNewLineFilter.html) + - com.phoenix_int.util.[PHXNewLineAddFilter](PHXNewLineAddFilter.md) + - com.phoenix_int.util.[PHXNewLineFilter](PHXNewLineFilter.md) ## Interface Hierarchy -- com.phoenix_int.util.[PHXInternationalize.InternationalizedMessage](../../../com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.html) \ No newline at end of file +- com.phoenix_int.util.[PHXInternationalize.InternationalizedMessage](PHXInternationalize.InternationalizedMessage.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/deprecated-list.md b/2025R2/modelCenter_java_api/deprecated-list.md index 08d9e5fa02..e5c3c08b86 100644 --- a/2025R2/modelCenter_java_api/deprecated-list.md +++ b/2025R2/modelCenter_java_api/deprecated-list.md @@ -1,14 +1,6 @@ # Deprecated API -## Contents - -- [Deprecated Interfaces](#deprecated-interfaces) -- [Deprecated Classes](#deprecated-classes) -- [Deprecated Enums](#deprecated-enums) -- [Deprecated Fields](#deprecated-fields) -- [Deprecated Methods](#deprecated-methods) -- [Deprecated Constructors](#deprecated-constructors) - + ## Deprecated Interfaces | Interface and Description | @@ -22,6 +14,8 @@ | [com.phoenix_int.pacz.api.IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.html)
see [com.phoenix_int.pacz.api.v2.IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) | | [com.phoenix_int.aserver.util.scriptwrapper.api.OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.html)
in favor of [OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md) | + + ## Deprecated Classes | Class and Description | | --- | @@ -30,12 +24,16 @@ | [com.phoenix_int.aserver.types.PHXFile](com/phoenix_int/aserver/types/PHXFile.html) | | [com.phoenix_int.aserver.types.PHXInteger](com/phoenix_int/aserver/types/PHXInteger.html) | + + ## Deprecated Enums | Enum and Description | | --- | | [com.phoenix_int.pacz.api.RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.html)
see [`com.phoenix_int.pacz.api.v2.RunFolderPreference`](com/phoenix_int/pacz/api/v2/RunFolderPreference.md) | | [com.phoenix_int.pacz.api.VariableDataType](com/phoenix_int/pacz/api/VariableDataType.html) IRuntimeVariables are now using the canonical PHX type identifiers which are literal strings (see [`com.phoenix_int.pacz.api.v2`](com/phoenix_int/pacz/api/v2/package-summary.md)) | + + ## Deprecated Fields | Field and Description | | --- | @@ -47,6 +45,8 @@ | [com.phoenix_int.aserver.util.PHXFileParser.RANDOM_ACCESS](com/phoenix_int/aserver/util/PHXFileParser.html#RANDOM_ACCESS)
in favor of [Parser.Mode.RANDOM](com/phoenix_int/aserver/util/Parser.Mode.md#RANDOM) | | [com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldFile.READ_TEMPLATE](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.html#READ_TEMPLATE)
in favor of [ParseableFile.Mode.READ_TEMPLATE](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md#READ_TEMPLATE) | + + ## Deprecated Methods | Method and Description | | --- | @@ -60,6 +60,8 @@ | [com.phoenix_int.aserver.library.IPHXLibrarian.instantiate(String, String)](com/phoenix_int/aserver/library/IPHXLibrarian.html#instantiate-java.lang.String-java.lang.String-) | | [com.phoenix_int.aserver.library.IPHXLibrarian.instantiate(String, String, String, String)](com/phoenix_int/aserver/library/IPHXLibrarian.html#instantiate-java.lang.String-java.lang.String-java.lang.String-java.lang.String-) | + + ## Deprecated Construtors | Constructor and Description | | --- | diff --git a/2025R2/modelCenter_java_api/docfx.json b/2025R2/modelCenter_java_api/docfx.json index 57a65b0c01..5535a8447d 100644 --- a/2025R2/modelCenter_java_api/docfx.json +++ b/2025R2/modelCenter_java_api/docfx.json @@ -1,7 +1,7 @@ { "build": { "globalMetadata": { - "title": "ModelCenter", + "title": "ModelCenter Remote Execution Java API", "summary": "", "version": "2025 R2", "product": "ModelCenter", diff --git a/2025R2/modelCenter_java_api/index.md b/2025R2/modelCenter_java_api/index.md index 39c397a88e..3d60401eee 100644 --- a/2025R2/modelCenter_java_api/index.md +++ b/2025R2/modelCenter_java_api/index.md @@ -1,4 +1,4 @@ -This document contains the ModelCenter Java API. +This document contains the ModelCenter Remote Execution Java API. ## How This API Document Is Organized This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows. diff --git a/2025R2/modelCenter_java_api/overview-tree.md b/2025R2/modelCenter_java_api/overview-tree.md index de670fa8a1..e4b4eebd48 100644 --- a/2025R2/modelCenter_java_api/overview-tree.md +++ b/2025R2/modelCenter_java_api/overview-tree.md @@ -1,4 +1,5 @@ # Hierarchy For All Packages + ## Package Hierarchies - [com.phoenix_int.aserver](com/phoenix_int/aserver/package-tree.html) - [com.phoenix_int.aserver.client](com/phoenix_int/aserver/client/package-tree.html) diff --git a/2025R2/modelCenter_java_api/serialized-form.md b/2025R2/modelCenter_java_api/serialized-form.md index b49d529751..ab6a56aea2 100644 --- a/2025R2/modelCenter_java_api/serialized-form.md +++ b/2025R2/modelCenter_java_api/serialized-form.md @@ -1,4 +1,5 @@ # Serialized Form + ## Package com.phoenix_int.aserver ### Class com.phoenix_int.aserver.PHXCannotSetRunDirectoryException extends java.lang.Exception implements Serializable diff --git a/2025R2/modelCenter_java_api/toc.yaml b/2025R2/modelCenter_java_api/toc.yml similarity index 100% rename from 2025R2/modelCenter_java_api/toc.yaml rename to 2025R2/modelCenter_java_api/toc.yml From a5310c828985565a48b26812805e081b769ec3ad Mon Sep 17 00:00:00 2001 From: Leslie Poff Date: Tue, 1 Jul 2025 19:42:19 -0400 Subject: [PATCH 3/3] updated toc with Changelog --- 2025R2/modelCenter_java_api/toc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/2025R2/modelCenter_java_api/toc.yml b/2025R2/modelCenter_java_api/toc.yml index 39dd4bdf3a..c6e1935e39 100644 --- a/2025R2/modelCenter_java_api/toc.yml +++ b/2025R2/modelCenter_java_api/toc.yml @@ -400,5 +400,5 @@ href: com/phoenix_int/pacz/api/v2/package-summary.md - name: package-tree href: com/phoenix_int/pacz/api/v2/package-tree.md - - name: change_log.md - href: change_log.md \ No newline at end of file + - name: Changelog.md + href: Changelog.md \ No newline at end of file