Skip to main content

ModelCenter scriptWrapper API 2026 R1

Class: CAEOutputFile

Last update: 22.06.2026

Package: com.phoenix_int.aserver.util.scriptwrapper.api

Class Hierarchy

↳ java.lang.Object
  ↳ com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile
    ↳ com.phoenix_int.aserver.util.scriptwrapper.api.CAEOutputFile

Implemented Interfaces


Declaration

public class CAEOutputFile
extends AbstractFile
implements OutputFile2

This represents a binary output file from a CAE program such as NASTRAN or LSDyna.

Nested Class Summary

Nested classes/interfaces inherited from interface com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile

ParseableFile.Mode

Field Summary

Fields inherited from class com.phoenix_int.aserver.util.scriptwrapper.api.AbstractFile

encoding, fileName, mode, parser, templateFileName, wrapper

Related Files:

Constructor Summary

Constructor and Description
CAEOutputFile(PHXScriptWrapperObject wrapper, java.io.File file)
CAEOutputFile(PHXScriptWrapperObject wrapper, java.io.File file, FileType type)

Method Summary

Modifier and Type Method and Description
void defineArrayVar(java.lang.String name, java.lang.String specifier)
void defineVar(java.lang.String name, java.lang.String specifier)
protected Parser newParser(java.io.File rFile, Parser.Mode pmode)
Generate a new parser for the given file and mode
void parse()
Parse the output file
void setFileToParse(java.lang.String fileName)
Set the file to parse
protected void transferVars(ParseableFile.Mode mode)
Transfer values for variables that have been defined using methods from the concrete implementation

Methods inherited from class AbstractFile

actionByMode, backup, close, delete, ensureFileParser, getEncoding, getRealFile, readTemplate, setEncoding, setEncoding, setFileToGenerateOrParse, setTempEmbedded, setTemplateFile, setVariable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CAEOutputFile

public CAEOutputFile(PHXScriptWrapperObject wrapper, 
                     java.io.File file, 
                     FileType type) 
              throws PHXLicenseException

Throws:

  • PHXLicenseException

CAEOutputFile

public CAEOutputFile(PHXScriptWrapperObject wrapper, 
                     java.io.File file) 
              throws PHXLicenseException

Throws:

  • PHXLicenseException

Method Detail

defineArrayVar

public void defineArrayVar(java.lang.String name, 
                           java.lang.String specifier) 
                    throws PHXNameAlreadyInUseException, 
                           PHXInvalidNameException, 
                           PHXInvalidTypeException

Throws:

  • PHXNameAlreadyInUseException
  • PHXInvalidNameException
  • PHXInvalidTypeException

defineVar

public void defineVar(java.lang.String name, 
                      java.lang.String specifier) 
               throws PHXNameAlreadyInUseException, 
                      PHXInvalidNameException, 
                      PHXInvalidTypeException

Throws:

  • PHXNameAlreadyInUseException
  • PHXInvalidNameException
  • PHXInvalidTypeException

parse

public void parse() throws java.lang.Exception

Parse the output file

Specified by:

Throws:

  • java.lang.Exception

newParser

protected Parser newParser(java.io.File rFile, 
                           Parser.Mode pmode) 
                    throws java.io.IOException

Generate a new parser for the given file and mode

Specified by:

Parameters:

  • rFile - The file to open
  • pmode - caching mode for underlying parser

Throws:

  • java.io.IOException

transferVars

protected void transferVars(ParseableFile.Mode mode) 
                     throws java.io.IOException, 
                            com.phoenix_int.aserver.util.PHXInvalidFormatException, 
                            PHXNoSuchTokenException, 
                            java.lang.IllegalAccessException, 
                            java.lang.InstantiationException, 
                            PHXNumberFormatException

Transfer values for variables that have been defined using methods from the concrete implementation, i.e. PHXRowFieldFile.defineVar(String, String, boolean, String). Variables defined using PHXScriptWrapperObject.addVariable(String, String, boolean) must be explicitly transferred using methods of the concrete implementation class

Specified by:

Throws:

  • java.io.IOException
  • com.phoenix_int.aserver.util.PHXInvalidFormatException
  • PHXNoSuchTokenException
  • java.lang.IllegalAccessException
  • java.lang.InstantiationException
  • PHXNumberFormatException

setFileToParse

public void setFileToParse(java.lang.String fileName)

Set the file to parse

Specified by:

Parameters:

  • fileName -

Connect with Ansys