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

Class pfcModelItem

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

Description

Contains global CIP definitions for module "pfcModelItem"

Method Summary
`static ParamValue`	`CreateBoolParamValue (boolean Value)` Creates a `ParamValue` object with the specified Boolean value.
`static ParamValue`	`CreateDoubleParamValue (double Value)` Creates a `ParamValue` with the specified real value.
`static ParamValue`	`CreateIntParamValue (int Value)` Creates a `ParamValue` with the specified integer value.
`static ParamValue`	`CreateNoteParamValue (int Value)` Creates a note parameter.
`static ParamValue`	`CreateStringParamValue (String Value)` Creates a parameter value with the specified string value.
`static ModelItemOId`	`ModelItemOId_Create (ModelItemType Type, int Id)` Creates a model-item identifier object.
`static ParameterSelectionOptions`	`ParameterSelectionOptions_Create ()` Creates a ParameterSelectionOptions object.
`static ParamOId`	`ParamOId_Create (String Name)` Creates a parameter identifier object given the parameter name.

Method Detail

CreateStringParamValue

static ParamValue CreateStringParamValue (String Value)

Creates a parameter value with the specified string value.

Manual References:: Dimensions and Parameters: Accessing a ParamValue Object, Family Tables: Creating Family Table Instances, Family Tables: Creating Family Table Columns

Parameters:

Value: The string

Returns:: The created parameter value

CreateIntParamValue

static ParamValue CreateIntParamValue (int Value)

Creates a ParamValue with the specified integer value.

Manual References:: Dimensions and Parameters: Accessing a ParamValue Object, Family Tables: Creating Family Table Instances

Parameters:

Value: The integer value

Returns:: The created parameter value

CreateBoolParamValue

static ParamValue CreateBoolParamValue (boolean Value)

Creates a ParamValue object with the specified Boolean value.

Manual References:: Dimensions and Parameters: Accessing a ParamValue Object, Family Tables: Creating Family Table Instances

Parameters:

Value: The Boolean value

Returns:: The created parameter

CreateDoubleParamValue

static ParamValue CreateDoubleParamValue (double Value)

Creates a ParamValue with the specified real value.

Manual References:: Dimensions and Parameters: Accessing a ParamValue Object, Family Tables: Creating Family Table Instances

Parameters:

Value: The real value

Returns:: The created parameter value

CreateNoteParamValue

static ParamValue CreateNoteParamValue (int Value)

Creates a note parameter.

Manual References:: Dimensions and Parameters: Accessing a ParamValue Object

Parameters:

Value: The note identifier

Returns:: The created note parameter

ParamOId_Create

static ParamOId ParamOId_Create (String Name)

Creates a parameter identifier object given the parameter name.

Parameters:

Name: The parameter name

Returns:: The new identifier object

ParameterSelectionOptions_Create

static ParameterSelectionOptions ParameterSelectionOptions_Create ()

Creates a ParameterSelectionOptions object.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Returns:

ModelItemOId_Create

static ModelItemOId ModelItemOId_Create (ModelItemType Type, int Id)

Creates a model-item identifier object.

A model-item identifier can be passed to Parent.GetChild(OId) .

Parameters:

Type: The model item type
Id: The model item's integer identifier

Returns:: The new ModelItemOId