CIP JAVA documentation for class "com.ptc.pfc.pfcArgument.pfcArgument"

Class pfcArgument

package com.ptc.pfc.pfcArgument; public class pfcArgument

Description

Contains global CIP definitions for module "pfcArgument"

Method Summary
`static Argument`	`Argument_Create (String inLabel, ArgValue inValue)` Creates a new argument object, for use in passing value to other Creo Parametric auxiliary applications like Creo Parametric TOOLKIT DLL's.
`static ArgValue`	`CreateASCIIStringArgValue (String Value)` Creates an ASCII string argument value object.
`static ArgValue`	`CreateBoolArgValue (boolean Value)` Creates a boolean argument value object.
`static ArgValue`	`CreateDoubleArgValue (double Value)` Creates a double argument value object.
`static ArgValue`	`CreateIntArgValue (int Value)` Creates an integer argument value object.
`static ArgValue`	`CreateSelectionArgValue (Selection Value)` Creates a new selection argument value object.
`static ArgValue`	`CreateStringArgValue (String Value)` Creates a string argument value object.
`static ArgValue`	`CreateTransformArgValue (Transform3D Value)` Creates a new transform argument value object.
`static Argument`	`FindArgumentByLabel (Arguments ArgList, String Label)`

Method Detail

CreateIntArgValue

static ArgValue CreateIntArgValue (int Value)

Creates an integer argument value object.

See Also:: pfcArgument.Argument_Create(String, ArgValue), Dll.ExecuteFunction(String, Arguments)

Manual References:: Task Based Application Libraries: Managing Application Arguments

Parameters:

Value: The integer value.

Returns:: The created argument value object.

CreateDoubleArgValue

static ArgValue CreateDoubleArgValue (double Value)

Creates a double argument value object.

See Also:: pfcArgument.Argument_Create(String, ArgValue), Dll.ExecuteFunction(String, Arguments)

Manual References:: Task Based Application Libraries: Managing Application Arguments

Parameters:

Value: The double value.

Returns:: The created argument value object.

CreateBoolArgValue

static ArgValue CreateBoolArgValue (boolean Value)

Creates a boolean argument value object.

See Also:: pfcArgument.Argument_Create(String, ArgValue), Dll.ExecuteFunction(String, Arguments)

Manual References:: Task Based Application Libraries: Managing Application Arguments

Parameters:

Value: The boolean value.

Returns:: The created argument object.

CreateASCIIStringArgValue

static ArgValue CreateASCIIStringArgValue (String Value)

Creates an ASCII string argument value object.

This type will be passed to Creo Parametric TOOLKIT using the ProValueDataType of PRO_VALUE_TYPE_STRING.

See Also:: pfcArgument.Argument_Create(String, ArgValue), Dll.ExecuteFunction(String, Arguments)

Manual References:: Task Based Application Libraries: Managing Application Arguments

Parameters:

Value: The character string.

Returns:: The created argument object.

CreateStringArgValue

static ArgValue CreateStringArgValue (String Value)

Creates a string argument value object.

This type will be passed to Creo Parametric TOOLKIT using the ProValueDataType of PRO_VALUE_TYPE_WSTRING.

See Also:: pfcArgument.Argument_Create(String, ArgValue), Dll.ExecuteFunction(String, Arguments)

Manual References:: Task Based Application Libraries: Managing Application Arguments

Parameters:

Value: The string value.

Returns:: The created argument value object.

CreateSelectionArgValue

static ArgValue CreateSelectionArgValue (Selection Value)

Creates a new selection argument value object.

See Also:: pfcArgument.Argument_Create(String, ArgValue), Dll.ExecuteFunction(String, Arguments), pfcSelect.CreateComponentSelection(ComponentPath), pfcSelect.CreateModelItemSelection(ModelItem, /*optional*/ ComponentPath)

Manual References:: Task Based Application Libraries: Managing Application Arguments

Parameters:

Value: The selection object.

Returns:: The created selection argument value object.

CreateTransformArgValue

static ArgValue CreateTransformArgValue (Transform3D Value)

Creates a new transform argument value object.

See Also:: pfcArgument.Argument_Create(String, ArgValue), Dll.ExecuteFunction(String, Arguments), pfcBase.Transform3D_Create(/*optional*/ Matrix3D)

Manual References:: Task Based Application Libraries: Managing Application Arguments

Parameters:

Value: The coordinate transformation.

Returns:: The created argument value object.

Argument_Create

static Argument Argument_Create (String inLabel, ArgValue inValue)

Creates a new argument object, for use in passing value to other Creo Parametric auxiliary applications like Creo Parametric TOOLKIT DLL's.

See Also:: Dll.ExecuteFunction(String, Arguments)

Manual References:: Task Based Application Libraries: Modifying Arguments, Task Based Application Libraries: Modifying Arguments

Parameters:

inLabel: The argument label string.
inValue: The argument value.

Returns:: The created argument object.

FindArgumentByLabel

static Argument FindArgumentByLabel (Arguments ArgList, String Label)

Parameters:

ArgList
Label

Returns: