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 a8de8e218c..40dabe1e34 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md @@ -31,7 +31,7 @@ If you also want to support Athena, you should extend `IPHXAthenaAnalysis` inste ### execute ```java void execute() - throws java.lang.Exception + 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. 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 0e6f7146fa..9ba26e605d 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md @@ -40,7 +40,7 @@ The above functions are used by the "describe" command in ModelCenter Remote Exe ### end ```java void end() - throws java.lang.Exception + throws java.lang.Exception ``` Notifies the driver that it has ended. The driver should perform any necessary shutdown functions. 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 ff1587a4ce..419c966ea9 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md @@ -32,7 +32,7 @@ This is the interface that drivers managed by ModelCenter Remote Execution must ### initializeIterations ```java void initializeIterations() - throws java.lang.Exception + 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. @@ -42,7 +42,7 @@ Initializes the driver to a starting state. This function will be called once be ### startIteration ```java void startIteration() - throws java.lang.Exception + 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. @@ -52,7 +52,7 @@ Performs the first step for an iteration of a driver. The driver should set valu ### endIteration ```java boolean endIteration() - throws java.lang.Exception + 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. 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 5107fa9041..61a67c7775 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md @@ -23,7 +23,7 @@ This is a specialized interface for ModelCenter Remote Execution. If a component ### halt ```java void halt() - throws java.lang.Exception + throws java.lang.Exception ``` Notifies the component to stop doing whatever it is currently doing. 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 754de2e99e..2521b6104f 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md @@ -28,7 +28,7 @@ This is the interface that analyses which provide information about running proc ### listProcesses ```java PHXProcessInfo[] listProcesses() - throws java.io.IOException + throws java.io.IOException ``` Lists all the running processes associated with a component. @@ -38,7 +38,7 @@ Lists all the running processes associated with a component. ### listMonitorableFiles ```java java.lang.String[] listMonitorableFiles() - throws java.io.IOException + 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. @@ -48,7 +48,7 @@ Lists all items that may be monitored for output as a component is running. Note ### getMonitor ```java java.lang.Object getMonitor(java.lang.String monitorName) - throws PHXNoSuchObjectException + 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. 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 5137391df9..78ab6b5587 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md @@ -17,8 +17,9 @@ public interface IPHXRunQueue ### setRunQueue ```java -void setRunQueue(java.lang.String connector, java.lang.String queue) - throws java.lang.Exception +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](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). 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 ade3fe231e..632b0ab3c4 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md @@ -33,7 +33,8 @@ This interface is for components that determine their properties at runtime. The ### getValue ```java java.lang.String getValue(java.lang.String name) - throws PHXNoSuchObjectException, java.lang.Exception + throws PHXNoSuchObjectException, + java.lang.Exception ``` Function for retrieving a specified value. @@ -49,8 +50,11 @@ Function for retrieving a specified value. ### setValue ```java -void setValue(java.lang.String name, java.lang.String value) - throws PHXNoSuchObjectException, PHXNoSuchWriteableObjectException, java.lang.Exception +void setValue(java.lang.String name, + java.lang.String value) + throws PHXNoSuchObjectException, + PHXNoSuchWriteableObjectException, + java.lang.Exception ``` Function for setting a specified value. @@ -66,7 +70,8 @@ Function for setting a specified value. ### getPropertyDescriptors ```java PHXPropertyDescriptor[] getPropertyDescriptors(java.lang.String name) - throws PHXNoSuchObjectException, java.lang.Exception + throws PHXNoSuchObjectException, + java.lang.Exception ``` Function for retrieving the properties of an object. @@ -96,7 +101,7 @@ Function for retrieving the methods of an object. ### invoke ```java java.lang.String invoke(java.lang.String methodName) - throws java.lang.Exception + throws java.lang.Exception ``` Invokes the named method. 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 22d25359d4..c54804aa14 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md @@ -37,7 +37,8 @@ This interface extends [`IPHXSelfManager`](IPHXSelfManager.md) and provides new ### getValue2 ```java java.lang.Object getValue2(java.lang.String name) - throws PHXNoSuchObjectException, java.lang.Exception + throws PHXNoSuchObjectException, + java.lang.Exception ``` Function for retrieving a specified value. @@ -48,13 +49,16 @@ Function for retrieving a specified value. - The value to be returned as any type of java Object. **Throws:** -- `PHXNoSuchObjectException` - thrown if the specified name does not exist +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - 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 +void setValue2(java.lang.String name, + PHXStringBuffer value) + throws PHXNoSuchObjectException, + PHXNoSuchWriteableObjectException, + java.lang.Exception ``` Function for setting a specified value. @@ -63,6 +67,6 @@ Function for setting a specified value. - `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 +- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified name does not exist +- [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md) - 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 index a406bfdada..a6f47d2ccc 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md @@ -36,7 +36,7 @@ This interface extends [`IPHXSelfManager2`](IPHXSelfManager2.md) and provides a ### invoke2 ```java PHXInvokeReturn invoke2(java.lang.String methodName) - throws java.lang.Exception + throws java.lang.Exception ``` Invokes the named method. 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 9b451cd06f..74f08dc4a1 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md @@ -26,7 +26,7 @@ This interface defines the contract for components that can be set up or initial ## Method Detail ### setupFromFile -``` +```java public void setupFromFile(java.lang.String fileName) throws java.io.IOException ``` diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md index 7b0f76f2d5..08e7ec1b62 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentBranch.md @@ -59,7 +59,7 @@ Constructs an empty named branch ### PHXComponentBranch ```java public PHXComponentBranch(org.w3c.dom.Element branchElement) - throws java.io.IOException + throws java.io.IOException ``` Constructs a branch based on an XML branch node 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 8a868472d6..ae0a322457 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXComponentVersion.md @@ -53,7 +53,10 @@ 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) +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 @@ -66,7 +69,7 @@ Constructs a version with the specified meta data ### PHXComponentVersion ```java public PHXComponentVersion(org.w3c.dom.Element versionNode) - throws java.io.IOException + throws java.io.IOException ``` Constructs a version based on information in an XML Element 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 97e0ac7c7e..6416efa264 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXGroup.md @@ -57,7 +57,7 @@ A utility class for holding sub-variables. Internally used to manage groups of v ### PHXGroup ```java public PHXGroup(java.lang.String name) - throws PHXInvalidNameException + throws PHXInvalidNameException ``` **Parameters:** @@ -80,8 +80,8 @@ retrieves the name of the group ### addGroup ```java public void addGroup(PHXGroup group) - throws PHXNameAlreadyInUseException, - PHXInvalidNameException + throws PHXNameAlreadyInUseException, + PHXInvalidNameException ``` adds a child group to the group @@ -95,7 +95,7 @@ adds a child group to the group ### getGroup ```java public PHXGroup getGroup(java.lang.String childName) - throws PHXNoSuchObjectException + throws PHXNoSuchObjectException ``` retrieves a child group. @@ -123,8 +123,8 @@ retrieves a child group. Does not throw an exception on failure. ### makeGroup ```java public PHXGroup makeGroup(java.lang.String childName) - throws PHXNameAlreadyInUseException, - PHXInvalidNameException + throws PHXNameAlreadyInUseException, + PHXInvalidNameException ``` creates a child group. If the group already exists, it is retrieved @@ -141,7 +141,7 @@ creates a child group. If the group already exists, it is retrieved ### removeGroup ```java public void removeGroup(java.lang.String childName) - throws java.lang.Exception + throws java.lang.Exception ``` remove a child group. If the group doesn't exist, it just returns @@ -181,8 +181,8 @@ retrieves all the subgroups in the group ### addVariable ```java public void addVariable(PHXVariableInfo varInfo) - throws PHXNameAlreadyInUseException, - PHXInvalidNameException + throws PHXNameAlreadyInUseException, + PHXInvalidNameException ``` stores a variable in the group. @@ -196,7 +196,7 @@ stores a variable in the group. ### getVariableInfo ```java public PHXVariableInfo getVariableInfo(java.lang.String varName) - throws PHXNoSuchObjectException + throws PHXNoSuchObjectException ``` retrieves a variable from the group. 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 486e085be0..e3f9869b3f 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXInvalidNameException.md @@ -54,11 +54,6 @@ public PHXInvalidNameException(java.lang.String name) ### checkName ```java public static void checkName(java.lang.String name) - throws PHXInvalidNameException + throws PHXInvalidNameException ``` Checks a name to see if it's valid. - -### 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/PHXMethodDescriptor.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md index af5898e735..bbb912a933 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXMethodDescriptor.md @@ -57,12 +57,15 @@ public PHXMethodDescriptor(java.lang.String name) ### PHXMethodDescriptor ```java -public PHXMethodDescriptor(java.lang.String name, java.lang.String fullName) +public PHXMethodDescriptor(java.lang.String name, + java.lang.String fullName) ``` ### PHXMethodDescriptor ```java -public PHXMethodDescriptor(java.lang.String name, java.lang.String fullName, boolean downloadInputs) +public PHXMethodDescriptor(java.lang.String name, + java.lang.String fullName, + boolean downloadInputs) ``` ## Method Detail @@ -118,11 +121,3 @@ public java.lang.String toString() ```java public static PHXMethodDescriptor fromString(java.lang.String str) ``` - -### 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/PHXRunShare.RunInfo.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.RunInfo.md index efed227b51..f7ed1b2c28 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 @@ -56,5 +56,6 @@ public java.io.File runFolder public RunInfo(java.lang.String cmd, java.lang.String runFolder) ``` -See also: [PHXRunShare](PHXRunShare.md) +**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 636bc4963f..8b943cf3ee 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXRunShare.md @@ -95,7 +95,7 @@ This class can only handle one single process running at a time. If you need to ## Field Detail ### MODE_NONE -``` +```java 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. @@ -105,7 +105,7 @@ This option performs no run sharing. This means that when two users attempt to r [`Constant Field Values`](../../../constant-values.md) ### MODE_ERROR -``` +```java 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. @@ -115,7 +115,7 @@ When a user tries to run a component that is already running, this option genera [`Constant Field Values`](../../../constant-values.md#com.phoenix_int.aserver.PHXRunShare.MODE_ERROR) ### MODE_WAIT -``` +```java 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. @@ -125,7 +125,7 @@ When the component is running, this option ensures that no one else will be able [`Constant Field Values`](../../../constant-values.md#com.phoenix_int.aserver.PHXRunShare.MODE_WAIT) ### MODE_SHARE -``` +```java 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. @@ -135,7 +135,7 @@ When two or more users attempt to run a component simultaneously, the FileWrappe [`Constant Field Values`](../../../constant-values.md#com.phoenix_int.aserver.PHXRunShare.MODE_SHARE) ### DEL_AUTO -``` +```java 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. @@ -145,7 +145,7 @@ delete the directory only if an error did not occur while running the wrapper. I [`Constant Field Values`](../../../constant-values.md#com.phoenix_int.aserver.PHXRunShare.DEL_AUTO) ### DEL_FALSE -``` +```java public static final int DEL_FALSE ``` do not delete the directory. @@ -155,7 +155,7 @@ do not delete the directory. [`Constant Field Values`](../../../constant-values.md#com.phoenix_int.aserver.PHXRunShare.DEL_FALSE) ### DEL_TRUE -``` +```java public static final int DEL_TRUE ``` delete the directory. @@ -167,7 +167,7 @@ delete the directory. ## Constructor Detail ### PHXRunShare -``` +```java public PHXRunShare(java.lang.String baseDir, java.lang.String wrapperID) ``` @@ -178,60 +178,60 @@ public PHXRunShare(java.lang.String baseDir, ## Method Detail ### finalize -``` +```java public void finalize() ``` **Overrides::** - `finalize` in class `java.lang.Object` ### getWrapperID -``` +```java 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 -``` +```java public PHXRunShare setDictionary(java.util.Map dict) ``` ### getDictionary -``` +```java public java.util.Map getDictionary() ``` ### setRunReplacer -``` +```java 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 -``` +```java public void addRunDirChangedListener(com.phoenix_int.aserver.IPHXRunDirChangedListener rdl) ``` Adds a listener which will receive events when the run directory is changed. ### removeRunDirChangedListener -``` +```java public void removeRunDirChangedListener(com.phoenix_int.aserver.IPHXRunDirChangedListener rdl) ``` Removes a listener for run directory changed events. ### getBaseDirectory -``` +```java public java.lang.String getBaseDirectory() ``` Gets the base dir which was passed in to the constructor. ### getDirectory -``` +```java 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 -``` +```java public void lock() throws java.io.IOException ``` @@ -243,7 +243,7 @@ Once in "locked" mode, calling `lock()` again has no effect. - `java.io.IOException` ### unlock -``` +```java public void unlock() ``` Unlocks the runshare mechanisms. This will unblock other components which are waiting for us to finish. @@ -251,7 +251,7 @@ Unlocks the runshare mechanisms. This will unblock other components which are wa Calling `unlock()` when not in "locked" mode has no effect. ### setDirectTransfer -``` +```java public void setDirectTransfer(boolean flag) ``` Set whether or not this runShare is involved in direct transfer of files @@ -260,7 +260,7 @@ Set whether or not this runShare is involved in direct transfer of files - `flag` - boolean flag ### cleanTempDir -``` +```java public void cleanTempDir() throws java.io.IOException ``` @@ -270,50 +270,50 @@ cleans up the temporary run directory if one has been created. In general, wrapp - `java.io.IOException` ### setRunDirectory -``` +```java public void setRunDirectory(java.lang.String runDirectory) - throws com.phoenix_int.aserver.PHXCannotSetRunDirectoryException + throws com.phoenix_int.aserver.PHXCannotSetRunDirectoryException ``` **Throws:** - `com.phoenix_int.aserver.PHXCannotSetRunDirectoryException` ### setMode -``` +```java public void setMode(int mode) ``` Sets the runshare mode. ### getMode -``` +```java public int getMode() ``` Gets the runshare mode ### addFileToCopy -``` +```java public void addFileToCopy(java.lang.String file) ``` ### setFilesToCopy -``` +```java public void setFilesToCopy(java.lang.String files) ``` Sets the files which need to be copied when runshare mode is MODE_SHARE. ### setAutoDelete -``` +```java 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 -``` +```java public int getAutoDelete() ``` Gets the auto-delete mode ### setIgnoreErrors -``` +```java 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. @@ -322,7 +322,7 @@ Sets the `IgnoreErrors` flag. By default this code will throw an exception if th - `flag` - true to ignore errors ### getIgnoreErrors -``` +```java public boolean getIgnoreErrors() ``` Gets the `IgnoreErrors` flag @@ -331,7 +331,7 @@ Gets the `IgnoreErrors` flag - the `IgnoreErrors` flag ### setAutoChangeDir -``` +```java 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. @@ -340,7 +340,7 @@ Sets the `AutoChangeDir` flag. This flag indicates whether to change the current - `flag` - false to not change folders. ### getAutoChangeDir -``` +```java public boolean getAutoChangeDir() ``` Gets the `AutoChangeDir` flag @@ -349,7 +349,7 @@ Gets the `AutoChangeDir` flag - the `AutoChangeDir` flag ### setShell -``` +```java 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. @@ -358,7 +358,7 @@ Sets the shell used to execute commands. This only applies to UNIX hosts. By def - `shell` - The shell used to invoke the run command ### getShell -``` +```java public java.lang.String getShell() ``` Gets the shell used to execute commands. @@ -367,9 +367,9 @@ Gets the shell used to execute commands. - the command shell ### run -``` +```java public void run(java.lang.String cmd) - throws java.lang.Exception + throws java.lang.Exception ``` Runs a command. Command may be relative to the run directory, see getDirectory(). @@ -386,12 +386,12 @@ If the command is halted (via [`halt()`](#halt) or [`timeout()`](#timeout)) and - `java.lang.Exception` ### run -``` +```java public void run(java.lang.String cmd, boolean ignoreErrors, boolean autoChangeDir, java.lang.String shell) - throws java.lang.Exception + throws java.lang.Exception ``` Runs a command. Command may be relative to the run directory, see getDirectory(). @@ -408,12 +408,12 @@ If the command is halted (via [`halt()`](../../../com/phoenix_int/aserver/PHXRun - `java.lang.Exception` ### run -``` +```java public void run(java.lang.String cmd, boolean ignoreErrors, java.lang.String autoChangeDir, java.lang.String shell) - throws java.lang.Exception + throws java.lang.Exception ``` Runs a command. Command may be relative to the run directory, see `getDirectory()`. @@ -436,25 +436,25 @@ If the command is halted (via `halt()` or `timeout()`) and `ignoreError` is fals - `java.lang.Exception` ### halt -``` +```java public void halt() ``` halts any running process ### timeout -``` +```java public void timeout() ``` Cleans up a run that has timed out ### reset -``` +```java public void reset() ``` Reset the `ProcessStruct` back to initial state for possible use in another run request. ### listProcesses -``` +```java public PHXProcessInfo[] listProcesses() throws java.io.IOException ``` Lists any running processes @@ -466,7 +466,7 @@ Lists any running processes - `java.io.IOException` - If there was a problem reading information about running processes ### listMonitorableFiles -``` +```java public java.lang.String[] listMonitorableFiles() throws java.io.IOException ``` @@ -479,7 +479,7 @@ Lists available "monitors". This will be "stdout" and "stderr". - `java.io.IOException` ### getMonitor -``` +```java public java.lang.Object getMonitor(java.lang.String m) throws PHXNoSuchObjectException ``` @@ -495,7 +495,7 @@ Returns any available monitors by name. - [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) ### addTraceListener -``` +```java public void addTraceListener(com.phoenix_int.aserver.trace.IPHXTraceListener listener) ``` Adds a listener to trace events @@ -507,7 +507,7 @@ Adds a listener to trace events - `listener` - the listener ### removeTraceListener -``` +```java public void removeTraceListener(com.phoenix_int.aserver.trace.IPHXTraceListener listener) ``` Removes a listener from trace events 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 b70fc58456..e46d475255 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager.md @@ -596,5 +596,3 @@ Notifies the driver that it has ended. The driver should perform any necesary sh **Throws:** - `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 328026c17b..6590828826 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager2.md @@ -18,8 +18,8 @@ **Declaration** ```java public class PHXSimpleSelfManager2 - extends PHXSimpleSelfManager - implements IPHXSelfManager2 +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`](types/PHXStringBuffer.md) and [`PHXRawFile`](types/PHXRawFile.md) classes. 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 e525c19a9b..0f3c07f51d 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXSimpleSelfManager3.md @@ -16,8 +16,8 @@ **Declaration** ```java public class PHXSimpleSelfManager3 - extends PHXSimpleSelfManager2 - implements IPHXSelfManager3, com.phoenix_int.aserver.IPHXConnector +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`](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. 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 e56fea0440..8049e48cf3 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/PHXVariableInfo.md @@ -11,7 +11,7 @@ **Declaration** ```java public class PHXVariableInfo - extends java.lang.Object +extends java.lang.Object ``` This is a utility class for holding parsing information about a variable. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md index a30bde17d7..0337fed899 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/ProcessHaltedException.md @@ -17,7 +17,7 @@ **Declaration** ```java public class ProcessHaltedException - extends java.io.IOException +extends java.io.IOException ``` 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/client/PHXAnalysisClient.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXAnalysisClient.md index 07293d5ecc..865aafd660 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 @@ -228,7 +228,7 @@ Sample Usage: ## Field Detail ### START_REQUEST -``` +```java public static final int START_REQUEST ``` Deprecated. @@ -237,7 +237,7 @@ Deprecated. - Constant Field Values ### END_REQUEST -``` +```java public static final int END_REQUEST ``` Deprecated. @@ -246,7 +246,7 @@ Deprecated. - Constant Field Values ### GET_REQUEST -``` +```java public static final int GET_REQUEST ``` Deprecated. @@ -255,7 +255,7 @@ Deprecated. - Constant Field Values ### SET_REQUEST -``` +```java public static final int SET_REQUEST ``` Deprecated. @@ -264,7 +264,7 @@ Deprecated. - Constant Field Values ### LIST_REQUEST -``` +```java public static final int LIST_REQUEST ``` Deprecated. @@ -273,7 +273,7 @@ Deprecated. - Constant Field Values ### LIST_CLASSES_REQUEST -``` +```java public static final int LIST_CLASSES_REQUEST ``` Deprecated. @@ -282,7 +282,7 @@ Deprecated. - Constant Field Values ### LIST_PROPERTIES_REQUEST -``` +```java public static final int LIST_PROPERTIES_REQUEST ``` Deprecated. @@ -291,7 +291,7 @@ Deprecated. - Constant Field Values ### LIST_CATEGORIES_REQUEST -``` +```java public static final int LIST_CATEGORIES_REQUEST ``` Deprecated. @@ -300,7 +300,7 @@ Deprecated. - Constant Field Values ### EXECUTE_REQUEST -``` +```java public static final int EXECUTE_REQUEST ``` Deprecated. @@ -309,7 +309,7 @@ Deprecated. - Constant Field Values ### DESCRIBE_REQUEST -``` +```java public static final int DESCRIBE_REQUEST ``` Deprecated. @@ -318,7 +318,7 @@ Deprecated. - Constant Field Values ### GET_ICON_REQUEST -``` +```java public static final int GET_ICON_REQUEST ``` Deprecated. @@ -327,7 +327,7 @@ Deprecated. - Constant Field Values ### LIST_VALUES_REQUEST -``` +```java public static final int LIST_VALUES_REQUEST ``` Deprecated. @@ -336,7 +336,7 @@ Deprecated. - Constant Field Values ### LIST_ARRAY_VALUES_REQUEST -``` +```java public static final int LIST_ARRAY_VALUES_REQUEST ``` Deprecated. @@ -345,7 +345,7 @@ Deprecated. - Constant Field Values ### LIST_METHODS_REQUEST -``` +```java public static final int LIST_METHODS_REQUEST ``` Deprecated. @@ -354,7 +354,7 @@ Deprecated. - Constant Field Values ### INVOKE_REQUEST -``` +```java public static final int INVOKE_REQUEST ``` Deprecated. @@ -363,7 +363,7 @@ Deprecated. - Constant Field Values ### ADD_PROXY_CLIENTS_REQUEST -``` +```java public static final int ADD_PROXY_CLIENTS_REQUEST ``` Deprecated. @@ -372,7 +372,7 @@ Deprecated. - Constant Field Values ### HISTORY_REQUEST -``` +```java public static final int HISTORY_REQUEST ``` Deprecated. @@ -381,7 +381,7 @@ Deprecated. - Constant Field Values ### GET_BY_URL_REQUEST -``` +```java public static final int GET_BY_URL_REQUEST ``` Deprecated. @@ -390,7 +390,7 @@ Deprecated. - Constant Field Values ### GET_HIERARCHY_REQUEST -``` +```java public static final int GET_HIERARCHY_REQUEST ``` Deprecated. @@ -399,7 +399,7 @@ Deprecated. - Constant Field Values ### SET_HIERARCHY_REQUEST -``` +```java public static final int SET_HIERARCHY_REQUEST ``` Deprecated. @@ -408,7 +408,7 @@ Deprecated. - Constant Field Values ### DELETE_RUN_SHARE_REQUEST -``` +```java public static final int DELETE_RUN_SHARE_REQUEST ``` Deprecated. @@ -417,7 +417,7 @@ Deprecated. - Constant Field Values ### SET_DICTIONARY_REQUEST -``` +```java public static final int SET_DICTIONARY_REQUEST ``` Deprecated. @@ -426,7 +426,7 @@ Deprecated. - Constant Field Values ### SET_BY_URL_REQUEST -``` +```java public static final int SET_BY_URL_REQUEST ``` Deprecated. @@ -435,7 +435,7 @@ Deprecated. - Constant Field Values ### ARBITRARY_REQUEST -``` +```java public static final int ARBITRARY_REQUEST ``` Deprecated. @@ -444,7 +444,7 @@ Deprecated. - Constant Field Values ### LIST_VALUES_URL_REQUEST -``` +```java public static final int LIST_VALUES_URL_REQUEST ``` Deprecated. @@ -455,13 +455,13 @@ Deprecated. ## Constructor Detail ### PHXAnalysisClient -``` +```java public PHXAnalysisClient() ``` Deprecated. ### PHXAnalysisClient -``` +```java public PHXAnalysisClient(java.lang.String host) throws java.io.IOException, java.net.UnknownHostException @@ -476,7 +476,7 @@ Deprecated. - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### PHXAnalysisClient -``` +```java public PHXAnalysisClient(java.lang.String host, int port) throws java.io.IOException, @@ -493,7 +493,7 @@ Deprecated. - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### PHXAnalysisClient -``` +```java public PHXAnalysisClient(java.lang.String host, int port, int timeout) @@ -512,7 +512,7 @@ Deprecated. - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### PHXAnalysisClient -``` +```java public PHXAnalysisClient(java.lang.String host, int timeout, java.lang.String username, @@ -535,10 +535,10 @@ Deprecated. ## Method Detail ### connect -``` +```java public void connect(java.lang.String host) - throws java.io.IOException, - java.net.UnknownHostException + throws java.io.IOException, + java.net.UnknownHostException ``` Deprecated. @@ -552,11 +552,11 @@ connects to MCRE on the specified host - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### connectURL -``` +```java public void connectURL(java.lang.String url) - throws java.io.IOException, - java.net.UnknownHostException, - java.net.URISyntaxException + throws java.io.IOException, + java.net.UnknownHostException, + java.net.URISyntaxException ``` Deprecated. @@ -571,14 +571,14 @@ connects to MCRE using the specified URL, such as `mcre://hostname`. - `java.net.URISyntaxException` ### connectURL -``` +```java 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 + int timeout, + java.lang.String user, + java.lang.String password) + throws java.io.IOException, + java.net.UnknownHostException, + java.net.URISyntaxException ``` Deprecated. @@ -593,10 +593,10 @@ connects to ModelCenter Remote Execution using the specified URL, such as `mcre: - `java.net.URISyntaxException` ### connectLocal -``` +```java public void connectLocal(java.lang.String userName, - java.lang.String password) - throws java.io.IOException + java.lang.String password) + throws java.io.IOException ``` Deprecated. @@ -610,12 +610,12 @@ Makes a virtual connection to ModelCenter Remote Execution inside of this proces - `java.io.IOException` - thrown if a connection cannot be established ### connectLocal -``` +```java public void connectLocal(java.lang.String userName, - java.lang.String password, - java.util.Map initialProps) - throws java.io.IOException + java.lang.String password, + java.util.Map initialProps) + throws java.io.IOException ``` Deprecated. @@ -629,12 +629,12 @@ Makes a virtual connection to the MCRE inside of this process. MCRE must have be - `java.io.IOException` - thrown if a connection cannot be established ### connectProcess -``` +```java public void connectProcess(java.lang.String userName, - java.lang.String password, - java.lang.String asRoot, - java.lang.String asConfig) - throws java.io.IOException + java.lang.String password, + java.lang.String asRoot, + java.lang.String asConfig) + throws java.io.IOException ``` Deprecated. @@ -648,11 +648,11 @@ Makes a virtual connection to MCRE by calling a new java process. MCRE must have - `java.io.IOException` - thrown if a connection cannot be established ### connect -``` +```java public void connect(java.lang.String host, - int port) - throws java.io.IOException, - java.net.UnknownHostException + int port) + throws java.io.IOException, + java.net.UnknownHostException ``` Deprecated. @@ -667,11 +667,12 @@ connects to MCRE on the specified host - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### connect -``` +```java public void connect(java.lang.String host, - int port, - boolean useSSL) - throws java.io.IOException, java.net.UnknownHostException + int port, + boolean useSSL) + throws java.io.IOException, + java.net.UnknownHostException ``` Deprecated. @@ -687,12 +688,12 @@ connects to MCRE on the specified host - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### connectExternal -``` +```java public void connectExternal(java.lang.String host, - int timeout, - java.lang.String username, - java.lang.String password) - throws java.io.IOException + int timeout, + java.lang.String username, + java.lang.String password) + throws java.io.IOException ``` Deprecated. @@ -709,13 +710,13 @@ connects to MCRE via external tool - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### connect -``` +```java public void connect(java.lang.String host, - int port, - boolean useSSL, - int timeout) - throws java.io.IOException, - java.net.UnknownHostException + int port, + boolean useSSL, + int timeout) + throws java.io.IOException, + java.net.UnknownHostException ``` Deprecated. @@ -732,15 +733,15 @@ connects to MCRE on the specified host - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### connect -``` +```java 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 + int port, + boolean useSSL, + int timeout, + java.lang.String username, + java.lang.String password) + throws java.io.IOException, + java.net.UnknownHostException ``` Deprecated. @@ -759,12 +760,12 @@ connects to MCRE on the specified host - `java.net.UnknownHostException` - thrown if the host does not match a valid host ### handleLogin -``` +```java public static void handleLogin(java.io.InputStream in, - java.io.OutputStream out, - java.lang.String username, - java.lang.String password) - throws java.io.IOException + java.io.OutputStream out, + java.lang.String username, + java.lang.String password) + throws java.io.IOException ``` Deprecated. @@ -772,7 +773,7 @@ Deprecated. - `java.io.IOException` ### isConnected -``` +```java public boolean isConnected() ``` Deprecated. @@ -783,7 +784,7 @@ determines if the client is currently connected to a server - true if currently connected ### setDeleteDFT -``` +```java public void setDeleteDFT(boolean delete) ``` Deprecated. @@ -791,7 +792,7 @@ Deprecated. Set whether the analysis client should auto-delete Direct File Transfer run shares or not ### getHostName -``` +```java public java.lang.String getHostName() ``` Deprecated. @@ -802,7 +803,7 @@ retrieves the host name of the server - the host name, or "not connected" if not currently connected to the server ### close -``` +```java public void close() ``` Deprecated. @@ -810,7 +811,7 @@ Deprecated. closes the connection to the server ### finalize -``` +```java protected void finalize() throws java.lang.Throwable ``` @@ -823,7 +824,7 @@ Overrides: - `java.lang.Throwable` ### addListener -``` +```java public void addListener(IPHXAnalysisClientListener l) ``` Deprecated. @@ -834,7 +835,7 @@ adds a listener - l - the listener ### removeListener -``` +```java public void removeListener(IPHXAnalysisClientListener l) ``` Deprecated. @@ -845,7 +846,7 @@ removes a listener - l - the listener ### isResponseReady -``` +```java public boolean isResponseReady(java.lang.String id) ``` Deprecated. @@ -859,7 +860,7 @@ indicates whether a response is ready - true if the response is ready ### sendStartRequest -``` +```java public java.lang.String sendStartRequest(java.lang.String analysis, java.lang.String instanceName) ``` @@ -875,7 +876,7 @@ sends a request to start an analysis - the id for the response ### getStartResponse -``` +```java public java.lang.String getStartResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -899,7 +900,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### start -``` +```java public java.lang.String start(java.lang.String analysis, java.lang.String instanceName) throws PHXServerSideException @@ -919,7 +920,7 @@ starts an analysis - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendEndRequest -``` +```java public java.lang.String sendEndRequest(java.lang.String analysis) ``` Deprecated. @@ -933,12 +934,12 @@ sends a request to end an analysis - the id for the response ### getEndResponse -``` +```java public java.lang.String getEndResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -957,7 +958,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### end -``` +```java public java.lang.String end(java.lang.String analysis) throws PHXServerSideException ``` @@ -975,7 +976,7 @@ ends an analysis - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListClassesRequest -``` +```java public java.lang.String sendListClassesRequest(java.lang.String category) ``` Deprecated. @@ -989,7 +990,7 @@ sends a request to list the classes - the id for the response ### getListClassesResponse -``` +```java public java.lang.String[] getListClassesResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1013,7 +1014,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listClasses -``` +```java public java.lang.String[] listClasses(java.lang.String category) throws PHXServerSideException ``` @@ -1031,7 +1032,7 @@ lists the classes within a category - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendExecuteRequest -``` +```java public java.lang.String sendExecuteRequest(java.lang.String analysis) ``` Deprecated. @@ -1045,7 +1046,7 @@ sends a request to execute an analysis - the id for the response ### getExecuteResponse -``` +```java public java.lang.String getExecuteResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1069,7 +1070,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### execute -``` +```java public java.lang.String execute(java.lang.String analysis) throws PHXServerSideException ``` @@ -1087,7 +1088,7 @@ exectutes an analysis - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendAddProxyClientsRequest -``` +```java public java.lang.String sendAddProxyClientsRequest(java.lang.String clients) ``` Deprecated. @@ -1101,12 +1102,12 @@ Tells the server to add other hosts as part of the proxy chain - the id for the response ### getAddProxyClientsResponse -``` +```java public java.lang.String getAddProxyClientsResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1125,7 +1126,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### addProxyClients -``` +```java public java.lang.String addProxyClients(java.lang.String clients) throws PHXServerSideException ``` @@ -1143,7 +1144,7 @@ Tells the server to add other hosts as part of the proxy chain - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendGetRequest -``` +```java public java.lang.String sendGetRequest(java.lang.String property) ``` Deprecated. @@ -1157,7 +1158,7 @@ sends a request to get the value of a property - the id for the response ### getGetResponse -``` +```java public java.lang.String getGetResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1181,7 +1182,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getGetResponse2 -``` +```java public PHXStringBuffer getGetResponse2(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1205,7 +1206,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### get -``` +```java public java.lang.String get(java.lang.String property) throws PHXServerSideException ``` @@ -1224,7 +1225,7 @@ get the value of a property - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### get2 -``` +```java public PHXStringBuffer get2(java.lang.String property) throws PHXServerSideException ``` @@ -1243,7 +1244,7 @@ get the value of a property - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### sendGetByUrlRequest -``` +```java public java.lang.String sendGetByUrlRequest(java.lang.String propertyName, java.lang.String url) ``` @@ -1258,7 +1259,7 @@ sends a request to get the value of a property - the id for the response ### getGetByUrlResponse -``` +```java public PHXStringBuffer getGetByUrlResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1282,7 +1283,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getByUrl -``` +```java public PHXStringBuffer getByUrl(java.lang.String propertyName, java.lang.String url) throws PHXServerSideException @@ -1302,7 +1303,7 @@ get the value of a property - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### sendSetByUrlRequest -``` +```java public java.lang.String sendSetByUrlRequest(java.lang.String varName, java.lang.String url) ``` @@ -1317,7 +1318,7 @@ sends a request to get the value of a property - the id for the response ### getSetByUrlResponse -``` +```java public PHXStringBuffer getSetByUrlResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1341,7 +1342,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### setByUrl -``` +```java public void setByUrl(java.lang.String varName, java.lang.String url) throws PHXServerSideException @@ -1358,7 +1359,7 @@ set the value of a variable - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendSetRequest -``` +```java public java.lang.String sendSetRequest(java.lang.String property, java.lang.Object value) ``` @@ -1373,7 +1374,7 @@ sends a request to set the value of a property - the id for the response ### getSetResponse -``` +```java public java.lang.String getSetResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1397,7 +1398,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### set -``` +```java public java.lang.String set(java.lang.String property, java.lang.Object value) throws PHXServerSideException @@ -1418,7 +1419,7 @@ set the value of a property - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### sendGetComponentHistoryRequest -``` +```java public java.lang.String sendGetComponentHistoryRequest(java.lang.String analysis) ``` Deprecated. @@ -1432,7 +1433,7 @@ sends a request to get the version history of a component - the id for the response ### getGetComponentHistoryResponse -``` +```java public PHXComponentBranch getGetComponentHistoryResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1456,7 +1457,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getComponentHistory -``` +```java public PHXComponentBranch getComponentHistory(java.lang.String analysis) throws PHXServerSideException ``` @@ -1474,7 +1475,7 @@ Gets the component history for a particular component. - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the server reports any problems. ### sendDescribeRequest -``` +```java public java.lang.String sendDescribeRequest(java.lang.String analysis) ``` Deprecated. @@ -1488,12 +1489,12 @@ sends a request to describe an analysis - the id for the response ### getDescribeResponse -``` +```java public PHXComponentDescription getDescribeResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1512,7 +1513,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### describe -``` +```java public PHXComponentDescription describe(java.lang.String analysis) throws PHXServerSideException ``` @@ -1530,7 +1531,7 @@ describes an analysis - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListPropertiesRequest -``` +```java public java.lang.String sendListPropertiesRequest(java.lang.String analysis) ``` Deprecated. @@ -1544,12 +1545,12 @@ sends a request to list the properties of an analysis - the id for the response ### getListPropertiesResponse -``` +```java public PHXPropertyDescriptor[] getListPropertiesResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1568,7 +1569,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listProperties -``` +```java public PHXPropertyDescriptor[] listProperties(java.lang.String analysis) throws PHXServerSideException ``` @@ -1586,7 +1587,7 @@ lists the properties of an analysis - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListMethodsRequest -``` +```java public java.lang.String sendListMethodsRequest(java.lang.String analysis) ``` Deprecated. @@ -1600,12 +1601,12 @@ sends a request to list the methods of an analysis - the id for the response ### getListMethodsResponse -``` +```java public PHXMethodDescriptor[] getListMethodsResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1624,7 +1625,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listMethods -``` +```java public PHXMethodDescriptor[] listMethods(java.lang.String analysis) throws PHXServerSideException ``` @@ -1642,7 +1643,7 @@ lists the methods of an analysis - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendInvokeRequest -``` +```java public java.lang.String sendInvokeRequest(java.lang.String method) ``` Deprecated. @@ -1656,7 +1657,7 @@ sends a request to invoke a method - the id for the response ### getInvokeResponse -``` +```java public java.lang.String getInvokeResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1680,7 +1681,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### invoke -``` +```java public java.lang.String invoke(java.lang.String method) throws PHXServerSideException ``` @@ -1698,19 +1699,19 @@ invokes a method - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListValuesRequest -``` +```java public java.lang.String sendListValuesRequest(java.lang.String analysis) ``` Deprecated. ### sendListValuesURLRequest -``` +```java public java.lang.String sendListValuesURLRequest(java.lang.String analysis) ``` Deprecated. ### getListValuesResponse -``` +```java public PHXPropertyValue[] getListValuesResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1729,7 +1730,7 @@ Deprecated. - `java.lang.NumberFormatException` ### listValues -``` +```java public PHXPropertyValue[] listValues(java.lang.String analysis) throws PHXServerSideException, java.io.IOException @@ -1741,13 +1742,13 @@ Deprecated. - `java.io.IOException` ### sendListArrayValuesRequest -``` +```java public java.lang.String sendListArrayValuesRequest(java.lang.String analysis) ``` Deprecated. ### getListArrayValuesResponse -``` +```java public java.lang.String[] getListArrayValuesResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1760,7 +1761,7 @@ Deprecated. - `PHXNoSuchResponseException` ### listArrayValues -``` +```java public java.lang.String[] listArrayValues(java.lang.String analysis) throws PHXServerSideException, java.io.IOException @@ -1772,7 +1773,7 @@ Deprecated. - `java.io.IOException` ### sendListCategoriesRequest -``` +```java public java.lang.String sendListCategoriesRequest(java.lang.String category) ``` Deprecated. @@ -1786,12 +1787,12 @@ sends a request to list the categories - the id for the response ### getListCategoriesResponse -``` +```java public java.lang.String[] getListCategoriesResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1810,7 +1811,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### listCategories -``` +```java public java.lang.String[] listCategories(java.lang.String category) throws PHXServerSideException ``` @@ -1828,7 +1829,7 @@ lists the categories within a category - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendListRequest -``` +```java public java.lang.String sendListRequest() ``` Deprecated. @@ -1839,7 +1840,7 @@ sends a request to list the running objects - the id for the response ### getListResponse -``` +```java public java.lang.String[] getListResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1863,7 +1864,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### list -``` +```java public java.lang.String[] list() throws PHXServerSideException ``` @@ -1878,7 +1879,7 @@ lists the running objects - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendGetHierarchyRequest -``` +```java public java.lang.String sendGetHierarchyRequest(java.lang.String analysis) ``` Deprecated. @@ -1892,7 +1893,7 @@ sends a request to retrieve a hierarchy for a component - the id for the response ### sendGetHierarchyRequest -``` +```java public java.lang.String sendGetHierarchyRequest(java.lang.String analysis, com.phoenix_int.aserver.client.PHXHierarchyFileMode fileMode) ``` @@ -1908,7 +1909,7 @@ sends a request to retrieve a hierarchy for a component - the id for the response ### getGetHierarchyResponse -``` +```java public PHXStringBuffer getGetHierarchyResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -1932,9 +1933,9 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getHierarchy -``` +```java public PHXStringBuffer getHierarchy(java.lang.String analysis) - throws PHXServerSideException + throws PHXServerSideException ``` Deprecated. @@ -1950,7 +1951,7 @@ retrievethe hierarchy for the component - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendSetHierarchyRequest -``` +```java public java.lang.String sendSetHierarchyRequest(java.lang.String analysis, PHXStringBuffer xml) ``` @@ -1966,12 +1967,12 @@ Sends a request to set a hierarchy for a component - the id for the response ### getSetHierarchyResponse -``` +```java public java.lang.String getSetHierarchyResponse(java.lang.String id, boolean wait) - throws PHXResponseTypeMismatchException, - PHXNoSuchResponseException, - PHXServerSideException + throws PHXResponseTypeMismatchException, + PHXNoSuchResponseException, + PHXServerSideException ``` Deprecated. @@ -1990,7 +1991,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### setHierarchy -``` +```java public java.lang.String setHierarchy(java.lang.String analysis, PHXStringBuffer xml) throws PHXServerSideException @@ -2010,7 +2011,7 @@ Sends a request to set a hierarchy for a component - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendDeleteRunShareRequest -``` +```java public java.lang.String sendDeleteRunShareRequest(java.lang.Long key) ``` Deprecated. @@ -2024,7 +2025,7 @@ Sends a request to delete a runShare - the id for the response ### getDeleteRunShareResponse -``` +```java public java.lang.String getDeleteRunShareResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -2048,7 +2049,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### deleteRunShare -``` +```java public java.lang.String deleteRunShare(java.lang.Long key) throws PHXServerSideException ``` @@ -2060,7 +2061,7 @@ Handle cleaning up a runShare in a local client - PHXServerSideException ### sendGetIconRequest -``` +```java public java.lang.String sendGetIconRequest(java.lang.String analysis) ``` Deprecated. @@ -2074,7 +2075,7 @@ sends a request to retrieve an icon - the id for the response ### getGetIconResponse -``` +```java public PHXIcon getGetIconResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -2098,7 +2099,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getIcon -``` +```java public PHXIcon getIcon(java.lang.String analysis) throws PHXServerSideException ``` @@ -2116,7 +2117,7 @@ retrieves an icon for an analysis - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendSetDictionaryRequest -``` +```java public java.lang.String sendSetDictionaryRequest(java.lang.String dictionary) ``` Deprecated. @@ -2130,7 +2131,7 @@ sends a request to set a dictionary - the id for the response ### getSetDictionaryResponse -``` +```java public java.lang.String getSetDictionaryResponse(java.lang.String id, boolean wait) throws PHXResponseTypeMismatchException, @@ -2154,7 +2155,7 @@ retrieves a response from the server - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### setDictionary -``` +```java public java.lang.String setDictionary(java.lang.String dictionary) throws PHXServerSideException ``` @@ -2172,7 +2173,7 @@ Tries to set the dictionary by sending a set dictionary request. - [`PHXServerSideException`](PHXServerSideException.md) - thrown if something goes wrong. The exception message will contain the response from the server ### sendArbitraryRequest -``` +```java public java.lang.String sendArbitraryRequest(java.lang.String request) ``` Deprecated. @@ -2186,7 +2187,7 @@ sends an arbitrary request to the server - the id for the response ### sendArbitraryRequest -``` +```java public java.lang.String sendArbitraryRequest(PHXStringBuffer request) ``` Deprecated. @@ -2200,7 +2201,7 @@ sends an arbitrary request to the server - the id for the response ### getResponseAsText -``` +```java public java.lang.String getResponseAsText(java.lang.String id, int type, boolean wait) @@ -2226,7 +2227,7 @@ retrieves a low-level response from the server in String format. - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### getResponseAsPHXStringBuffer -``` +```java public PHXStringBuffer getResponseAsPHXStringBuffer(java.lang.String id, int type, boolean wait) @@ -2252,7 +2253,7 @@ retrieves a low-level response from the server in String format. - [`PHXServerSideException`](PHXServerSideException.md) - thrown if the the server returned an error ### main -``` +```java 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 index 5e4b1c55c7..9a1198b22e 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 @@ -47,7 +47,7 @@ This class is an event for the [`PHXAnalysisClient`](PHXAnalysisClient.md) class ## Method Detail ### getResponse -``` +```java public com.phoenix_int.aserver.client.PHXResponse getResponse() ``` retrieves the response 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 145b6f78f3..3cae0e768b 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 @@ -46,7 +46,7 @@ This class is an event for the [`PHXAnalysisClient`](PHXAnalysisClient.md) class ## Method Detail ### getException -``` +```java public java.lang.Exception getException() ``` retrieves the Exception object 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 index 9eb249b130..e80f7ee879 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXNoSuchResponseException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXNoSuchResponseException.md @@ -42,7 +42,7 @@ An exception that is thrown when an invalid response is specified. ## Method Detail ### getInvalidID -``` +```java public java.lang.String getInvalidID() ``` retrieves the id that didn't have a response 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 index fcb4ad7fb4..0cb0190a7e 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXPropertyValue.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXPropertyValue.md @@ -63,12 +63,12 @@ public PHXPropertyValue() ``` ### PHXPropertyValue -``` +```java public PHXPropertyValue(PHXPropertyValue val) ``` ### PHXPropertyValue -``` +```java public PHXPropertyValue(PHXPropertyDescriptor prop, java.lang.String val) ``` @@ -76,6 +76,6 @@ public PHXPropertyValue(PHXPropertyDescriptor prop, ## Method Detail ### getValue -``` +```java 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 index a9049520dc..464e8a479d 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md @@ -43,7 +43,7 @@ An exception that is thrown when an invalid response is specified. ## Method Detail ### getInvalidID -``` +```java public java.lang.String getInvalidID() ``` retrieves the id that didn't have a response 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 index 00d97a7996..b36d90ed39 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXServerSideException.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/client/PHXServerSideException.md @@ -44,7 +44,7 @@ An exception that is thrown when an error is returned from the server. ## Constructor Detail ### PHXServerSideException -``` +```java public PHXServerSideException(java.lang.String msg) ``` Constructor 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 86796ee4fb..4dda9f1976 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 @@ -12,7 +12,7 @@ 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. -> **Deprecated**: It is preferred to use `IPHXFactory2`, as this class has methods that can leak resources. +**Deprecated**: It is preferred to use `IPHXFactory2`, as this class has methods that can leak resources. ## Method Summary @@ -32,7 +32,7 @@ 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. +**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. @@ -60,7 +60,7 @@ IPHXComponent instantiate(java.io.File dir, 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 @@ -92,7 +92,7 @@ PHXComponentDescription describe(java.io.File dir, java.net.MalformedURLException ``` -> **Deprecated.** Describes the specified component. Should throw `ClassNotFoundException` if unable to handle/parse the given file. +**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. @@ -120,7 +120,7 @@ java.io.File getFileFor(java.io.File dir, 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 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 55beb08b62..3085a41d80 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 @@ -43,7 +43,7 @@ This extends the [`IPHXLibrarian`](IPHXLibrarian.md) interface to include versio ```java java.lang.String getBranchesAndTags() - throws java.lang.Exception + throws java.lang.Exception ``` **Deprecated.** Fetches a list of all branches and tags. 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 fc4052198a..68111a43aa 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 @@ -105,8 +105,8 @@ Delete all the temp directories ```java public java.util.Collection listComponents(java.lang.String virtualDir) - throws PHXNoSuchCategoryException, - com.phoenix_int.aserver.security.PHXAccessDeniedException + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException ``` Returns the components in a specific directory @@ -127,8 +127,8 @@ Returns the components in a specific directory ```java public java.util.Collection listDirectories(java.lang.String virtualDir) - throws PHXNoSuchCategoryException, - com.phoenix_int.aserver.security.PHXAccessDeniedException + throws PHXNoSuchCategoryException, + com.phoenix_int.aserver.security.PHXAccessDeniedException ``` Lists available sub-directories for the specified path @@ -152,15 +152,15 @@ 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 + 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. @@ -190,15 +190,15 @@ Creates an instance of the specified component. ```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 + 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`](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. @@ -213,8 +213,8 @@ Creates an instance of the specified component. Typically a librarian will find - an instance of the specified component class **Throws:** -- `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.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` @@ -230,15 +230,15 @@ public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java. 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 + 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`](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. @@ -255,8 +255,8 @@ Creates an instance of the specified component. Typically a librarian will find - 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`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `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` @@ -270,15 +270,15 @@ Creates an instance of the specified component. Typically a librarian will find ```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 + 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`](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. @@ -293,8 +293,8 @@ Creates an instance of the specified component. Typically a librarian will find - 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`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `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` @@ -308,11 +308,11 @@ Creates an instance of the specified component. Typically a librarian will find ```java public PHXComponentBranch getComponentHistory(java.lang.String compClass, java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - PHXNoSuchCategoryException, - java.io.IOException + throws java.lang.ClassNotFoundException, + PHXNoSuchCategoryException, + java.io.IOException ``` -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. +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`](IPHXVersionedLibrarian.md) @@ -325,8 +325,8 @@ Gets all version information about a particular component. It is important that - 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`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- `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 @@ -334,13 +334,13 @@ Gets all version information about a particular component. It is important that ```java public PHXComponentDescription describe(java.lang.String compClass, java.lang.String virtualDir) - throws java.lang.ClassNotFoundException, - java.io.IOException, - PHXServerSideException, - java.net.MalformedURLException, - PHXNoSuchCategoryException + 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. **Specified by:** - `describe` in interface [`IPHXLibrarian`](IPHXLibrarian.md) @@ -354,7 +354,7 @@ Describes the specified component. TODO: Currently all descriptions come from th **Throws:** - `java.lang.ClassNotFoundException` - if the class is not found -- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the virtualDirName passed in is invalid +- [`PHXNoSuchCategoryException`](../PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid - `java.io.IOException` - [`PHXServerSideException`](../PHXServerSideException.md) - `java.net.MalformedURLException` @@ -364,7 +364,7 @@ Describes the specified component. TODO: Currently all descriptions come from th ```java public java.lang.String getQueues(java.lang.String compClass, java.lang.String virtualDir) - throws java.lang.Exception + throws java.lang.Exception ``` Method for getting Queues from CenterLink, MCRE just returns blank string @@ -379,8 +379,8 @@ Method for getting Queues from CenterLink, MCRE just returns blank string - a list of queues for the specified component class **Throws:** -- [`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 +- [`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 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 8bf2857144..618e326482 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 @@ -55,14 +55,14 @@ This class implements a librarian that uses a directory on disk to store and ret ### directory -``` +```java private java.io.File directory ``` The directory used by this librarian. ### categories -``` +```java private java.util.Map categories ``` Map of categories managed by this librarian. @@ -71,7 +71,7 @@ Map of categories managed by this librarian. ### PHXDirectoryLibrarian -``` +```java public PHXDirectoryLibrarian(java.io.File directory) ``` @@ -82,7 +82,7 @@ public PHXDirectoryLibrarian(java.io.File directory) ### addFile -``` +```java public void addFile(java.io.File file) ``` Adds a file to the directory. @@ -92,7 +92,7 @@ Adds a file to the directory. ### removeFile -``` +```java public void removeFile(java.io.File file) ``` Removes a file from the directory. @@ -102,7 +102,7 @@ Removes a file from the directory. ### findFile -``` +```java public java.io.File findFile(java.lang.String name) ``` Finds a file by name. @@ -115,7 +115,7 @@ Finds a file by name. ### addCategory -``` +```java public void addCategory(java.lang.String category) ``` Adds a category. @@ -125,7 +125,7 @@ Adds a category. ### removeCategory -``` +```java public void removeCategory(java.lang.String category) ``` Removes a category. @@ -135,7 +135,7 @@ Removes a category. ### listCategories -``` +```java public java.util.List listCategories() ``` Lists all categories. @@ -145,8 +145,9 @@ Lists all categories. ### addAssociation -``` -public void addAssociation(java.lang.String key, java.lang.String value) +```java +public void addAssociation(java.lang.String key, + java.lang.String value) ``` Adds an association. @@ -156,7 +157,7 @@ Adds an association. ### removeAssociation -``` +```java public void removeAssociation(java.lang.String key) ``` Removes an association. @@ -166,7 +167,7 @@ Removes an association. ### findAssociation -``` +```java public java.lang.String findAssociation(java.lang.String key) ``` Finds an association by key. @@ -177,7 +178,3 @@ Finds an association by key. **Returns:** - 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/PHXUserDirLibrarian.md b/2025R2/modelCenter_java_api/com/phoenix_int/aserver/library/PHXUserDirLibrarian.md index 190b0c0d43..dc469f5857 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 @@ -204,7 +204,7 @@ public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java. java.lang.String virtualDir, java.lang.String connector, java.lang.String queue) - throws java.lang.Exception + 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`](IPHXFactory.md). 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 b194684abc..ecdd387284 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 @@ -118,7 +118,7 @@ This class WAITS for the monitor to stop monitoring on the sub-thread before it ```java public void doMonitor() - throws java.io.IOException + throws java.io.IOException ``` Begin monitoring. Does not return until the monitor is halted. 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 936129f944..c237340097 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 @@ -66,7 +66,7 @@ The interface for Phoenix types which use [PHXStringBuffer](../util/PHXStringBuf ```java PHXStringBuffer toString2() - throws java.io.IOException + throws java.io.IOException ``` Gets a [PHXStringBuffer](../util/PHXStringBuffer.md) representation of the type @@ -80,7 +80,7 @@ Gets a [PHXStringBuffer](../util/PHXStringBuffer.md) representation of the type ```java void fromString2(PHXStringBuffer sb) - throws java.io.IOException, PHXGetByUrlException + throws java.io.IOException, PHXGetByUrlException ``` Configures the type based on a [PHXStringBuffer](../util/PHXStringBuffer.md) representation of the type 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 902aa9e816..ecb7dec01b 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 @@ -110,7 +110,9 @@ public void setBlue(double v) ### setColor ```java -public void setColor(double r, double g, double b) +public void setColor(double r, + double g, + double b) ``` **Parameters:** 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 cfcc7ee788..cc0bafe897 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 @@ -207,7 +207,7 @@ Indicates whether the object should accept bad values in the `fromString()` meth ```java public boolean equalsNatural(PHXSimpleType toCompare) - throws PHXTypeMismatchException + throws PHXTypeMismatchException ``` 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. 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 f943db9b27..39515c7482 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 @@ -22,7 +22,7 @@ public class PHXBooleanArray extends PHXSimpleArray ``` -Class wraps an array of PHXBoolean variables for the ScriptWrapper utility. +Class wraps an array of [PHXBoolean](PHXBoolean.md) variables for the ScriptWrapper utility. ## Nested Class Summary @@ -111,7 +111,8 @@ Description copied from class: [`PHXSimpleArray`](PHXSimpleArray.md). Must overr ```java protected java.lang.Object allocateElement(java.lang.Class elementClass) - throws java.lang.IllegalAccessException, java.lang.InstantiationException + throws java.lang.IllegalAccessException, + java.lang.InstantiationException ``` 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. @@ -174,7 +175,8 @@ Gets the value of an element as a boolean. ### 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. @@ -189,7 +191,8 @@ Sets the value of an element as a PHXBoolean object. ### 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. @@ -204,7 +207,8 @@ Sets the value of an element as a boolean. ### 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. @@ -231,7 +235,7 @@ 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`](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [`PHXInvalidTypeException`](PHXInvalidTypeException.md. +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. 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 bacc5232dd..d3e0c4b1ea 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 @@ -24,7 +24,7 @@ extends PHXSimpleType implements IPHXFormat ``` -The Phoenix type for doubles. This class adds the following features to the [PHXSimpleType](PHXSimpleType.md): +The 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 @@ -323,7 +323,8 @@ Converts a PHXStringBuffer representation to the internal value. ### 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. @@ -350,7 +351,7 @@ Converts a String representation to the internal value. ```java public java.lang.String toString(int width) - throws PHXNumberFormatException + throws PHXNumberFormatException ``` Converts the value to a string with the best possible formatting, e.g. scientific or absolute values based on the width available. @@ -515,7 +516,7 @@ public static java.lang.String arrayToString(double[] sa) ```java public boolean equalsNatural(PHXSimpleType toCompare) - throws PHXTypeMismatchException + throws PHXTypeMismatchException ``` 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. @@ -538,7 +539,7 @@ NOTE: two PHXDoubles are considered naturally equal if they are the same to with ```java public void fromObject(java.lang.Object toRead) - throws PHXInvalidTypeException + 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](PHXInvalidTypeException.md). If there is an error in conversion, it will also throw a [PHXInvalidTypeException](PHXInvalidTypeException.md). 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 0da9296244..4760f070a0 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 @@ -145,7 +145,8 @@ Must override this function and return true if the specified class is acceptable ```java protected java.lang.Object allocateElement(java.lang.Class elementClass) - throws java.lang.IllegalAccessException, java.lang.InstantiationException + throws java.lang.IllegalAccessException, + java.lang.InstantiationException ``` Description copied from class: [PHXSimpleArray](PHXSimpleArray.md) 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 30bf50b4cb..cd79b10eac 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 @@ -24,7 +24,7 @@ public class PHXFile extends PHXSimpleType ``` -Deprecated. +**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. 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 dc81a19dcf..352a980e64 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 @@ -17,7 +17,7 @@ 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. +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 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 00482e00a9..b258111cc4 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 @@ -24,9 +24,9 @@ extends PHXSimpleType implements IPHXFormat ``` -**THIS CLASS IS DEPRECATED IN FAVOR OF PHXLong** +**THIS CLASS IS DEPRECATED IN FAVOR OF [PHXLong](PHXLong.md)** -The Phoenix type for integers. This class adds the following features to the PHXSimpleType: +The type for integers. This class adds the following features to the [`PHXSimpleType`](PHXSimpleType.md): - **value**: int - **valueStr**: the source string for the value, useful for error checking when the value is NaN 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 1545e19dc4..7a54ee37ae 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 @@ -23,7 +23,7 @@ extends PHXSimpleType implements IPHXFormat ``` -The Phoenix type for longs. This class adds the following features to the [`PHXSimpleType`](PHXSimpleType.md): +The 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 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 de2e81cd6d..06e382a38b 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 @@ -12,7 +12,7 @@ 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. +This is a utility class for holding mass property information. The class is used by the [PHXGeomInfo](PHXGeomInfo.md) class. ## Constructor Summary 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 edd606919a..9390dddf8f 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 @@ -20,7 +20,7 @@ public class PHXRawFileArray extends PHXSimpleArray ``` -Wraps an array of PHXRawFile variables for the ScriptWrapper utility. +Wraps an array of [PHXRawFile](PHXRawFile.md) variables for the ScriptWrapper utility. **See Also:** 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 c82a7b4c81..a49bd5ef79 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 @@ -20,14 +20,9 @@ implements IPHXAlwaysWriteable, 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 +- **value**: double +- **properties**: PHXRefProperty[] +- **reference**: String ## Nested Class Summary 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 addb3e8c05..ba6db8f5f2 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 @@ -159,7 +159,7 @@ Constructs a PHXSimpleArray that wraps a particular ModelCenter Remote Execution protected PHXSimpleArray() ``` Default Constructor -============ METHOD DETAIL ========== + ### Method Detail ### copy 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 54520cf798..3c9fa8a3f8 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 @@ -18,7 +18,7 @@ public class PHXStringArray extends PHXSimpleArray ``` -Class wraps an array of PHXString variables for the ScriptWrapper utility. +Class wraps an array of [PHXString](PHXString.md) variables for the ScriptWrapper utility. **See Also:** 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 3a2ee9b9db..63426dd1ff 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 @@ -18,7 +18,7 @@ A class for creating variables **See Also:** -- [PHXSimpleType](PHXSimpleType.md)- +- [PHXSimpleType](PHXSimpleType.md) ## Field Summary @@ -262,7 +262,7 @@ Allocate a given variable for the given type string ```java @Deprecated public static IPHXType2 allocateVariable(java.lang.String type) - throws PHXInvalidTypeException + throws PHXInvalidTypeException ``` **Deprecated.** Prefer `allocateVariable2(java.lang.String)` which can properly differentiate between arrays and non-array types. @@ -282,7 +282,7 @@ Creates a variable from a type string ```java @Deprecated public static PHXSimpleArray allocateArray(java.lang.String arrayType) - throws PHXInvalidTypeException + throws PHXInvalidTypeException ``` **Deprecated.** Prefer `allocateVariable2(java.lang.String)` which can properly differentiate between arrays and non-array types. 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 index ecdef15cf4..3efc925c20 100644 --- 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 @@ -14,7 +14,7 @@ ```java public class PHXBookmark - extends java.lang.Object +extends java.lang.Object ``` ## Field Summary 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 56398df93b..b81437e0b5 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 @@ -184,14 +184,16 @@ Defaults to [ParseableFile.Mode.GENERATE](ParseableFile.Mode.md) ### PHXRowFieldFile ```java -public PHXRowFieldFile(PHXScriptWrapperObject wrapper, ParseableFile.Mode mode) +public PHXRowFieldFile(PHXScriptWrapperObject wrapper, + ParseableFile.Mode mode) ``` ### PHXRowFieldFile ```java @Deprecated -public PHXRowFieldFile(PHXScriptWrapperObject wrapper, int mode) +public PHXRowFieldFile(PHXScriptWrapperObject wrapper, + int mode) ``` Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.Mode)](PHXRowFieldFile.md) @@ -202,7 +204,8 @@ Deprecated. in favor of [PHXRowFieldFile(PHXScriptWrapperObject, ParseableFile.M ### PHXRowFieldFile ```java -public PHXRowFieldFile(java.lang.String baseDirectory, int mode) +public PHXRowFieldFile(java.lang.String baseDirectory, + int mode) ``` Legacy (pre-QW) constructor. @@ -472,7 +475,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](ParseableFile.Mode.md) 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,13 +528,13 @@ 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](ParseableFile.Mode.md) 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 - `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 +- `fformat` - The fortran style format string to apply. Pass null for standard formatting. **Throws:** @@ -584,7 +587,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -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. +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 +620,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -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. +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 +655,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -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. +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 @@ -661,7 +664,7 @@ Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENER - `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](ParseableFile.Mode.md). -- `fformat` - The fortran style format string to apply. Pass null for standard formatting. +- `fformat` - The fortran style format string to apply. Pass null for standard formatting. **Throws:** - `java.io.IOException` @@ -689,7 +692,7 @@ public void transferArray(PHXSimpleArray var, java.lang.InstantiationException, PHXNumberFormatException ``` -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. +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 @@ -699,7 +702,7 @@ Transfers the data for a particular array. If mode is [ParseableFile.Mode.GENER - `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](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. +- `numDimensions` - The number of dimensions to read the array as. Must be 1 or 2. **Throws:** - `java.io.IOException` @@ -719,7 +722,7 @@ public void transferKeyVar(PHXSimpleType var, PHXNoSuchTokenException, PHXNumberFormatException ``` -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. +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,14 +748,14 @@ public void transferKeyVar(PHXSimpleType var, PHXNoSuchTokenException, PHXNumberFormatException ``` -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. +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 - `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. +- `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:** @@ -773,7 +776,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](ParseableFile.Mode.md), 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 +804,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](ParseableFile.Mode.md), 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 +833,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](ParseableFile.Mode.md), 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 +858,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](ParseableFile.Mode.md). +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 @@ -936,7 +939,7 @@ Searches for the specified string and makes the row where the string was found a **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) +- `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:** @@ -990,7 +993,7 @@ Searches for the specified string and makes the row where the string was found a **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) +- `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:** 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 bce8f24b3e..6e9a55c3d3 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 @@ -24,7 +24,7 @@ ```java public static enum ParseableFile.Mode - extends java.lang.Enum +extends java.lang.Enum ``` File mode. Moved to type-safe enum from legacy integer constants. 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 5f96b77d1f..7923908264 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 @@ -138,9 +138,9 @@ Generate a new parser for the given file and mode ```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 + 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 @@ -160,7 +160,7 @@ Allow a sub-class to form a parser using custom options/features, such as handli ```java public com.phoenix_int.aserver.util.XPathParser getParser() - throws java.io.IOException + throws java.io.IOException ``` Get the XPath parser 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 77b78a8dad..2632410082 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 @@ -226,7 +226,8 @@ java.lang.String[] getEnumAliases() ### setEnums ```java -void setEnums(java.lang.String[] enumAliases, java.lang.Object[] enumValues) +void setEnums(java.lang.String[] enumAliases, + java.lang.Object[] enumValues) ``` **Deprecated.** Set the names/aliases and corresponding values for the enumerated type diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md index c45f748af2..9db2485965 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXInternationalize.md @@ -79,7 +79,8 @@ public java.lang.String tr(java.lang.String id) ### tr ```java -public java.lang.String tr(java.lang.String id, java.lang.Object... args) +public java.lang.String tr(java.lang.String id, + java.lang.Object... args) ``` ### trLazy @@ -98,7 +99,8 @@ Return a lazily instantiated translation message that can be computed only if ne ### trLazy ```java -public PHXInternationalize.InternationalizedMessage trLazy(java.lang.String id, java.lang.Object... args) +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. diff --git a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md index bb350d7d76..862c06e9f6 100644 --- a/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md +++ b/2025R2/modelCenter_java_api/com/phoenix_int/util/PHXNewLineFilter.md @@ -81,7 +81,9 @@ public void close() ### read ```java -public int read(char[] cbuf, int off, int len) +public int read(char[] cbuf, + int off, + int len) throws java.io.IOException ``` diff --git a/2025R2/modelCenter_java_api/constant-values.md b/2025R2/modelCenter_java_api/constant-values.md index 8ade7a0579..e94876e57d 100644 --- a/2025R2/modelCenter_java_api/constant-values.md +++ b/2025R2/modelCenter_java_api/constant-values.md @@ -1,19 +1,17 @@ # Constant field values -## Contents +**Contents**: `com.phoenix_int.*` -- com.phoenix_int.* +com.phoenix_int.* -## com.phoenix_int.* - -### com.phoenix_int.aserver.PHXComponentDescription +## 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 +## com.phoenix_int.aserver.PHXRunShare | Modifier and Type | Constant Field | Value | | --- | --- | --- | | `public static final int` | `DEL_AUTO` | `14` | @@ -24,7 +22,7 @@ | `public static final int` | `MODE_SHARE` | `3` | | `public static final int` | `MODE_WAIT` | `2` | -### com.phoenix_int.aserver.client.PHXAnalysisClient +## com.phoenix_int.aserver.client.PHXAnalysisClient | Modifier and Type | Constant Field | Value | | --- | --- | --- | | `public static final int` | `ADD_PROXY_CLIENTS_REQUEST` | `18` | @@ -53,7 +51,7 @@ | `public static final int` | `SET_REQUEST` | `4` | | `public static final int` | `START_REQUEST` | `1` | -### com.phoenix_int.aserver.types.PHXTypeFactory +## com.phoenix_int.aserver.types.PHXTypeFactory | Modifier and Type | Constant Field | Value | | --- | --- | --- | | `public static final java.lang.String` | `BOOLEAN` | `"boolean"` | @@ -73,12 +71,12 @@ | `public static final java.lang.String` | `UNKNOWN` | `"UNKNOWN"` | | `public static final java.lang.String` | `UNKNOWN_ARRAY` | `"UNKNOWN[]"` | -### com.phoenix_int.aserver.util.Parser.Mode +## 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 +## com.phoenix_int.aserver.util.PHXFileParser | Modifier and Type | Constant Field | Value | | --- | --- | --- | | `public static final long` | `FILE_SIZE_LIMIT` | `500000L` | @@ -87,38 +85,38 @@ | `public static final int` | `RESIZE_DISALLOW` | `23` | | `public static final int` | `RESIZE_ROWS` | `24` | -### com.phoenix_int.aserver.util.PHXRuntime +## 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 +## 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 +## 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 +## 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 +## 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 +## 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 +## 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/overview-summary.md b/2025R2/modelCenter_java_api/overview-summary.md index 9d920bf757..3312a5daa4 100644 --- a/2025R2/modelCenter_java_api/overview-summary.md +++ b/2025R2/modelCenter_java_api/overview-summary.md @@ -3,20 +3,13 @@ | Package | Description | | --- | --- | | [com.phoenix_int.aserver](com/phoenix_int/aserver/package-summary.md) | | -| [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](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](com/phoenix_int/aserver/client/v2/package-summary.md) | | -| [com.phoenix_int.aserver.library](com/phoenix_int/aserver/library/package-summary.md) | 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.md) | Provides interfaces and classes for adding process and output monitoring -of components. | -| [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.library](com/phoenix_int/aserver/library/package-summary.md) | 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.md) | Provides interfaces and classes for adding process and output monitoring of components. | +| [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](com/phoenix_int/aserver/util/package-summary.md) | Provides general purpose utility functions. | -| [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](com/phoenix_int/pacz/api/package-summary.md) | 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.md) | PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products Analysis - Server and ModelCenter Server. | +| [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](com/phoenix_int/pacz/api/package-summary.md) | PACZ (extension .pacz) is a universal component/workflow format for use in the Phoenix Integration products ModelCenter Remote Execution and ModelCenter Server. | +| [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 the Phoenix Integration products ModelCenter Remote Execution and ModelCenter Server. | | [com.phoenix_int.util](com/phoenix_int/util/package-summary.md) | | \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/overview-tree.md b/2025R2/modelCenter_java_api/overview-tree.md index 4704bcf7e2..d7184c41d7 100644 --- a/2025R2/modelCenter_java_api/overview-tree.md +++ b/2025R2/modelCenter_java_api/overview-tree.md @@ -16,133 +16,133 @@ ## Class hierarchy - java.lang.Object -- com.phoenix_int.aserver.util.scriptwrapper.api.[AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) (implements java.io.Closeable, com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)) -- com.phoenix_int.aserver.util.scriptwrapper.api.[CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)) -- com.phoenix_int.aserver.util.scriptwrapper.api.[XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)) -- 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.md) -- com.phoenix_int.pacz.api.v2.[Environment](com/phoenix_int/pacz/api/v2/Environment.md) -- com.phoenix_int.aserver.client.v2.[AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md) (implements java.lang.AutoCloseable) -- com.phoenix_int.aserver.client.v2.[AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md) -- com.phoenix_int.aserver.client.v2.[AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md) (implements java.lang.Comparable``) -- com.phoenix_int.aserver.client.v2.[AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md) (implements com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md)) -- com.phoenix_int.aserver.client.v2.[AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md) -- com.phoenix_int.util.[BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) -- java.util.EventObject (implements java.io.Serializable) -- com.phoenix_int.aserver.client.[PHXAnalysisClientEvent](com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md) -- com.phoenix_int.aserver.client.[PHXAnalysisClientExceptionEvent](com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md) -- com.phoenix_int.aserver.client.[PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md) -- com.phoenix_int.aserver.types.[PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) -- com.phoenix_int.util.[PHXBlocker](com/phoenix_int/util/PHXBlocker.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md)) -- com.phoenix_int.aserver.[PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md) -- com.phoenix_int.aserver.[PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) -- com.phoenix_int.aserver.[PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md) -- com.phoenix_int.aserver.library.[PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) -- com.phoenix_int.aserver.types.[PHXDataCollector](com/phoenix_int/aserver/types/PHXDataCollector.md) -- com.phoenix_int.aserver.library.[PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) -- com.phoenix_int.aserver.util.[PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md) -- com.phoenix_int.aserver.monitors.[PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md) -- com.phoenix_int.aserver.util.[PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md) -- com.phoenix_int.aserver.util.[PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) (implements com.phoenix_int.aserver.util.[Parser](com/phoenix_int/aserver/util/Parser.md)) -- com.phoenix_int.aserver.types.[PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.md) -- com.phoenix_int.aserver.[PHXGroup](com/phoenix_int/aserver/PHXGroup.md) -- com.phoenix_int.aserver.util.[PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md) -- com.phoenix_int.util.[PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md) -- com.phoenix_int.aserver.[PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md) -- com.phoenix_int.aserver.library.[PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) -- com.phoenix_int.aserver.library.[PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) -- com.phoenix_int.aserver.types.[PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) -- com.phoenix_int.aserver.[PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) -- com.phoenix_int.aserver.monitors.[PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md) -- com.phoenix_int.aserver.util.[PHXNameDivider](com/phoenix_int/aserver/util/PHXNameDivider.md) -- com.phoenix_int.aserver.types.[PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) -- com.phoenix_int.aserver.util.[PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md) -- com.phoenix_int.aserver.[PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) -- com.phoenix_int.aserver.client.[PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.md) -- com.phoenix_int.aserver.types.[PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)) -- com.phoenix_int.aserver.types.[PHXReference](com/phoenix_int/aserver/types/PHXReference.md) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.md), com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md)) -- com.phoenix_int.aserver.types.[PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.md)) -- com.phoenix_int.aserver.types.[PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md)) -- com.phoenix_int.aserver.[PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md) (implements com.phoenix_int.aserver.[IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.md), com.phoenix_int.aserver.trace.IPHXTraceGenerator) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRunShareContext](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md) -- com.phoenix_int.aserver.[PHXRunShare.RunInfo](com/phoenix_int/aserver/PHXRunShare.RunInfo.md) -- com.phoenix_int.aserver.util.[PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) (implements java.lang.Cloneable) -- com.phoenix_int.aserver.[PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md) (implements com.phoenix_int.aserver.[IPHXComponent](com/phoenix_int/aserver/IPHXComponent.md), com.phoenix_int.aserver.[IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.md)) -- com.phoenix_int.aserver.[PHXSimpleSelfManager2](com/phoenix_int/aserver/PHXSimpleSelfManager2.md) (implements com.phoenix_int.aserver.[IPHXSelfManager2](com/phoenix_int/aserver/IPHXSelfManager2.md)) -- com.phoenix_int.aserver.[PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.md) (implements com.phoenix_int.aserver.IPHXConnector, com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.md)) -- com.phoenix_int.aserver.types.[PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md) (implements com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md)) -- com.phoenix_int.aserver.types.[PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md) -- com.phoenix_int.aserver.types.[PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) -- com.phoenix_int.aserver.types.[PHXFile](com/phoenix_int/aserver/types/PHXFile.md) -- com.phoenix_int.aserver.types.[PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md) -- com.phoenix_int.aserver.types.[PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) -- com.phoenix_int.aserver.types.[PHXLong](com/phoenix_int/aserver/types/PHXLong.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) -- com.phoenix_int.aserver.types.[PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) (implements java.lang.AutoCloseable, com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md)) -- com.phoenix_int.aserver.types.[PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md) -- com.phoenix_int.aserver.types.[PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)`` (implements com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), java.lang.Iterable``) -- com.phoenix_int.aserver.types.[PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md) -- com.phoenix_int.aserver.types.[PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) -- com.phoenix_int.aserver.types.[PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) -- com.phoenix_int.aserver.types.[PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md) -- com.phoenix_int.aserver.types.[PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) -- com.phoenix_int.aserver.types.[PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) -- com.phoenix_int.aserver.types.[PHXString](com/phoenix_int/aserver/types/PHXString.md) -- com.phoenix_int.aserver.util.[PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md) (implements java.io.Serializable) -- com.phoenix_int.aserver.util.[PHXStringReplacer](com/phoenix_int/aserver/util/PHXStringReplacer.md) -- com.phoenix_int.aserver.util.[PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md) (implements java.util.Enumeration``) -- com.phoenix_int.aserver.types.[PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md) -- com.phoenix_int.aserver.library.[PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) -- com.phoenix_int.aserver.[PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md) -- java.lang.Process -- com.phoenix_int.aserver.util.[PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) (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.md) -- com.phoenix_int.util.[PHXNewLineFilter](com/phoenix_int/util/PHXNewLineFilter.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.md) -- java.io.IOException -- com.phoenix_int.aserver.monitors.[PHXFileMonitor.FileMonitorChangeException](com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md) -- com.phoenix_int.aserver.[ProcessHaltedException](com/phoenix_int/aserver/ProcessHaltedException.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmarkNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md) -- com.phoenix_int.aserver.[PHXDFTException](com/phoenix_int/aserver/PHXDFTException.md) -- com.phoenix_int.aserver.util.[PHXGetByUrlException](com/phoenix_int/aserver/util/PHXGetByUrlException.md) -- com.phoenix_int.aserver.[PHXInvalidNameException](com/phoenix_int/aserver/PHXInvalidNameException.md) -- com.phoenix_int.aserver.types.[PHXInvalidTypeException](com/phoenix_int/aserver/types/PHXInvalidTypeException.md) -- com.phoenix_int.aserver.[PHXNameAlreadyInUseException](com/phoenix_int/aserver/PHXNameAlreadyInUseException.md) -- com.phoenix_int.aserver.library.[PHXNoSuchAssociationException](com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md) -- com.phoenix_int.aserver.library.[PHXNoSuchCategoryException](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md) -- com.phoenix_int.aserver.library.[PHXNoSuchIconException](com/phoenix_int/aserver/library/PHXNoSuchIconException.md) -- com.phoenix_int.aserver.[PHXNoSuchObjectException](com/phoenix_int/aserver/PHXNoSuchObjectException.md) -- com.phoenix_int.aserver.[PHXNoSuchWriteableObjectException](com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md) -- com.phoenix_int.aserver.util.[PHXNoSuchReplacementException](com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md) -- com.phoenix_int.aserver.client.[PHXNoSuchResponseException](com/phoenix_int/aserver/client/PHXNoSuchResponseException.md) -- com.phoenix_int.aserver.util.[PHXNoSuchTokenException](com/phoenix_int/aserver/util/PHXNoSuchTokenException.md) -- com.phoenix_int.aserver.types.[PHXNumberFormatException](com/phoenix_int/aserver/types/PHXNumberFormatException.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperAPIException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSectionNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md) -- com.phoenix_int.aserver.client.[PHXServerSideException](com/phoenix_int/aserver/client/PHXServerSideException.md) -- com.phoenix_int.aserver.types.[PHXTypeMismatchException](com/phoenix_int/aserver/types/PHXTypeMismatchException.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[PHXVersionException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md) -- java.lang.ReflectiveOperationException -- java.lang.ClassNotFoundException -- com.phoenix_int.aserver.util.[PHXClassNotFoundException](com/phoenix_int/aserver/util/PHXClassNotFoundException.md) -- java.lang.RuntimeException -- com.phoenix_int.aserver.client.[PHXResponseTypeMismatchException](com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md) -- 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.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[AbstractFile](com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md) (implements java.io.Closeable, com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[CAEOutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldFile](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[XPathFile](com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md), com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md)) + - 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.md) + - com.phoenix_int.pacz.api.v2.[Environment](com/phoenix_int/pacz/api/v2/Environment.md) + - com.phoenix_int.aserver.client.v2.[AnalysisServerClient](com/phoenix_int/aserver/client/v2/AnalysisServerClient.md) (implements java.lang.AutoCloseable) + - com.phoenix_int.aserver.client.v2.[AnalysisServerResponse](com/phoenix_int/aserver/client/v2/AnalysisServerResponse.md) + - com.phoenix_int.aserver.client.v2.[AnalysisServerVersion](com/phoenix_int/aserver/client/v2/AnalysisServerVersion.md) (implements java.lang.Comparable``) + - com.phoenix_int.aserver.client.v2.[AnalysisServerWaitCallback](com/phoenix_int/aserver/client/v2/AnalysisServerWaitCallback.md) (implements com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md)) + - com.phoenix_int.aserver.client.v2.[AnalysisVariableValue](com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md) + - com.phoenix_int.util.[BufferedRandomAccessFile](com/phoenix_int/util/BufferedRandomAccessFile.md) + - java.util.EventObject (implements java.io.Serializable) + - com.phoenix_int.aserver.client.[PHXAnalysisClientEvent](com/phoenix_int/aserver/client/PHXAnalysisClientEvent.md) + - com.phoenix_int.aserver.client.[PHXAnalysisClientExceptionEvent](com/phoenix_int/aserver/client/PHXAnalysisClientExceptionEvent.md) + - com.phoenix_int.aserver.client.[PHXAnalysisClient](com/phoenix_int/aserver/client/PHXAnalysisClient.md) + - com.phoenix_int.aserver.types.[PHXAppearance](com/phoenix_int/aserver/types/PHXAppearance.md) + - com.phoenix_int.util.[PHXBlocker](com/phoenix_int/util/PHXBlocker.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmark](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXCAERange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md)) + - com.phoenix_int.aserver.[PHXComponentBranch](com/phoenix_int/aserver/PHXComponentBranch.md) + - com.phoenix_int.aserver.[PHXComponentDescription](com/phoenix_int/aserver/PHXComponentDescription.md) + - com.phoenix_int.aserver.[PHXComponentVersion](com/phoenix_int/aserver/PHXComponentVersion.md) + - com.phoenix_int.aserver.library.[PHXCVSLibrarian](com/phoenix_int/aserver/library/PHXCVSLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) + - com.phoenix_int.aserver.types.[PHXDataCollector](com/phoenix_int/aserver/types/PHXDataCollector.md) + - com.phoenix_int.aserver.library.[PHXDirectoryLibrarian](com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) + - com.phoenix_int.aserver.util.[PHXFileLoader](com/phoenix_int/aserver/util/PHXFileLoader.md) + - com.phoenix_int.aserver.monitors.[PHXFileMonitor](com/phoenix_int/aserver/monitors/PHXFileMonitor.md) + - com.phoenix_int.aserver.util.[PHXFileName](com/phoenix_int/aserver/util/PHXFileName.md) + - com.phoenix_int.aserver.util.[PHXFileParser](com/phoenix_int/aserver/util/PHXFileParser.md) (implements com.phoenix_int.aserver.util.[Parser](com/phoenix_int/aserver/util/Parser.md)) + - com.phoenix_int.aserver.types.[PHXGeomInfo](com/phoenix_int/aserver/types/PHXGeomInfo.md) + - com.phoenix_int.aserver.[PHXGroup](com/phoenix_int/aserver/PHXGroup.md) + - com.phoenix_int.aserver.util.[PHXIcon](com/phoenix_int/aserver/util/PHXIcon.md) + - com.phoenix_int.util.[PHXInternationalize](com/phoenix_int/util/PHXInternationalize.md) + - com.phoenix_int.aserver.[PHXInvokeReturn](com/phoenix_int/aserver/PHXInvokeReturn.md) + - com.phoenix_int.aserver.library.[PHXLibrarianCombiner](com/phoenix_int/aserver/library/PHXLibrarianCombiner.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) + - com.phoenix_int.aserver.library.[PHXLibrarianMounter](com/phoenix_int/aserver/library/PHXLibrarianMounter.md) (implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3) + - com.phoenix_int.aserver.types.[PHXMassProperties](com/phoenix_int/aserver/types/PHXMassProperties.md) + - com.phoenix_int.aserver.[PHXMethodDescriptor](com/phoenix_int/aserver/PHXMethodDescriptor.md) + - com.phoenix_int.aserver.monitors.[PHXMonitorableStream](com/phoenix_int/aserver/monitors/PHXMonitorableStream.md) + - com.phoenix_int.aserver.util.[PHXNameDivider](com/phoenix_int/aserver/util/PHXNameDivider.md) + - com.phoenix_int.aserver.types.[PHXOrientation](com/phoenix_int/aserver/types/PHXOrientation.md) + - com.phoenix_int.aserver.util.[PHXProcessInfo](com/phoenix_int/aserver/util/PHXProcessInfo.md) + - com.phoenix_int.aserver.[PHXPropertyDescriptor](com/phoenix_int/aserver/PHXPropertyDescriptor.md) + - com.phoenix_int.aserver.client.[PHXPropertyValue](com/phoenix_int/aserver/client/PHXPropertyValue.md) + - com.phoenix_int.aserver.types.[PHXRefArrayProperty](com/phoenix_int/aserver/types/PHXRefArrayProperty.md) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)) + - com.phoenix_int.aserver.types.[PHXReference](com/phoenix_int/aserver/types/PHXReference.md) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.md), com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md)) + - com.phoenix_int.aserver.types.[PHXReferenceArray](com/phoenix_int/aserver/types/PHXReferenceArray.md) (implements com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.md)) + - com.phoenix_int.aserver.types.[PHXRefProperty](com/phoenix_int/aserver/types/PHXRefProperty.md) (implements com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md)) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRowFieldRange](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md) (implements com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md)) + - com.phoenix_int.aserver.[PHXRunShare](com/phoenix_int/aserver/PHXRunShare.md) (implements com.phoenix_int.aserver.[IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.md), com.phoenix_int.aserver.trace.IPHXTraceGenerator) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXRunShareContext](com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md) + - com.phoenix_int.aserver.[PHXRunShare.RunInfo](com/phoenix_int/aserver/PHXRunShare.RunInfo.md) + - com.phoenix_int.aserver.util.[PHXRuntime](com/phoenix_int/aserver/util/PHXRuntime.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperObject](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md) (implements java.lang.Cloneable) + - com.phoenix_int.aserver.[PHXSimpleSelfManager](com/phoenix_int/aserver/PHXSimpleSelfManager.md) (implements com.phoenix_int.aserver.[IPHXComponent](com/phoenix_int/aserver/IPHXComponent.md), com.phoenix_int.aserver.[IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.md)) + - com.phoenix_int.aserver.[PHXSimpleSelfManager2](com/phoenix_int/aserver/PHXSimpleSelfManager2.md) (implements com.phoenix_int.aserver.[IPHXSelfManager2](com/phoenix_int/aserver/IPHXSelfManager2.md)) + - com.phoenix_int.aserver.[PHXSimpleSelfManager3](com/phoenix_int/aserver/PHXSimpleSelfManager3.md) (implements com.phoenix_int.aserver.IPHXConnector, com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.md)) + - com.phoenix_int.aserver.types.[PHXSimpleType](com/phoenix_int/aserver/types/PHXSimpleType.md) (implements com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md)) + - com.phoenix_int.aserver.types.[PHXBoolean](com/phoenix_int/aserver/types/PHXBoolean.md) + - com.phoenix_int.aserver.types.[PHXDouble](com/phoenix_int/aserver/types/PHXDouble.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXFile](com/phoenix_int/aserver/types/PHXFile.md) + - com.phoenix_int.aserver.types.[PHXGeometry](com/phoenix_int/aserver/types/PHXGeometry.md) + - com.phoenix_int.aserver.types.[PHXInteger](com/phoenix_int/aserver/types/PHXInteger.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXLong](com/phoenix_int/aserver/types/PHXLong.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXRawFile](com/phoenix_int/aserver/types/PHXRawFile.md) (implements java.lang.AutoCloseable, com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md)) + - com.phoenix_int.aserver.types.[PHXScriptObject](com/phoenix_int/aserver/types/PHXScriptObject.md) + - com.phoenix_int.aserver.types.[PHXSimpleArray](com/phoenix_int/aserver/types/PHXSimpleArray.md)`` (implements com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), java.lang.Iterable``) + - com.phoenix_int.aserver.types.[PHXBooleanArray](com/phoenix_int/aserver/types/PHXBooleanArray.md) + - com.phoenix_int.aserver.types.[PHXDoubleArray](com/phoenix_int/aserver/types/PHXDoubleArray.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXLongArray](com/phoenix_int/aserver/types/PHXLongArray.md) (implements com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md)) + - com.phoenix_int.aserver.types.[PHXObjectArray](com/phoenix_int/aserver/types/PHXObjectArray.md) + - com.phoenix_int.aserver.types.[PHXRawFileArray](com/phoenix_int/aserver/types/PHXRawFileArray.md) + - com.phoenix_int.aserver.types.[PHXStringArray](com/phoenix_int/aserver/types/PHXStringArray.md) + - com.phoenix_int.aserver.types.[PHXString](com/phoenix_int/aserver/types/PHXString.md) + - com.phoenix_int.aserver.util.[PHXStringBuffer](com/phoenix_int/aserver/util/PHXStringBuffer.md) (implements java.io.Serializable) + - com.phoenix_int.aserver.util.[PHXStringReplacer](com/phoenix_int/aserver/util/PHXStringReplacer.md) + - com.phoenix_int.aserver.util.[PHXStringTokenizer](com/phoenix_int/aserver/util/PHXStringTokenizer.md) (implements java.util.Enumeration``) + - com.phoenix_int.aserver.types.[PHXTypeFactory](com/phoenix_int/aserver/types/PHXTypeFactory.md) + - com.phoenix_int.aserver.library.[PHXUserDirLibrarian](com/phoenix_int/aserver/library/PHXUserDirLibrarian.md) (implements com.phoenix_int.aserver.library.IPHXLibrarian2) + - com.phoenix_int.aserver.[PHXVariableInfo](com/phoenix_int/aserver/PHXVariableInfo.md) + - java.lang.Process + - com.phoenix_int.aserver.util.[PHXProcess](com/phoenix_int/aserver/util/PHXProcess.md) (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.md) + - com.phoenix_int.util.[PHXNewLineFilter](com/phoenix_int/util/PHXNewLineFilter.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.md) + - java.io.IOException + - com.phoenix_int.aserver.monitors.[PHXFileMonitor.FileMonitorChangeException](com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md) + - com.phoenix_int.aserver.[ProcessHaltedException](com/phoenix_int/aserver/ProcessHaltedException.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXBookmarkNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md) + - com.phoenix_int.aserver.[PHXDFTException](com/phoenix_int/aserver/PHXDFTException.md) + - com.phoenix_int.aserver.util.[PHXGetByUrlException](com/phoenix_int/aserver/util/PHXGetByUrlException.md) + - com.phoenix_int.aserver.[PHXInvalidNameException](com/phoenix_int/aserver/PHXInvalidNameException.md) + - com.phoenix_int.aserver.types.[PHXInvalidTypeException](com/phoenix_int/aserver/types/PHXInvalidTypeException.md) + - com.phoenix_int.aserver.[PHXNameAlreadyInUseException](com/phoenix_int/aserver/PHXNameAlreadyInUseException.md) + - com.phoenix_int.aserver.library.[PHXNoSuchAssociationException](com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md) + - com.phoenix_int.aserver.library.[PHXNoSuchCategoryException](com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md) + - com.phoenix_int.aserver.library.[PHXNoSuchIconException](com/phoenix_int/aserver/library/PHXNoSuchIconException.md) + - com.phoenix_int.aserver.[PHXNoSuchObjectException](com/phoenix_int/aserver/PHXNoSuchObjectException.md) + - com.phoenix_int.aserver.[PHXNoSuchWriteableObjectException](com/phoenix_int/aserver/PHXNoSuchWriteableObjectException.md) + - com.phoenix_int.aserver.util.[PHXNoSuchReplacementException](com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md) + - com.phoenix_int.aserver.client.[PHXNoSuchResponseException](com/phoenix_int/aserver/client/PHXNoSuchResponseException.md) + - com.phoenix_int.aserver.util.[PHXNoSuchTokenException](com/phoenix_int/aserver/util/PHXNoSuchTokenException.md) + - com.phoenix_int.aserver.types.[PHXNumberFormatException](com/phoenix_int/aserver/types/PHXNumberFormatException.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXScriptWrapperAPIException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXSectionNotFoundException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md) + - com.phoenix_int.aserver.client.[PHXServerSideException](com/phoenix_int/aserver/client/PHXServerSideException.md) + - com.phoenix_int.aserver.types.[PHXTypeMismatchException](com/phoenix_int/aserver/types/PHXTypeMismatchException.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[PHXVersionException](com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md) + - java.lang.ReflectiveOperationException + - java.lang.ClassNotFoundException + - com.phoenix_int.aserver.util.[PHXClassNotFoundException](com/phoenix_int/aserver/util/PHXClassNotFoundException.md) + - java.lang.RuntimeException + - com.phoenix_int.aserver.client.[PHXResponseTypeMismatchException](com/phoenix_int/aserver/client/PHXResponseTypeMismatchException.md) + - 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.md) ## Interface hierarchy - java.util.EventListener -- com.phoenix_int.aserver.client.[IPHXAnalysisClientListener](com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md) + - com.phoenix_int.aserver.client.[IPHXAnalysisClientListener](com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md) - com.phoenix_int.aserver.client.v2.[IAnalysisServerCallback](com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md) - com.phoenix_int.pacz.api.[IComponentConfig](com/phoenix_int/pacz/api/IComponentConfig.md) - com.phoenix_int.pacz.api.v2.[IComponentConfig](com/phoenix_int/pacz/api/v2/IComponentConfig.md) @@ -150,53 +150,53 @@ - com.phoenix_int.pacz.api.v2.[IInstanceFile](com/phoenix_int/pacz/api/v2/IInstanceFile.md) - com.phoenix_int.aserver.[IPHXAlwaysWriteable](com/phoenix_int/aserver/IPHXAlwaysWriteable.md) - com.phoenix_int.aserver.[IPHXComponent](com/phoenix_int/aserver/IPHXComponent.md) -- com.phoenix_int.aserver.[IPHXAnalysis](com/phoenix_int/aserver/IPHXAnalysis.md) -- com.phoenix_int.aserver.[IPHXDriver](com/phoenix_int/aserver/IPHXDriver.md) + - com.phoenix_int.aserver.[IPHXAnalysis](com/phoenix_int/aserver/IPHXAnalysis.md) + - com.phoenix_int.aserver.[IPHXDriver](com/phoenix_int/aserver/IPHXDriver.md) - com.phoenix_int.aserver.types.[IPHXDescription](com/phoenix_int/aserver/types/IPHXDescription.md) -- com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md) + - com.phoenix_int.aserver.types.[IPHXRefPropInfo](com/phoenix_int/aserver/types/IPHXRefPropInfo.md) - com.phoenix_int.aserver.library.[IPHXFactory](com/phoenix_int/aserver/library/IPHXFactory.md) - com.phoenix_int.aserver.monitors.[IPHXFileCallback](com/phoenix_int/aserver/monitors/IPHXFileCallback.md) - com.phoenix_int.aserver.types.[IPHXFormat](com/phoenix_int/aserver/types/IPHXFormat.md) - com.phoenix_int.aserver.[IPHXHaltableComponent](com/phoenix_int/aserver/IPHXHaltableComponent.md) - com.phoenix_int.aserver.library.[IPHXLibrarian](com/phoenix_int/aserver/library/IPHXLibrarian.md) -- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian](com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md) -- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md) -- com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md) + - com.phoenix_int.aserver.library.[IPHXVersionedLibrarian](com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md) + - com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md) + - com.phoenix_int.aserver.library.[IPHXVersionedLibrarian2](com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md) - com.phoenix_int.aserver.util.[IPHXLineStore](com/phoenix_int/aserver/util/IPHXLineStore.md) - com.phoenix_int.aserver.[IPHXMonitorable](com/phoenix_int/aserver/IPHXMonitorable.md) - com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRange](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md) - com.phoenix_int.aserver.util.scriptwrapper.api.[IPHXRangeChangeListener](com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md) - com.phoenix_int.aserver.[IPHXRunQueue](com/phoenix_int/aserver/IPHXRunQueue.md) - com.phoenix_int.aserver.[IPHXSelfManager](com/phoenix_int/aserver/IPHXSelfManager.md) -- com.phoenix_int.aserver.[IPHXSelfManager2](com/phoenix_int/aserver/IPHXSelfManager2.md) -- com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.md) -- com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.md) + - com.phoenix_int.aserver.[IPHXSelfManager2](com/phoenix_int/aserver/IPHXSelfManager2.md) + - com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.md) + - com.phoenix_int.aserver.[IPHXSelfManager3](com/phoenix_int/aserver/IPHXSelfManager3.md) - com.phoenix_int.aserver.[IPHXSetupFromFile](com/phoenix_int/aserver/IPHXSetupFromFile.md) - com.phoenix_int.aserver.util.[IPHXStringReplacer](com/phoenix_int/aserver/util/IPHXStringReplacer.md) - com.phoenix_int.aserver.types.[IPHXType](com/phoenix_int/aserver/types/IPHXType.md) -- com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md) -- com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) (also extends com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) + - com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) (also extends com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) - com.phoenix_int.aserver.types.[IPHXType2.IVisitor](com/phoenix_int/aserver/types/IPHXType2.IVisitor.md)`` - com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md) -- com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata) - com.phoenix_int.pacz.api.[IRuntimeVariable](com/phoenix_int/pacz/api/IRuntimeVariable.md) - com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata -- com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md)) + - com.phoenix_int.pacz.api.v2.[IRuntimeVariable](com/phoenix_int/pacz/api/v2/IRuntimeVariable.md) (also extends com.phoenix_int.aserver.types.[IPHXType2](com/phoenix_int/aserver/types/IPHXType2.md), com.phoenix_int.aserver.types.[IPHXUnits](com/phoenix_int/aserver/types/IPHXUnits.md)) - com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile2](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md) - com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[InputFile](com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[OutputFile](com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md) - com.phoenix_int.aserver.util.[Parser](com/phoenix_int/aserver/util/Parser.md) - com.phoenix_int.util.[PHXInternationalize.InternationalizedMessage](com/phoenix_int/util/PHXInternationalize.InternationalizedMessage.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.md) -- com.phoenix_int.aserver.util.[Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.md) -- com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md) -- com.phoenix_int.pacz.api.[RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.md) -- com.phoenix_int.pacz.api.[VariableDataType](com/phoenix_int/pacz/api/VariableDataType.md) -- com.phoenix_int.pacz.api.v2.[RunFolderPreference](com/phoenix_int/pacz/api/v2/RunFolderPreference.md) \ No newline at end of file + - java.lang.Enum`` (implements java.lang.Comparable``, java.io.Serializable) + - com.phoenix_int.aserver.client.v2.[AnalysisServerResponseType](com/phoenix_int/aserver/client/v2/AnalysisServerResponseType.md) + - com.phoenix_int.aserver.util.[Parser.Mode](com/phoenix_int/aserver/util/Parser.Mode.md) + - com.phoenix_int.aserver.util.scriptwrapper.api.[ParseableFile.Mode](com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md) + - com.phoenix_int.pacz.api.[RunFolderPreference](com/phoenix_int/pacz/api/RunFolderPreference.md) + - com.phoenix_int.pacz.api.[VariableDataType](com/phoenix_int/pacz/api/VariableDataType.md) + - com.phoenix_int.pacz.api.v2.[RunFolderPreference](com/phoenix_int/pacz/api/v2/RunFolderPreference.md) \ No newline at end of file diff --git a/2025R2/modelCenter_java_api/index-all.md b/2025R2/modelCenter_java_api/reference-all.md similarity index 99% rename from 2025R2/modelCenter_java_api/index-all.md rename to 2025R2/modelCenter_java_api/reference-all.md index 9185ace32b..bb9ba79210 100644 --- a/2025R2/modelCenter_java_api/index-all.md +++ b/2025R2/modelCenter_java_api/reference-all.md @@ -1,4 +1,6 @@ -# A +# Reference Index + +## 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. @@ -130,7 +132,7 @@ - **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 +## 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. @@ -145,7 +147,7 @@ - **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 +## 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) @@ -246,7 +248,7 @@ - **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 +## 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) @@ -296,7 +298,7 @@ - **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 +## 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) @@ -354,7 +356,7 @@ - **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 +## 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 @@ -440,7 +442,7 @@ - **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 +## 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) @@ -1031,7 +1033,7 @@ - **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 +## 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 @@ -1055,7 +1057,7 @@ - **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 +## 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) @@ -1164,7 +1166,7 @@ - **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 +## 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. @@ -1220,7 +1222,7 @@ - **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 +## 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) @@ -1262,7 +1264,7 @@ - **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 +## 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) @@ -1283,7 +1285,7 @@ - **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 +## 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. @@ -1295,7 +1297,7 @@ - **owner** - Variable in class [com.phoenix_int.aserver.util.scriptwrapper.api.PHXSection](com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md)
-# P +## 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) @@ -1607,11 +1609,11 @@ - **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 +## 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 +## 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)
@@ -1665,7 +1667,7 @@ - **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 +## 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 @@ -1975,7 +1977,7 @@ - **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 +## 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 @@ -2066,7 +2068,7 @@ - **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 +## 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. @@ -2076,7 +2078,7 @@ - **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 +## 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. @@ -2107,7 +2109,7 @@ - **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 +## 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) @@ -2131,12 +2133,12 @@ - **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 +## 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) diff --git a/2025R2/modelCenter_java_api/serialized-form.md b/2025R2/modelCenter_java_api/serialized-form.md index 4c39c42197..b720a37a9c 100644 --- a/2025R2/modelCenter_java_api/serialized-form.md +++ b/2025R2/modelCenter_java_api/serialized-form.md @@ -2,286 +2,256 @@ ## 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 +- 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 -##### _invalidID - -```java -java.lang.String _invalidID -``` -### Class com.phoenix_int.aserver.client.PHXResponseTypeMismatchExceptionextends java.lang.RuntimeException implements Serializable - -#### Serialized fields +## Package com.phoenix_int.aserver.client -##### _invalidID +- 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 -```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 +- 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 -``` +- 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 +- Class com.phoenix_int.aserver.monitors.PHXFileMonitor.FileMonitorChangeExceptionextends java.io.IOException implements Serializable -##### _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 +## Package com.phoenix_int.aserver.types -#### Serialized fields +- 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 -##### _data +## Package com.phoenix_int.aserver.util -```java -com.phoenix_int.aserver.util.IPHXStringBufferContainer _data -``` -##### _cha +- 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 -```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 +- 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 -##### _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 -``` +## Package com.phoenix_int.pacz.api -**Throws:** -: `java.io.IOException` -#### Serialized fields +- Class com.phoenix_int.pacz.api.Environmentextends java.util.HashMap`` implements Serializable -##### _success +## Package com.phoenix_int.pacz.api.v2 -```java -boolean _success -``` -##### _results +- Class com.phoenix_int.pacz.api.v2.Environmentextends java.util.HashMap`` implements Serializable -```java -java.lang.Object _results -``` -##### _exception +## Package com.phoenix_int.util -```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 +- 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.yml b/2025R2/modelCenter_java_api/toc.yml index 1ae8f4442f..9d55f47836 100644 --- a/2025R2/modelCenter_java_api/toc.yml +++ b/2025R2/modelCenter_java_api/toc.yml @@ -14,6 +14,10 @@ href: constant-values.md - name: com/phoenix_int/aserver items: + - name: package-summary + href: com/phoenix_int/aserver/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/package-tree.md - name: IPHXAlwaysWriteable href: com/phoenix_int/aserver/IPHXAlwaysWriteable.md - name: IPHXAnalysis @@ -74,18 +78,14 @@ 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: IPHXAnalysisClientListener + href: com/phoenix_int/aserver/client/IPHXAnalysisClientListener.md - name: PHXAnalysisClient href: com/phoenix_int/aserver/client/PHXAnalysisClient.md - name: PHXAnalysisClientEvent @@ -102,6 +102,10 @@ href: com/phoenix_int/aserver/client/PHXServerSideException.md - name: v2 items: + - 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: AnalysisServerClient href: com/phoenix_int/aserver/client/v2/AnalysisServerClient.md - name: AnalysisServerException @@ -118,12 +122,12 @@ 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: package-summary + href: com/phoenix_int/aserver/library/package-summary.md + - name: package-tree + href: com/phoenix_int/aserver/library/package-tree.md - name: IPHXFactory href: com/phoenix_int/aserver/library/IPHXFactory.md - name: IPHXLibrarian @@ -132,10 +136,6 @@ 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 @@ -154,14 +154,12 @@ 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: IPHXFileCallback + href: com/phoenix_int/aserver/monitors/IPHXFileCallback.md - name: PHXFileMonitor.FileMonitorChangeException href: com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md - name: PHXFileMonitor @@ -172,6 +170,10 @@ href: com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md - name: types items: + - 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: IPHXDescription href: com/phoenix_int/aserver/types/IPHXDescription.md - name: IPHXFormat @@ -185,13 +187,7 @@ - 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 + href: com/phoenix_int/aserver/types/IPHXUnits.md - name: PHXAppearance href: com/phoenix_int/aserver/types/PHXAppearance.md - name: PHXBoolean @@ -254,14 +250,14 @@ 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: IPHXLineStore + href: com/phoenix_int/aserver/util/IPHXLineStore.md + - name: IPHXStringReplacer + href: com/phoenix_int/aserver/util/IPHXStringReplacer.md - name: Parser href: com/phoenix_int/aserver/util/Parser.md - name: Parser.Mode @@ -300,6 +296,10 @@ items: - name: api items: + - 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: AbstractFile href: com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md - name: CAEOutputFile @@ -314,10 +314,6 @@ 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 @@ -348,6 +344,10 @@ href: com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md - name: com/phoenix_int/util items: + - name: package-summary + href: com/phoenix_int/util/package-summary.md + - name: package-tree + href: com/phoenix_int/util/package-tree.md - name: BufferedRandomAccessFile href: com/phoenix_int/util/BufferedRandomAccessFile.md - name: PHXBlocker @@ -360,12 +360,12 @@ 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: package-summary + href: com/phoenix_int/pacz/api/package-summary.md + - name: package-tree + href: com/phoenix_int/pacz/api/package-tree.md - name: Environment href: com/phoenix_int/pacz/api/Environment.md - name: IComponentConfig @@ -378,12 +378,12 @@ 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: 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: Environment href: com/phoenix_int/pacz/api/v2/Environment.md - name: IComponentConfig @@ -396,9 +396,5 @@ 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: Changelog.md href: Changelog.md \ No newline at end of file