NCAssistantBuilder Class

class NXOpen.CAM.NCAssistantBuilder

Bases: NXOpen.Builder

Represents a NCAssistant Builder

To create a new instance of this class, use NXOpen.CAM.CAMSetup.CreateNCAssistantBuilder()

Default values.

Property	Value
AnalysisType	Levels
AngleTolerance	0.01 (millimeters part),0.01 (inches part)
DistanceTolerance	0.01 (millimeters part), 0.0004 (inches part)
MaximumAngle	90.00 (millimeters part), 90.00 (inches part)
MaximumLevel	1000.00 (millimeters part), 50.00 (inches part)
MaximumRadius	50.00 (millimeters part), 2.00 (inches part)
MinimumAngle	-90.00 (millimeters part), -90.00 (inches part)
MinimumLevel	-1000.00 (millimeters part), -50.00 (inches part)
MinimumRadius	-50.00 (millimeters part), -2.00 (inches part)
RadiusTolerance	0.01 (millimeters part), 0.0004 (inches part)

New in version NX7.5.0.

Properties

Property	Description
AnalysisType	Returns or sets the Analysis Type
AngleTolerance	Returns or sets the Angle Tolerance
DistanceTolerance	Returns or sets the Distance Tolerance
FacesToAnalyze	Returns the Faces to Analyze
MaximumAngle	Returns or sets the Maximum Angle
MaximumLevel	Returns or sets the Maximum Level
MaximumRadius	Returns or sets the Maximum Radius
MinimumAngle	Returns or sets the Minimum Angle
MinimumLevel	Returns or sets the Minimum Level
MinimumRadius	Returns or sets the Minimum Radius
RadiusTolerance	Returns or sets the Radius Tolerance
ReferencePlane	Returns or sets the Reference Plane
ReferenceVector	Returns or sets the Reference Vector
SaveFaceColors	Returns or sets the Save Face Colors on Exit
Tag	Returns the Tag for this object.

Methods

Method	Description
AnalyzeGeometry	The action of Analyze Geometry button.
Commit	Commits any edits that have been applied to the builder.
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.
GetObject	Returns the object currently being edited by this builder.
GetResults	The analyze result.
Information	The action of Information button.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

NCAssistantBuilderAnalysisTypes Enumeration

Analysis Type

Property Detail

AnalysisType

NCAssistantBuilder.AnalysisType

Returns or sets the Analysis Type

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

Getter Method

Signature AnalysisType

Returns:the Analysis Type Return type:NXOpen.CAM.NCAssistantBuilderAnalysisTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature AnalysisType

Parameters:analysisType (NXOpen.CAM.NCAssistantBuilderAnalysisTypes) – the Analysis Type

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

AngleTolerance

NCAssistantBuilder.AngleTolerance

Returns or sets the Angle Tolerance

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

Getter Method

Signature AngleTolerance

Returns:the Angle Tolerance Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature AngleTolerance

Parameters:angleTolerance (float) – the Angle Tolerance

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

DistanceTolerance

NCAssistantBuilder.DistanceTolerance

Returns or sets the Distance Tolerance

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

Getter Method

Signature DistanceTolerance

Returns:the Distance Tolerance Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature DistanceTolerance

Parameters:distanceTolerance (float) – the Distance Tolerance

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

FacesToAnalyze

NCAssistantBuilder.FacesToAnalyze

Returns the Faces to Analyze

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

Getter Method

Signature FacesToAnalyze

Returns:the Faces to Analyze Return type:NXOpen.SelectFaceList

New in version NX7.5.0.

License requirements: None.

MaximumAngle

NCAssistantBuilder.MaximumAngle

Returns or sets the Maximum Angle

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

Getter Method

Signature MaximumAngle

Returns:the Maximum Angle Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MaximumAngle

Parameters:maximum (float) – the Maximum Angle

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

MaximumLevel

NCAssistantBuilder.MaximumLevel

Returns or sets the Maximum Level

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

Getter Method

Signature MaximumLevel

Returns:the Maximum Level Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MaximumLevel

Parameters:maximum (float) – the Maximum Level

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

MaximumRadius

NCAssistantBuilder.MaximumRadius

Returns or sets the Maximum Radius

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

Getter Method

Signature MaximumRadius

Returns:the Maximum Radius Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MaximumRadius

Parameters:maximum (float) – the Maximum Radius

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

MinimumAngle

NCAssistantBuilder.MinimumAngle

Returns or sets the Minimum Angle

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

Getter Method

Signature MinimumAngle

Returns:the Minimum Angle Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MinimumAngle

Parameters:minimum (float) – the Minimum Angle

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

MinimumLevel

NCAssistantBuilder.MinimumLevel

Returns or sets the Minimum Level

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

Getter Method

Signature MinimumLevel

Returns:the Minimum Level Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MinimumLevel

Parameters:minimum (float) – the Minimum Level

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

MinimumRadius

NCAssistantBuilder.MinimumRadius

Returns or sets the Minimum Radius

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

Getter Method

Signature MinimumRadius

Returns:the Minimum Radius Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MinimumRadius

Parameters:minimum (float) – the Minimum Radius

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

RadiusTolerance

NCAssistantBuilder.RadiusTolerance

Returns or sets the Radius Tolerance

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

Getter Method

Signature RadiusTolerance

Returns:the Radius Tolerance Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature RadiusTolerance

Parameters:radiusTolerance (float) – the Radius Tolerance

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

ReferencePlane

NCAssistantBuilder.ReferencePlane

Returns or sets the Reference Plane

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

Getter Method

Signature ReferencePlane

Returns:the Reference Plane Return type:NXOpen.Plane

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ReferencePlane

Parameters:referencePlane (NXOpen.Plane) – the Reference Plane

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

ReferenceVector

NCAssistantBuilder.ReferenceVector

Returns or sets the Reference Vector

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

Getter Method

Signature ReferenceVector

Returns:the Reference Vector Return type:NXOpen.Direction

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ReferenceVector

Parameters:referenceVector (NXOpen.Direction) – the Reference Vector

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

SaveFaceColors

NCAssistantBuilder.SaveFaceColors

Returns or sets the Save Face Colors on Exit

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

Getter Method

Signature SaveFaceColors

Returns:the Save Face Colors on Exit Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SaveFaceColors

Parameters:saveFaceColorsOnExit (bool) – the Save Face Colors on Exit

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

AnalyzeGeometry

NCAssistantBuilder.AnalyzeGeometry

The action of Analyze Geometry button.

Signature AnalyzeGeometry()

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

GetResults

NCAssistantBuilder.GetResults

The analyze result.

After analyzing the selected faces,it will return the analyzed faces and the corresponding double values,including depth, corner or fillets radius or draft angle.

Signature GetResults()

Returns:a tuple Return type:A tuple consisting of (success, analyzedFaces, doubleValue). success is a bool. success or notanalyzedFaces is a list of NXOpen.Face. the faces found during analyze run, it is need SM_freedoubleValue is a list of float. the corresponding analysis value of the face, depth, corner or fillets radius or draft angle

New in version NX7.5.0.

License requirements: None.

Information

NCAssistantBuilder.Information

The action of Information button.

It will bring out a text dialog

Signature Information()

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

Validate

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