CIP JAVA documentation for class "com.ptc.pfc.pfcDimension.BaseDimension"

Interface BaseDimension

package com.ptc.pfc.pfcDimension; public interface BaseDimension extends com.ptc.pfc.pfcModelItem.BaseParameter, com.ptc.pfc.pfcModelItem.ModelItem

Description

This class defines a base dimension, which can be a dimension or reference dimension.

The dimension types are as follows:

DIM_LINEAR
DIM_RADIAL
DIM_DIAMETER
DIM_ANGULAR

Direct Known Subclasses:: Dimension, RefDimension, UDFDimension, Dimension2D

Method Summary
`void`	`Erase ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.EraseDimension` Erases the dimension from a model or drawing.
`DimensionType`	`GetDimType ()` Get method for attribute "DimType" The dimension type
`double`	`GetDimValue ()` Get method for attribute "DimValue" The value of the dimension.
`boolean`	`GetExtendsInNegativeDirection ()` Get method for attribute "ExtendsInNegativeDirection" Identifies if the dimension is currently considered to have a negative "sign" in generating its direction. If the dimension has a negative sign then the dimension is oriented in the opposite manner to the default for the feature.
`String`	`GetSymbol ()` Get method for attribute "Symbol" The dimension name or symbol
`stringseq`	`GetTexts ()` Get method for attribute "Texts" The dimension text
`void`	`SetDimValue (double value)` Set method for attribute "DimValue" The value of the dimension.
`void`	`SetSymbol (String value)` Set method for attribute "Symbol" The dimension name or symbol
`void`	`SetTexts (stringseq value)` Set method for attribute "Texts" The dimension text
`void`	`Show ( /optional/ DimensionShowInstructions Instructions)` Forces the display of the dimension in a model.

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.BaseParameter`
`GetValue`, `SetValue`, `GetIsDesignated`, `SetIsDesignated`, `GetIsRelationDriven`, `GetIsModified`, `ResetFromBackup`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Method Detail

GetDimValue/SetDimValue

`double`	`GetDimValue`	`()`
`void`	`SetDimValue`	`(double value)`

The value of the dimension.

This is always positive if the model is fully regenerated. Use the property BaseDimension.GetExtendsInNegativeDirection() to detect if the dimension direction is oriented opposite to the feature default. When setting this property, if a negative number is passed, this will flip the direction of the dimension.

Exceptions thrown (but not limited to):

XToolkitBadContext - The input dimension is reference.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

GetDimType

DimensionType GetDimType ()

The dimension type

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

GetSymbol/SetSymbol

`String`	`GetSymbol`	`()`
`void`	`SetSymbol`	`(String value)`

The dimension name or symbol

Exceptions thrown (but not limited to):

XToolkitNoChange - The function could not set the symbol to new value as the new symbol name already exists for other dimension in the model.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

GetTexts/SetTexts

`stringseq`	`GetTexts`	`()`
`void`	`SetTexts`	`(stringseq value)`

The dimension text

Exceptions thrown (but not limited to):

XToolkitNotFound - Dimension text is not found.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

GetExtendsInNegativeDirection

boolean GetExtendsInNegativeDirection ()

Identifies if the dimension is currently considered to have a negative "sign" in generating its direction. If the dimension has a negative sign then the dimension is oriented in the opposite manner to the default for the feature.

Show

void Show ( /*optional*/ DimensionShowInstructions Instructions)

Forces the display of the dimension in a model.

Exceptions thrown (but not limited to):

XToolkitNoChange - The annotation is already shown in the target model.

XToolkitInvalidMatrix - The annotation cannot be shown due to orientation conflicts in the view.

XToolkitNoLicense - License check failure.

XToolkitNotDisplayed - Annotation is present on hidden or blank layer and so can't be shown.

See Also:: pfcAssembly.ComponentDimensionShowInstructions_Create(/*optional*/ ComponentPath), pfcView2D.DrawingDimensionShowInstructions_Create(View2D, /*optional*/ ComponentPath)

Parameters:

Instructions

Specifies the location where the dimension should be shown:

Pass null to show the dimension in the top level part or assembly.
Pass an instance of ComponentDimensionShowInstructions to show the dimension contained in an assembly component in a top level assembly.
Pass an instance of DrawingDimensionShowInstructions to show the dimension in a drawing view.

Returns:

Erase

void Erase ()

DEPRECATED: since Creo 4
SUCCESSOR(S): Drawing.EraseDimension

Erases the dimension from a model or drawing.

If called on a Dimension2D object, this temporarily erases the displayed dimension from the drawing. For a permanent erase please use Dimension2D.EraseFromModel2D().

Returns: