CIP C++ documentation for class "pfcBaseDimension"

Class pfcBaseDimension

# include <pfcDimension.h> class pfcBaseDimension : public virtual pfcBaseParameter, : public virtual pfcModelItem { xaideclare(pfcBaseDimension) ... };

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:: pfcDimension, pfcRefDimension, pfcUDFDimension, pfcDimension2D

Method Summary


`void`	`Erase ()`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDrawing::EraseDimension` Erases the dimension from a model or drawing.

`pfcDimensionType`	`GetDimType ()`
	The dimension type

`xreal`	`GetDimValue ()`
`void`	`SetDimValue (xreal value)`
	The value of the dimension.

`xbool`	`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.

`xstring`	`GetSymbol ()`
`void`	`SetSymbol (xrstring value)`
	The dimension name or symbol

`xstringsequence_ptr`	`GetTexts ()`
`void`	`SetTexts (xstringsequence_ptr value)`
	The dimension text







`void`	`Show (optional pfcDimensionShowInstructions_ptr Instructions)`
	Forces the display of the dimension in a model.

Methods Inherited from Class pfcBaseParameter:: GetValue, SetValue, GetIsDesignated, SetIsDesignated, GetIsRelationDriven, GetIsModified, ResetFromBackup

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Method Detail

`xreal`	`GetDimValue`	`()`
`void`	`SetDimValue`	`(xreal value)`

The value of the dimension.

This is always positive if the model is fully regenerated. Use the property pfcBaseDimension::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):

pfcXToolkitBadContext - 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

pfcDimensionType GetDimType ()

The dimension type

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

`xstring`	`GetSymbol`	`()`
`void`	`SetSymbol`	`(xrstring value)`

The dimension name or symbol

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - 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

`xstringsequence_ptr`	`GetTexts`	`()`
`void`	`SetTexts`	`(xstringsequence_ptr value)`

The dimension text

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - 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

xbool 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.

void Show (optional pfcDimensionShowInstructions_ptr Instructions)

Forces the display of the dimension in a model.

Exceptions thrown (but not limited to):

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

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

pfcXToolkitNoLicense - License check failure.

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

See Also:: pfcComponentDimensionShowInstructions::Create(optional pfcComponentPath_ptr), pfcDrawingDimensionShowInstructions::Create(pfcView2D_ptr, optional pfcComponentPath_ptr)

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 pfcComponentDimensionShowInstructions to show the dimension contained in an assembly component in a top level assembly.
Pass an instance of pfcDrawingDimensionShowInstructions to show the dimension in a drawing view.

Returns:

void Erase ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::EraseDimension

Erases the dimension from a model or drawing.

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

Returns: