ShelfBuilder Class¶

class NXOpen.Features.ShelfBuilder¶

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.Shelf builder

To create a new instance of this class, use NXOpen.Features.AeroCollection.CreateShelfBuilder()

Default values.

Property	Value
DepthDimension.Value	5 (millimeters part), 0.25 (inches part)
DepthMethod	Offset
Length1.Value	10 (millimeters part), 0.5 (inches part)
Length2.Value	0 (millimeters part), 0 (inches part)
LengthDimension.Value	25 (millimeters part), 1.0 (inches part)
LengthMethod	Full
OffsetDimension.Value	0 (millimeters part), 0 (inches part)
RampLength1.Value	10 (millimeters part), 0.5 (inches part)
RampLength2.Value	10 (millimeters part), 0.5 (inches part)
RefType1	Face
RefType2	Face
ShelfType	End
StepMethod1	Normal
StepMethod2	Normal
WidthDimension.Value	5 (millimeters part), 0.25 (inches part)

New in version NX10.0.0.

Properties¶

Property	Description
DepthDimension	Returns the depth dimension
DepthMethod	Returns or sets the depth method
Length1	Returns the length1
Length2	Returns the length2
LengthDimension	Returns the length dimension
LengthMethod	Returns or sets the length method
LimitCurve1	Returns the limit curve1
LimitCurve2	Returns the limit curve2
LimitFace1	Returns the limit face1
LimitFace2	Returns the limit face2
LimitPlane1	Returns or sets the limit plane1
LimitPlane2	Returns or sets the limit plane2
LimitPoint1	Returns or sets the limit point1
LimitPoint2	Returns or sets the limit point2
OffsetDimension	Returns the offset dimension
ParentFeatureInternal	Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag	Returns or sets the patch solution flag
PatchSurfaceFilename	Returns or sets the patch surface filename
ProjectionDir1	Returns the project direction 1
ProjectionDir2	Returns the project direction 2
RampLength1	Returns the ramp length1
RampLength2	Returns the ramp length2
RefType1	Returns or sets the ref type1
RefType2	Returns or sets the ref type2
ReverseDepthDirection	Returns or sets whether reverse depth direction
ReverseWidthDirection	Returns or sets whether reverse width direction
Selectface	Returns the selected face
ShelfEdge	Returns the shelf edge
ShelfEnd	Returns or sets the shelf end
ShelfType	Returns or sets the type
StepMethod1	Returns or sets the step method1
StepMethod2	Returns or sets the step method2
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Swap	Returns or sets the swap
Tag	Returns the Tag for this object.
WidthDimension	Returns the width dimension

Methods¶

Method	Description
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature	Returns the feature currently being edited by this builder.
GetObject	Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit	Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal	Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit	Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal	Set the internal parent feature of the feature being edited to external
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

ShelfBuilderDepthMethods Enumeration	Depth Method for Depth Face
ShelfBuilderLengthMethods Enumeration	Depth Method for Length
ShelfBuilderReferenceType Enumeration	Type of Reference Object
ShelfBuilderStepMethod Enumeration	Step Method for Side Face
ShelfBuilderTypes Enumeration	Type of shelf.

Property Detail¶

DepthDimension¶

ShelfBuilder.DepthDimension¶

Returns the depth dimension

-------------------------------------

Getter Method

Signature DepthDimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

DepthMethod¶

ShelfBuilder.DepthMethod¶

Returns or sets the depth method

-------------------------------------

Getter Method

Signature DepthMethod

Returns:
Return type:	`NXOpen.Features.ShelfBuilderDepthMethods`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DepthMethod

Parameters:	depthMethod (`NXOpen.Features.ShelfBuilderDepthMethods`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

Length1¶

ShelfBuilder.Length1¶

Returns the length1

-------------------------------------

Getter Method

Signature Length1

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

Length2¶

ShelfBuilder.Length2¶

Returns the length2

-------------------------------------

Getter Method

Signature Length2

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

LengthDimension¶

ShelfBuilder.LengthDimension¶

Returns the length dimension

-------------------------------------

Getter Method

Signature LengthDimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

LengthMethod¶

ShelfBuilder.LengthMethod¶

Returns or sets the length method

-------------------------------------

Getter Method

Signature LengthMethod

Returns:
Return type:	`NXOpen.Features.ShelfBuilderLengthMethods`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LengthMethod

Parameters:	lengthMethod (`NXOpen.Features.ShelfBuilderLengthMethods`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

LimitCurve1¶

ShelfBuilder.LimitCurve1¶

Returns the limit curve1

-------------------------------------

Getter Method

Signature LimitCurve1

Returns:
Return type:	`NXOpen.Section`

New in version NX10.0.0.

License requirements: None.

LimitCurve2¶

ShelfBuilder.LimitCurve2¶

Returns the limit curve2

-------------------------------------

Getter Method

Signature LimitCurve2

Returns:
Return type:	`NXOpen.Section`

New in version NX10.0.0.

License requirements: None.

LimitFace1¶

ShelfBuilder.LimitFace1¶

Returns the limit face1

-------------------------------------

Getter Method

Signature LimitFace1

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX10.0.0.

License requirements: None.

LimitFace2¶

ShelfBuilder.LimitFace2¶

Returns the limit face2

-------------------------------------

Getter Method

Signature LimitFace2

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX10.0.0.

License requirements: None.

LimitPlane1¶

ShelfBuilder.LimitPlane1¶

Returns or sets the limit plane1

-------------------------------------

Getter Method

Signature LimitPlane1

Returns:
Return type:	`NXOpen.Plane`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LimitPlane1

Parameters:	limitPlane1 (`NXOpen.Plane`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

LimitPlane2¶

ShelfBuilder.LimitPlane2¶

Returns or sets the limit plane2

-------------------------------------

Getter Method

Signature LimitPlane2

Returns:
Return type:	`NXOpen.Plane`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LimitPlane2

Parameters:	limitPlane2 (`NXOpen.Plane`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

LimitPoint1¶

ShelfBuilder.LimitPoint1¶

Returns or sets the limit point1

-------------------------------------

Getter Method

Signature LimitPoint1

Returns:
Return type:	`NXOpen.Point`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LimitPoint1

Parameters:	limitPoint1 (`NXOpen.Point`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

LimitPoint2¶

ShelfBuilder.LimitPoint2¶

Returns or sets the limit point2

-------------------------------------

Getter Method

Signature LimitPoint2

Returns:
Return type:	`NXOpen.Point`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LimitPoint2

Parameters:	limitPoint2 (`NXOpen.Point`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

OffsetDimension¶

ShelfBuilder.OffsetDimension¶

Returns the offset dimension

-------------------------------------

Getter Method

Signature OffsetDimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

ProjectionDir1¶

ShelfBuilder.ProjectionDir1¶

Returns the project direction 1

-------------------------------------

Getter Method

Signature ProjectionDir1

Returns:	Projection Options data
Return type:	`NXOpen.GeometricUtilities.ProjectionOptions`

New in version NX10.0.0.

License requirements: None.

ProjectionDir2¶

ShelfBuilder.ProjectionDir2¶

Returns the project direction 2

-------------------------------------

Getter Method

Signature ProjectionDir2

Returns:	Projection Options data
Return type:	`NXOpen.GeometricUtilities.ProjectionOptions`

New in version NX10.0.0.

License requirements: None.

RampLength1¶

ShelfBuilder.RampLength1¶

Returns the ramp length1

-------------------------------------

Getter Method

Signature RampLength1

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

RampLength2¶

ShelfBuilder.RampLength2¶

Returns the ramp length2

-------------------------------------

Getter Method

Signature RampLength2

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

RefType1¶

ShelfBuilder.RefType1¶

Returns or sets the ref type1

-------------------------------------

Getter Method

Signature RefType1

Returns:
Return type:	`NXOpen.Features.ShelfBuilderReferenceType`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RefType1

Parameters:	refType1 (`NXOpen.Features.ShelfBuilderReferenceType`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

RefType2¶

ShelfBuilder.RefType2¶

Returns or sets the ref type2

-------------------------------------

Getter Method

Signature RefType2

Returns:
Return type:	`NXOpen.Features.ShelfBuilderReferenceType`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RefType2

Parameters:	refType2 (`NXOpen.Features.ShelfBuilderReferenceType`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

ReverseDepthDirection¶

ShelfBuilder.ReverseDepthDirection¶

Returns or sets whether reverse depth direction

-------------------------------------

Getter Method

Signature ReverseDepthDirection

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReverseDepthDirection

Parameters:	reverseDepthDirection (bool) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

ReverseWidthDirection¶

ShelfBuilder.ReverseWidthDirection¶

Returns or sets whether reverse width direction

-------------------------------------

Getter Method

Signature ReverseWidthDirection

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReverseWidthDirection

Parameters:	reverseWidthDirection (bool) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

Selectface¶

ShelfBuilder.Selectface¶

Returns the selected face

-------------------------------------

Getter Method

Signature Selectface

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX10.0.0.

License requirements: None.

ShelfEdge¶

ShelfBuilder.ShelfEdge¶

Returns the shelf edge

-------------------------------------

Getter Method

Signature ShelfEdge

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX10.0.0.

License requirements: None.

ShelfEnd¶

ShelfBuilder.ShelfEnd¶

Returns or sets the shelf end

-------------------------------------

Getter Method

Signature ShelfEnd

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShelfEnd

Parameters:	shelfEnd (bool) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

ShelfType¶

ShelfBuilder.ShelfType¶

Returns or sets the type

-------------------------------------

Getter Method

Signature ShelfType

Returns:
Return type:	`NXOpen.Features.ShelfBuilderTypes`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShelfType

Parameters:	type (`NXOpen.Features.ShelfBuilderTypes`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

StepMethod1¶

ShelfBuilder.StepMethod1¶

Returns or sets the step method1

-------------------------------------

Getter Method

Signature StepMethod1

Returns:
Return type:	`NXOpen.Features.ShelfBuilderStepMethod`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StepMethod1

Parameters:	stepMethod1 (`NXOpen.Features.ShelfBuilderStepMethod`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

StepMethod2¶

ShelfBuilder.StepMethod2¶

Returns or sets the step method2

-------------------------------------

Getter Method

Signature StepMethod2

Returns:
Return type:	`NXOpen.Features.ShelfBuilderStepMethod`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StepMethod2

Parameters:	stepMethod2 (`NXOpen.Features.ShelfBuilderStepMethod`) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

Swap¶

ShelfBuilder.Swap¶

Returns or sets the swap

-------------------------------------

Getter Method

Signature Swap

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Swap

Parameters:	swap (bool) –

New in version NX10.0.0.

License requirements: nx_aero_design (” NX Aero Design”)

WidthDimension¶

ShelfBuilder.WidthDimension¶

Returns the width dimension

-------------------------------------

Getter Method

Signature WidthDimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

Method Detail¶

Validate¶

ShelfBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.