com.simplifiedlogic.nitro.jlink.impl

Class JlinkUtils

java.lang.Object

com.simplifiedlogic.nitro.jlink.impl.JlinkUtils

public class JlinkUtils
extends java.lang.Object

Useful utility functions related to interacting with JLink.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JlinkUtils.Regenerator Interface for the special handler used by the regenerate function

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CREO7_AUTH
static java.lang.String	CREO8_AUTH
static int	FILENAME_LIMIT
static java.lang.String	OPTION_REGEN_HNDLG
static java.lang.String	VALUE_NO_RESOLVE
static java.lang.String	VALUE_RESOLVE

Constructor Summary

Constructors

Constructor and Description
JlinkUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.Object	callCreoFunction(java.lang.String className, java.lang.Object[] args) Call an externally-defined function which requires Creo (as opposed to older functions which work with Pro/E Wildfire 4).
static void	changeDirectory(CallSession session, java.lang.String dir) Change Creo's current working directory
static void	checkProeVersion(int minVersion, AbstractJLISession jlSession) Checks whether the current Proe version is greater than or equal to a minimum version.
static boolean	checkValueFilter(java.lang.String text, java.util.regex.Pattern valuePtn) Check whether a string matches a search pattern
static java.util.List<java.lang.Integer>	componentPathToList(CallComponentPath path) Convert a ComponentPath to a Java Integer list
static JLIException	createBareException(java.lang.Exception e, java.lang.String msg) Create a new JLIException that wraps a regular Exception.
static JLIException	createException(java.lang.Exception e) Create a new JLIException that wraps a regular Exception.
static JLIException	createException(java.lang.Exception e, java.lang.String msg) Create a new JLIException that wraps a regular Exception.
static void	displayModel(CallSession session, CallModel m, boolean activate) Display a model in Creo.
static java.lang.String	extractInstance(java.lang.String filename) Find the instance portion of a file name.
static java.lang.String	extractNextGeneric(java.lang.String filename) Find the immediate generic portion of a file name.
static java.lang.String	extractTopGeneric(java.lang.String filename) Find the top-level generic portion of a file name.
static java.lang.String	fileInstanceToFilename(java.lang.String genericFilename, java.lang.String instanceName) Combine a generic filename (such as bolt.prt) and an instance name (such as long_bolt) to a standard Creo filename (such as long_bolt<bolt>.prt).
static JLTransform	genTransformTable(CallAssembly baseAssembly, java.util.List<java.lang.Integer> curPath, int pathlen) Get the 3D transform for a component in an assembly and convert it to a JLTransform object.
static CallTransform3D	genTransformTable2(CallAssembly baseAssembly, java.util.List<java.lang.Integer> curPath, int pathlen) Get the 3D transform for a component in an assembly
static CallBaseDimension	getDimension(CallModel m, java.lang.String name, boolean noid) Retrieve a dimension from a model.
static CallFeature	getFeatureForPath(CallSession session, CallSolid wrapping_solid, java.util.List<java.lang.Integer> path) Retrieve a feature from a model given a component path
static java.lang.String	getFeatureName(CallFeature feat) Get the name for a feature.
static CallModel	getFile(CallSession session, java.lang.String filename, boolean errorOnNotFound) Get a model that is open in Creo
static CallModel	getFile(CallSession session, java.lang.String dirname, java.lang.String filename) Get a model that is open in Creo
static CallModel	getFile(JLISession sess, java.lang.String filename, boolean errorOnNotFound) Get a model that is open in Creo
static CallModelItem	getLayer(CallModel m, java.lang.String name) Retrieve a Layer from a Model.
static CallModel	getMfgModel(CallSession session, CallMFG mfg) Get a model for a MFG model.
static CallSolid	getModelSolid(CallSession session, java.lang.String modelname) Get a model that is open in Creo.
static com.ptc.pfc.pfcModel.ModelType	getModelTypeForExtension(java.lang.String ext) Determine the model type for a given file extension
static CallModelItem	getNote(CallModel m, java.lang.String name) Retrieve a note from a model.
static CallModelItem	getNote(CallModel m, java.lang.String name, boolean noid) Retrieve a note from a model.
static CallModelItem	getNote(CallModel m, java.lang.String name, com.ptc.pfc.pfcModelItem.ModelItemType type) Retrieve a note from a model.
static CallModelItem	getNote(CallModel m, java.lang.String name, com.ptc.pfc.pfcModelItem.ModelItemType type, boolean noid) Retrieve a note from a model.
static com.ptc.pfc.pfcModelItem.ModelItemType	getNoteType(CallModel m) Retrieve the appropriate ModelItemType for notes for a model.
static boolean	getParamInfo(CallModel model, CallParameterOwner m, CallParameter param, ParameterData out, boolean encoded, java.util.regex.Pattern valuePtn) Get detailed information about a parameter.
static java.lang.String	getParamTypeString(int ptype) Translate a Creo parameter value type into a JSHell parameter data type
static CallParamValue	getParamValue(CallParameter param)
static java.lang.String	getPath(CallModel m) Get a Model's directory path, including drive letter
static java.lang.String	getPtcErrorText(int code) Convert a PTC error code into text.
static SimpRepData	getSimpRepInfo(CallSimpRep rep) Get detailed information about a model's Simplified Representation
static SimpRepData	getSimpRepInfo(CallSolid solid) Get detailed information about a model's Simplified Representation
static java.lang.String	instGenericExtToFilename(java.lang.String instanceName, java.lang.String genericName, java.lang.String extension) Combine an instance name (such as long_bolt), a generic name (such as bolt) and a file extension (such as .prt) to a standard Creo filename (such as long_bolt<bolt>.prt).
static java.lang.String	instGenericToFilename(java.lang.String instanceFilename, java.lang.String generic) Combine an instance filename (such as long_bolt.prt) and a generic name (such as bolt) to a standard Creo filename (such as long_bolt<bolt>.prt).
static java.util.List<java.lang.Integer>	intSeqToList(CallIntSeq seq) Convert a JLink intseq (integer sequence) to a Java Integer list
static int	isDimId(java.lang.String name) Check whether a name is of the form that indicates a dimension ID.
static boolean	isModelActive(CallSession session, CallModel m) Check whether a model is the active model in Creo
static int	isNoteId(java.lang.String name) Check whether a name is of the form that indicates a note ID.
static boolean	isRelativePath(java.lang.String dirname) Check whether a given path is relative or absolute
static boolean	isSuppressed(CallFeature feat) Check the status of a feature to see whether it is suppressed
static java.lang.String	makeWindchillServerUrl(java.lang.String serverAlias, java.lang.String workspace)
static java.lang.String	makeWindchillUrl(CallServer server, java.lang.String workspace) Construct a URL for a Windchill workspace of the form wtws://<server-alias>/<workspace>/
static java.lang.String	makeWindchillUrl(java.lang.String serverAlias, java.lang.String workspace) Construct a URL for a Windchill workspace of the form wtws://<server-alias>/<workspace>/
static void	postfixResolveModeFix(CallSession session, AbstractJLISession jlSession, boolean resolveMode) Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.
static void	postfixResolveModeFix(CallSession session, AbstractJLISession jlSession, boolean resolveMode, java.lang.String debugKey) Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.
static boolean	prefixResolveModeFix(CallSession session, AbstractJLISession jlSession) Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.
static boolean	prefixResolveModeFix(CallSession session, AbstractJLISession jlSession, java.lang.String debugKey) Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.
static java.lang.String	ptcError(java.lang.Exception e, java.lang.String msg) Try to generate a friendlier error message for a Creo exception.
static void	regenerate(CallSession session, AbstractJLISession jlSession, JlinkUtils.Regenerator regener, boolean setConfig) Regenerate a Creo object
static void	regenerate(CallSession session, AbstractJLISession jlSession, JlinkUtils.Regenerator regener, boolean setConfig, java.lang.String debugKey) Regenerate a Creo object.
static void	resolveGenerics(CallSession session, CallModel m) Make sure that the generic instance of a model is loaded into Creo.
static java.lang.String	resolveRelativePath(CallSession session, java.lang.String dirname) Takes a relative file/directory path, and prepends it with Creo's current working directory.
static void	setAuthCode(CallSession session, AbstractJLISession jlSession)
static void	setParamValue(CallModel m, CallParamValue pval, java.lang.Object value, boolean encoded) Set or create a parameter value in a model
static void	setParamValue(CallParamValue target_pval, CallParamValue source_pval) Copy a value from one parameter to another
static boolean	setResolveModeOption(CallRegenInstructions reginst, boolean value)
static void	showHexBytes(byte[] data) Debugging function to print out a byte array
static void	showHexString(java.lang.String str) Debugging function to print out the bytes in a string
static java.lang.String	stripWindchillUrl(java.lang.String fileUrl) Take a Windchill workspace file URL and strip out file name.
static java.lang.String	toolkitError(com.ptc.pfc.pfcExceptions.XToolkitError e, java.lang.String msg) Try to generate a friendlier error message for a Pro/TOOLKIT exception.
static java.lang.String	translateDisplayStatus(int status) Translate a Creo display status into a JSHell display status
static java.lang.String	translateFeatureStatus(int status) Translate a Creo feature status into a JSHell feature status
static void	validateFilename(java.lang.String filename) Validates that a file name follows the rules for Creo file names.

Methods inherited from class java.lang.Object

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

Field Detail

FILENAME_LIMIT

public static final int FILENAME_LIMIT

See Also:

Constant Field Values

CREO7_AUTH

public static final java.lang.String CREO7_AUTH

See Also:

Constant Field Values

CREO8_AUTH

public static final java.lang.String CREO8_AUTH

See Also:

Constant Field Values

OPTION_REGEN_HNDLG

public static final java.lang.String OPTION_REGEN_HNDLG

See Also:

Constant Field Values

VALUE_RESOLVE

public static final java.lang.String VALUE_RESOLVE

See Also:

Constant Field Values

VALUE_NO_RESOLVE

public static final java.lang.String VALUE_NO_RESOLVE

See Also:

Constant Field Values

Constructor Detail

JlinkUtils

public JlinkUtils()

Method Detail

getFile

public static CallModel getFile(CallSession session,
                java.lang.String dirname,
                java.lang.String filename)
                         throws com.ptc.cipjava.jxthrowable

Get a model that is open in Creo

Parameters:

session - The Creo session

dirname - The directory name the model was loaded from

filename - The filename for the model

Returns:

The Model object for the file if it is in session, otherwise null

Throws:

com.ptc.cipjava.jxthrowable

getFile

public static CallModel getFile(CallSession session,
                java.lang.String filename,
                boolean errorOnNotFound)
                         throws JLIException,
                                com.ptc.cipjava.jxthrowable

Get a model that is open in Creo

Parameters:

session - The Creo session

filename - The filename for the model

errorOnNotFound - Whether to throw an exception if the model was not in memory

Returns:

The Model object for the file if it is in session, otherwise null

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getFile

public static CallModel getFile(JLISession sess,
                java.lang.String filename,
                boolean errorOnNotFound)
                         throws JLIException,
                                java.lang.Exception

Get a model that is open in Creo

Parameters:

sess - The JShell session

filename - The filename for the model

errorOnNotFound - Whether to throw an exception if the model was not in memory

Returns:

The Model object for the file if it is in session, otherwise null

Throws:

JLIException

java.lang.Exception

getModelSolid

public static CallSolid getModelSolid(CallSession session,
                      java.lang.String modelname)
                               throws JLIException,
                                      com.ptc.cipjava.jxthrowable

Get a model that is open in Creo. Throw an exception if the model is not a Solid.

Parameters:

session - The Creo session

modelname - The filename for the model

Returns:

The Solid object for the file if it is in session, otherwise null

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getMfgModel

public static CallModel getMfgModel(CallSession session,
                    CallMFG mfg)
                             throws com.ptc.cipjava.jxthrowable,
                                    JLIException

Get a model for a MFG model. Throws an error if the MFG model has more than one assembly/part dependency.

Parameters:

session - The Creo session

mfg - The MFG object

Returns:

The model for the MFG object

Throws:

com.ptc.cipjava.jxthrowable

JLIException

isRelativePath

public static boolean isRelativePath(java.lang.String dirname)

Check whether a given path is relative or absolute

Parameters:

dirname - The directory name to check (can also be a file name

Returns:

True if the path is relative

resolveRelativePath

public static java.lang.String resolveRelativePath(CallSession session,
                                   java.lang.String dirname)
                                            throws JLIException,
                                                   com.ptc.cipjava.jxthrowable

Takes a relative file/directory path, and prepends it with Creo's current working directory. If the input path is not relative, then it is not modified.

Parameters:

session - The Creo session

dirname - The relative path

Returns:

The absolute path generated

Throws:

JLIException

com.ptc.cipjava.jxthrowable

changeDirectory

public static void changeDirectory(CallSession session,
                   java.lang.String dir)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Change Creo's current working directory

Parameters:

session - The Creo session

dir - The target directory

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getModelTypeForExtension

public static com.ptc.pfc.pfcModel.ModelType getModelTypeForExtension(java.lang.String ext)

Determine the model type for a given file extension

Parameters:

ext - The file extension

Returns:

The Creo model type that matches the extension

createException

public static JLIException createException(java.lang.Exception e)

Create a new JLIException that wraps a regular Exception. Creo exceptions will be converted to a more friendly string format.

Parameters:

e - The original Exception

Returns:

The resulting JLIException. Connection-related errors will be returned as JlinkConnectException

createException

public static JLIException createException(java.lang.Exception e,
                           java.lang.String msg)

Create a new JLIException that wraps a regular Exception. Creo exceptions will be converted to a more friendly string format.

Parameters:

e - The original Exception

msg - A text message to go with the Exception.

Returns:

The resulting JLIException. Connection-related errors will be returned as JlinkConnectException

createBareException

public static JLIException createBareException(java.lang.Exception e,
                               java.lang.String msg)

Create a new JLIException that wraps a regular Exception.

Parameters:

e - The original Exception

msg - A text message to go with the Exception.

Returns:

The resulting JLIException. Connection-related errors will be returned as JlinkConnectException

ptcError

public static java.lang.String ptcError(java.lang.Exception e,
                        java.lang.String msg)

Try to generate a friendlier error message for a Creo exception. If the specified exception does not have a friendlier message, just return the passed-in message.

Parameters:

e - The original Exception

msg - A text message to go with the Exception.

Returns:

A friendlier text message for the Exception.

toolkitError

public static java.lang.String toolkitError(com.ptc.pfc.pfcExceptions.XToolkitError e,
                            java.lang.String msg)

Try to generate a friendlier error message for a Pro/TOOLKIT exception.

Parameters:

e - The original Exception

msg - A text message to go with the Exception

Returns:

A friendlier text message for the Exception

getPtcErrorText

public static java.lang.String getPtcErrorText(int code)

Convert a PTC error code into text.

Parameters:

code - The code to convert

Returns:

The text resulting from a lookup

displayModel

public static void displayModel(CallSession session,
                CallModel m,
                boolean activate)
                         throws com.ptc.cipjava.jxthrowable

Display a model in Creo. The model must already be in-session.

Parameters:

session - The Creo session

m - The model to display

activate - Whether to activate the model's window

Throws:

com.ptc.cipjava.jxthrowable

isModelActive

public static boolean isModelActive(CallSession session,
                    CallModel m)
                             throws com.ptc.cipjava.jxthrowable

Check whether a model is the active model in Creo

Parameters:

session - The Creo session

m - The model to check

Returns:

True if the model is active

Throws:

com.ptc.cipjava.jxthrowable

getFeatureName

public static java.lang.String getFeatureName(CallFeature feat)
                                       throws com.ptc.cipjava.jxthrowable

Get the name for a feature. If the feature is a Component, then it returns the filename of the component.

Parameters:

feat - The Feature to check

Returns:

The name of the feature

Throws:

com.ptc.cipjava.jxthrowable

isSuppressed

public static boolean isSuppressed(CallFeature feat)
                            throws com.ptc.cipjava.jxthrowable

Check the status of a feature to see whether it is suppressed

Parameters:

feat - The Feature to check

Returns:

True if the feature is suppressed

Throws:

com.ptc.cipjava.jxthrowable

getPath

public static java.lang.String getPath(CallModel m)
                                throws com.ptc.cipjava.jxthrowable

Get a Model's directory path, including drive letter

Parameters:

m - The model to check

Returns:

The model's directory path

Throws:

com.ptc.cipjava.jxthrowable

translateFeatureStatus

public static java.lang.String translateFeatureStatus(int status)

Translate a Creo feature status into a JSHell feature status

Parameters:

status - The Creo feature status

Returns:

The JShell feature status

translateDisplayStatus

public static java.lang.String translateDisplayStatus(int status)

Translate a Creo display status into a JSHell display status

Parameters:

status - The Creo display status

Returns:

The JShell display status

getParamTypeString

public static java.lang.String getParamTypeString(int ptype)

Translate a Creo parameter value type into a JSHell parameter data type

Parameters:

ptype - The Creo parameter value type

Returns:

The JShell parameter type

getDimension

public static CallBaseDimension getDimension(CallModel m,
                             java.lang.String name,
                             boolean noid)
                                      throws com.ptc.cipjava.jxthrowable

Retrieve a dimension from a model. If the name contains a dimension ID (@see isDimId) then it will find the dimension for that ID unless the noid flag is true.

This method will handle both Solid and Drawing dimensions.

Parameters:

m - The model which owns the dimension

name - The name of the dimension, or a dimension ID in the form d#.

noid - Whether to allow a dimension ID to be requested in the name field

Returns:

The Dimension or Dimension2D that was found

Throws:

com.ptc.cipjava.jxthrowable

isDimId

public static int isDimId(java.lang.String name)

Check whether a name is of the form that indicates a dimension ID. A name is a dimension ID if it is a 'd' followed by one or more numeric digits.

Parameters:

name - The name to check

Returns:

Whether the name is a dimension ID

getNote

public static CallModelItem getNote(CallModel m,
                    java.lang.String name,
                    boolean noid)
                             throws com.ptc.cipjava.jxthrowable

Retrieve a note from a model. If the name contains a note ID (@see isNoteId) then it will find the note for that ID unless the noid flag is true.

This method will handle both Solid and Drawing notes.

Parameters:

m - The model or drawing which owns the note

name - The name of the note, or a note ID in the form note_#.

noid - Whether to allow a note ID to be requested in the name field

Returns:

The Note or DetailNoteItem that was found

Throws:

com.ptc.cipjava.jxthrowable

getNote

public static CallModelItem getNote(CallModel m,
                    java.lang.String name,
                    com.ptc.pfc.pfcModelItem.ModelItemType type,
                    boolean noid)
                             throws com.ptc.cipjava.jxthrowable

Retrieve a note from a model. If the name contains a note ID (@see isNoteId) then it will find the note for that ID unless the noid flag is true.

This method will handle both Solid and Drawing notes.

Parameters:

m - The model or drawing which owns the note

name - The name of the note, or a note ID in the form note_#.

type - The ModelItemType to find; this allows the method to handle both Solid and Drawing models

noid - Whether to allow a note ID to be requested in the name field

Returns:

The Note or DetailNoteItem that was found

Throws:

com.ptc.cipjava.jxthrowable

getNote

public static CallModelItem getNote(CallModel m,
                    java.lang.String name)
                             throws com.ptc.cipjava.jxthrowable

Retrieve a note from a model.

This method will handle both Solid and Drawing notes.

Parameters:

m - The model or drawing which owns the note

name - The name of the note.

Returns:

The note that was found

Throws:

com.ptc.cipjava.jxthrowable

getNote

public static CallModelItem getNote(CallModel m,
                    java.lang.String name,
                    com.ptc.pfc.pfcModelItem.ModelItemType type)
                             throws com.ptc.cipjava.jxthrowable

Retrieve a note from a model.

This method will handle both Solid and Drawing notes.

Parameters:

m - The model or drawing which owns the note

name - The name of the note.

type - The ModelItemType to find; this allows the method to handle both Solid and Drawing models

Returns:

The note that was found

Throws:

com.ptc.cipjava.jxthrowable

isNoteId

public static int isNoteId(java.lang.String name)

Check whether a name is of the form that indicates a note ID. A name is a note ID if it is 'note_' followed by one or more numeric digits.

Parameters:

name - The name to check

Returns:

Whether the name is a note ID

getLayer

public static CallModelItem getLayer(CallModel m,
                     java.lang.String name)
                              throws com.ptc.cipjava.jxthrowable

Retrieve a Layer from a Model.

Parameters:

m - The Model which owns the Layer

name - The layer name

Returns:

The layer that was found

Throws:

com.ptc.cipjava.jxthrowable

setParamValue

public static void setParamValue(CallModel m,
                 CallParamValue pval,
                 java.lang.Object value,
                 boolean encoded)
                          throws JLIException,
                                 com.ptc.cipjava.jxthrowable

Set or create a parameter value in a model

Parameters:

m - The model containing the parameter

pval - The Creo parameter value object to update

value - The value to set

encoded - True if the value is Base64-encoded

Throws:

JLIException

com.ptc.cipjava.jxthrowable

setParamValue

public static void setParamValue(CallParamValue target_pval,
                 CallParamValue source_pval)
                          throws com.ptc.cipjava.jxthrowable

Copy a value from one parameter to another

Parameters:

target_pval - The Creo parameter value object to copy to

source_pval - The Creo parameter value object to copy from

Throws:

com.ptc.cipjava.jxthrowable

getFeatureForPath

public static CallFeature getFeatureForPath(CallSession session,
                            CallSolid wrapping_solid,
                            java.util.List<java.lang.Integer> path)
                                     throws JLIException,
                                            com.ptc.cipjava.jxthrowable

Retrieve a feature from a model given a component path

Parameters:

session - The Creo session

wrapping_solid - The solid containing the feature

path - The component path to the feature

Returns:

The feature, if found

Throws:

JLIException

com.ptc.cipjava.jxthrowable

prefixResolveModeFix

public static boolean prefixResolveModeFix(CallSession session,
                           AbstractJLISession jlSession)
                                    throws com.ptc.cipjava.jxthrowable

Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.

This method must be called before doing a regenerate, and will set the config option to "resolve_mode".

This workaround is needed for Creo 2 (WF5) and higher.

Parameters:

jlSession - The JShell session

Returns:

True if the option was already set to "resolve_mode" before calling this method. Needed when it comes to setting it back; if it was not already set, then it needs to be unset.

Throws:

com.ptc.cipjava.jxthrowable

prefixResolveModeFix

public static boolean prefixResolveModeFix(CallSession session,
                           AbstractJLISession jlSession,
                           java.lang.String debugKey)
                                    throws com.ptc.cipjava.jxthrowable

Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.

This method must be called before doing a regenerate, and will set the config option to "resolve_mode".

This workaround is needed for Creo 2 (WF5) and higher

Parameters:

jlSession - The JShell session

debugKey - If not null, a debug log message is sent with this debug key

Returns:

True if the option was already set to "resolve_mode" before calling this method. Needed when it comes to setting it back; if it was not already set, then it needs to be unset.

Throws:

com.ptc.cipjava.jxthrowable

postfixResolveModeFix

public static void postfixResolveModeFix(CallSession session,
                         AbstractJLISession jlSession,
                         boolean resolveMode)
                                  throws com.ptc.cipjava.jxthrowable

Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.

This method must be called after doing a regenerate, and will set the config option to "no_resolve_mode" if the resolveMode is false.

This workaround is needed for Creo 2 (WF5) and higher

Parameters:

session - The Creo session

jlSession - The jshell session

resolveMode - Whether the option was already set to "resolve_mode" before the

Throws:

com.ptc.cipjava.jxthrowable

postfixResolveModeFix

public static void postfixResolveModeFix(CallSession session,
                         AbstractJLISession jlSession,
                         boolean resolveMode,
                         java.lang.String debugKey)
                                  throws com.ptc.cipjava.jxthrowable

Workaround for Creo bug, where the "regen_failure_handling" config option needs to be set to "resolve_mode" before attempting a regenerate, so that failures will be handled properly.

This method must be called after doing a regenerate, and will set the config option to "no_resolve_mode" if the resolveMode is false.

This workaround is needed for Creo 2 (WF5) and higher

Parameters:

session - The Creo session

jlSession - The jshell session

resolveMode - Whether the option was already set to "resolve_mode" before prefixResolveModeFix was called

debugKey - If not null, a debug log message is sent with this debug key

Throws:

com.ptc.cipjava.jxthrowable

setResolveModeOption

public static boolean setResolveModeOption(CallRegenInstructions reginst,
                           boolean value)

setAuthCode

public static void setAuthCode(CallSession session,
               AbstractJLISession jlSession)
                        throws com.ptc.cipjava.jxthrowable

Throws:

com.ptc.cipjava.jxthrowable

regenerate

public static void regenerate(CallSession session,
              AbstractJLISession jlSession,
              JlinkUtils.Regenerator regener,
              boolean setConfig)
                       throws com.ptc.cipjava.jxthrowable

Regenerate a Creo object

Parameters:

jlSession - The JShell session

regener - The handler class which performs the regeneration

setConfig - True to update the "regen_failure_handling" config option

Throws:

com.ptc.cipjava.jxthrowable

regenerate

public static void regenerate(CallSession session,
              AbstractJLISession jlSession,
              JlinkUtils.Regenerator regener,
              boolean setConfig,
              java.lang.String debugKey)
                       throws com.ptc.cipjava.jxthrowable

Regenerate a Creo object. If the regeneration fails with a -56 ("Regenerate Again") error, the regeneration will be tried again.

Parameters:

jlSession - The JShell session

regener - The handler class which performs the regeneration

setConfig - True to update the "regen_failure_handling" config option

debugKey - If not null, a debug log message is sent with this debug key

Throws:

com.ptc.cipjava.jxthrowable

genTransformTable

public static JLTransform genTransformTable(CallAssembly baseAssembly,
                            java.util.List<java.lang.Integer> curPath,
                            int pathlen)
                                     throws com.ptc.cipjava.jxthrowable,
                                            JLIException

Get the 3D transform for a component in an assembly and convert it to a JLTransform object.

Parameters:

baseAssembly - The assembly containing the component

curPath - The component path for the component

pathlen - The length of the component path; this allows you to use a portion of the component path

Returns:

The 3D transform for the component

Throws:

com.ptc.cipjava.jxthrowable

JLIException

genTransformTable2

public static CallTransform3D genTransformTable2(CallAssembly baseAssembly,
                                 java.util.List<java.lang.Integer> curPath,
                                 int pathlen)
                                          throws com.ptc.cipjava.jxthrowable

Get the 3D transform for a component in an assembly

Parameters:

baseAssembly - The assembly containing the component

curPath - The component path for the component

pathlen - The length of the component path; this allows you to use a portion of the component path

Returns:

The 3D transform for the component

Throws:

com.ptc.cipjava.jxthrowable

getParamInfo

public static boolean getParamInfo(CallModel model,
                   CallParameterOwner m,
                   CallParameter param,
                   ParameterData out,
                   boolean encoded,
                   java.util.regex.Pattern valuePtn)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Get detailed information about a parameter. The data is returned in the "out" argument to the method.

If the parameter value is a String which contains binary data, then the encoded argument will be set to true automatically.

If the valuePtn argument is filled in, then the value is checked against the pattern. If the value doesn't match the pattern, the output is not updated and the method returns false.

Parameters:

model - The model containing the parameter

m - The owner of the parameter (may not be the same as the model; for example, it may be a feature)

param - The Creo parameter data

out - The JShell parameter data output by the method

encoded - Whether to return the parameter value as a byte array

valuePtn - A pattern to filter the value for

Returns:

True if the parameter data was found, false if the parameter was not found or did not match the filter

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getParamValue

public static CallParamValue getParamValue(CallParameter param)
                                    throws JLIException,
                                           com.ptc.cipjava.jxthrowable

Throws:

JLIException

com.ptc.cipjava.jxthrowable

resolveGenerics

public static void resolveGenerics(CallSession session,
                   CallModel m)
                            throws com.ptc.cipjava.jxthrowable

Make sure that the generic instance of a model is loaded into Creo.

Parameters:

session - The Creo session

m - The model which is an instance in a family table

Throws:

com.ptc.cipjava.jxthrowable

callCreoFunction

public static java.lang.Object callCreoFunction(java.lang.String className,
                                java.lang.Object[] args)
                                         throws JLIException,
                                                com.ptc.cipjava.jxthrowable

Call an externally-defined function which requires Creo (as opposed to older functions which work with Pro/E Wildfire 4).

Parameters:

className - The class name for the function extension

args - An argument list for the function

Returns:

The object returned by the external function

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getSimpRepInfo

public static SimpRepData getSimpRepInfo(CallSolid solid)
                                  throws JLIException,
                                         com.ptc.cipjava.jxthrowable

Get detailed information about a model's Simplified Representation

Parameters:

solid - The model with a Simp Rep

Returns:

The output data

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getSimpRepInfo

public static SimpRepData getSimpRepInfo(CallSimpRep rep)
                                  throws JLIException,
                                         com.ptc.cipjava.jxthrowable

Get detailed information about a model's Simplified Representation

Parameters:

rep - The simplified rep obtained from Creo

Returns:

The output data

Throws:

JLIException

com.ptc.cipjava.jxthrowable

componentPathToList

public static java.util.List<java.lang.Integer> componentPathToList(CallComponentPath path)
                                                             throws JLIException,
                                                                    com.ptc.cipjava.jxthrowable

Convert a ComponentPath to a Java Integer list

Parameters:

path - The component path

Returns:

The integer list

Throws:

JLIException

com.ptc.cipjava.jxthrowable

intSeqToList

public static java.util.List<java.lang.Integer> intSeqToList(CallIntSeq seq)
                                                      throws JLIException,
                                                             com.ptc.cipjava.jxthrowable

Convert a JLink intseq (integer sequence) to a Java Integer list

Parameters:

seq - The integer sequence

Returns:

The integer list

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getNoteType

public static com.ptc.pfc.pfcModelItem.ModelItemType getNoteType(CallModel m)

Retrieve the appropriate ModelItemType for notes for a model.

Parameters:

m - A model to get the type for

Returns:

Either ModelItemType.ITEM_NOTE (for Solids) or ModelItemType.ITEM_DTL_NOTE (for drawings)

checkValueFilter

public static boolean checkValueFilter(java.lang.String text,
                       java.util.regex.Pattern valuePtn)
                                throws com.ptc.cipjava.jxthrowable

Check whether a string matches a search pattern

Parameters:

text - The string to validate

valuePtn - The search pattern

Returns:

true if the string matches the pattern, or if the pattern is null

Throws:

com.ptc.cipjava.jxthrowable

extractTopGeneric

public static java.lang.String extractTopGeneric(java.lang.String filename)

Find the top-level generic portion of a file name. This is done strictly based on the file name without reference to the physical model.

Parameters:

filename - A file name which represents an instance in a family table

Returns:

The top-level generic name, or null if the file is not a family table instance

extractNextGeneric

public static java.lang.String extractNextGeneric(java.lang.String filename)

Find the immediate generic portion of a file name. This is done strictly based on the file name without reference to the physical model.

Parameters:

filename - A file name which represents an instance in a family table

Returns:

The generic name, or null if the file is not a family table instance

extractInstance

public static java.lang.String extractInstance(java.lang.String filename)

Find the instance portion of a file name. This is done strictly based on the file name without reference to the physical model.

Parameters:

filename - A file name which represents an instance in a family table

Returns:

The instance name, or null if the file is not a family table instance

instGenericToFilename

public static java.lang.String instGenericToFilename(java.lang.String instanceFilename,
                                     java.lang.String generic)

Combine an instance filename (such as long_bolt.prt) and a generic name (such as bolt) to a standard Creo filename (such as long_bolt<bolt>.prt).

Parameters:

instanceFilename - The instance file name, including the file extension

generic - The generic name, which does NOT include the file extension

Returns:

The formatted, combined name

fileInstanceToFilename

public static java.lang.String fileInstanceToFilename(java.lang.String genericFilename,
                                      java.lang.String instanceName)

Combine a generic filename (such as bolt.prt) and an instance name (such as long_bolt) to a standard Creo filename (such as long_bolt<bolt>.prt).

Parameters:

genericFilename - The generic file name, including the file extension

instanceName - The instance name, which does NOT include the file extension

Returns:

The formatted, combined name

instGenericExtToFilename

public static java.lang.String instGenericExtToFilename(java.lang.String instanceName,
                                        java.lang.String genericName,
                                        java.lang.String extension)

Combine an instance name (such as long_bolt), a generic name (such as bolt) and a file extension (such as .prt) to a standard Creo filename (such as long_bolt<bolt>.prt).

Parameters:

instanceName - The instance name, which does NOT include the file extension

genericName - The generic name, which does NOT include the file extension

extension - The file extension, which may or may not include the dot

Returns:

The formatted, combined name

showHexBytes

public static void showHexBytes(byte[] data)

Debugging function to print out a byte array

Parameters:

data - The array to print out

showHexString

public static void showHexString(java.lang.String str)

Debugging function to print out the bytes in a string

Parameters:

str - The string to print out

makeWindchillUrl

public static java.lang.String makeWindchillUrl(CallServer server,
                                java.lang.String workspace)
                                         throws com.ptc.cipjava.jxthrowable

Construct a URL for a Windchill workspace of the form wtws://<server-alias>/<workspace>/

Parameters:

server - The JLink server object

workspace - The Windchill workspace name

Returns:

The URL for the workspace

Throws:

com.ptc.cipjava.jxthrowable

makeWindchillUrl

public static java.lang.String makeWindchillUrl(java.lang.String serverAlias,
                                java.lang.String workspace)
                                         throws com.ptc.cipjava.jxthrowable

Construct a URL for a Windchill workspace of the form wtws://<server-alias>/<workspace>/

Parameters:

serverAlias - The Windchill server alias

workspace - The Windchill workspace name

Returns:

The URL for the workspace

Throws:

com.ptc.cipjava.jxthrowable

makeWindchillServerUrl

public static java.lang.String makeWindchillServerUrl(java.lang.String serverAlias,
                                      java.lang.String workspace)
                                               throws com.ptc.cipjava.jxthrowable

Throws:

com.ptc.cipjava.jxthrowable

stripWindchillUrl

public static java.lang.String stripWindchillUrl(java.lang.String fileUrl)

Take a Windchill workspace file URL and strip out file name.

Parameters:

fileUrl - The URL for the Windchill workspace file

Returns:

The file name portion of the fileUrl

validateFilename

public static void validateFilename(java.lang.String filename)
                             throws JLIException

Validates that a file name follows the rules for Creo file names. Throws an exception if validation fails.

Parameters:

filename - The name of the file to validate.

Throws:

JLIException - If a validation error occurs, this contains the text of the failure.

checkProeVersion

public static void checkProeVersion(int minVersion,
                    AbstractJLISession jlSession)
                             throws JLIException

Checks whether the current Proe version is greater than or equal to a minimum version.

Parameters:

minVersion - The minimum Creo version required

jlSession - The JShell session

Throws:

JLIException

See Also:

JLProe.setProeVersion(int, AbstractJLISession)