Represents a CMM Inspection Cparln Feature Builder. More...

Inheritance diagram for NXOpen::CAM::InspectionCparlnFeatureBuilder:

Public Types
enum	EndTypes { EndTypesRound, EndTypesSquare }
	The shape of the end of the bounded slot/tab (round or square) More...

Public Types inherited from NXOpen::CAM::OperationBuilder
enum	HoleAxisTypes { HoleAxisTypesVector, HoleAxisTypesRule, HoleAxisTypesRuleIfNoVector }
	Available types for Hole Axis Type in feature milling and hole making. More...

enum	HoleDepthTypes { HoleDepthTypesPoint, HoleDepthTypesRule }
	Available types for Hole Depth Type in feature milling and hole making. More...

enum	OptimizationBasedOnTypes { OptimizationBasedOnTypesDist, OptimizationBasedOnTypesOrient }
	Available types for optimization based on in operation. More...

enum	OptimizationDistanceTypes { OptimizationDistanceTypesDirect, OptimizationDistanceTypesTransition }
	Available types for optimization distance method in operation. More...

enum	OptimizationLevelTypes { OptimizationLevelTypesStandard, OptimizationLevelTypesAdvanced }
	Available types for optimization level in operation. More...

Public Types inherited from NXOpen::CAM::ParamBuilder
enum	OptimizationTypes { OptimizationTypesNone, OptimizationTypesMinimizeTravel, OptimizationTypesBand }
	Available types for Optimization Method in operation. More...

Public Member Functions
NXOpen::CAM::CamInspectionOperationCsysreferencetypes	CsysReferenceType ()
	Returns the coordinate system reference type Created in NX7.0.0.

NXOpen::CAM::InspectionCparlnFeatureBuilder::EndTypes	EndType ()
	Returns the end type of the bounded slot or tab (round or square) Created in NX7.0.0.

void	FlipNormal ()
	Flips the cparln inspection feature normal vector Created in NX7.0.0.

NXOpen::CAM::CamInspectionOperationInneroutertypes	InnerOuterType ()
	Returns the inspection feature inner outer type (slot/tab) Created in NX7.0.0.

double	Length ()
	Returns the length of the bounded slot or tab Created in NX7.0.0.

double	LengthDirectionI ()
	Returns the slot or tab length direction I component Created in NX7.0.0.

double	LengthDirectionJ ()
	Returns the slot or tab length direction J component Created in NX7.0.0.

double	LengthDirectionK ()
	Returns the slot or tab length direction K component Created in NX7.0.0.

NXOpen::Direction *	LengthDirVector ()
	Returns the length direction vector selector Created in NX7.0.0.

double	LocationPointX ()
	Returns the location point X coordinate at the center of the face of the slot or tab Created in NX7.0.0.

double	LocationPointY ()
	Returns the location point Y coordinate at the center of the face of the slot or tab Created in NX7.0.0.

double	LocationPointZ ()
	Returns the location point Z coordinate at the center of the face of the slot or tab Created in NX7.0.0.

NXString	Name ()
	Returns the slot or tab feature name Created in NX7.0.0.

double	NormalDirectionI ()
	Returns the slot or tab normal direction I component Created in NX7.0.0.

double	NormalDirectionJ ()
	Returns the slot or tab normal direction J component Created in NX7.0.0.

double	NormalDirectionK ()
	Returns the slot or tab normal direction K component Created in NX7.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	OffsetDistance ()
	Returns the offset distance Created in NX9.0.0.

bool	ReverseDirection ()
	Returns the reverse direction button used to reverse the normal direction vector Created in NX7.0.0.

void	ReverseOffsetDirection ()
	Reverses the offset direction Created in NX9.0.0.

NXOpen::SelectNXObjectList *	SelectedGeometry ()
	Returns the selected geometry, consisting of two parallel lines Created in NX7.0.0.

NXOpen::SelectFace *	SelectProjectionFaces ()
	Returns the selector for projection faces Created in NX7.0.0.

void	SetCsysReferenceType (NXOpen::CAM::CamInspectionOperationCsysreferencetypes csysReferenceType)
	Sets the coordinate system reference type Created in NX7.0.0.

void	SetEndType (NXOpen::CAM::InspectionCparlnFeatureBuilder::EndTypes endType)
	Sets the end type of the bounded slot or tab (round or square) Created in NX7.0.0.

void	SetInnerOuterType (NXOpen::CAM::CamInspectionOperationInneroutertypes innerOuterType)
	Sets the inspection feature inner outer type (slot/tab) Created in NX7.0.0.

void	SetLength (double length)
	Sets the length of the bounded slot or tab Created in NX7.0.0.

void	SetLengthDirectionI (double lengthDirectionI)
	Sets the slot or tab length direction I component Created in NX7.0.0.

void	SetLengthDirectionJ (double lengthDirectionJ)
	Sets the slot or tab length direction J component Created in NX7.0.0.

void	SetLengthDirectionK (double lengthDirectionK)
	Sets the slot or tab length direction K component Created in NX7.0.0.

void	SetLengthDirVector (NXOpen::Direction *lengthDirVector)
	Sets the length direction vector selector Created in NX7.0.0.

void	SetLocationPointX (double locationPointX)
	Sets the location point X coordinate at the center of the face of the slot or tab Created in NX7.0.0.

void	SetLocationPointY (double locationPointY)
	Sets the location point Y coordinate at the center of the face of the slot or tab Created in NX7.0.0.

void	SetLocationPointZ (double locationPointZ)
	Sets the location point Z coordinate at the center of the face of the slot or tab Created in NX7.0.0.

void	SetName (const NXString &name)
	Sets the slot or tab feature name Created in NX7.0.0.

void	SetName (const char *name)
	Sets the slot or tab feature name Created in NX7.0.0.

void	SetNormalDirectionI (double normalDirectionI)
	Sets the slot or tab normal direction I component Created in NX7.0.0.

void	SetNormalDirectionJ (double normalDirectionJ)
	Sets the slot or tab normal direction J component Created in NX7.0.0.

void	SetNormalDirectionK (double normalDirectionK)
	Sets the slot or tab normal direction K component Created in NX7.0.0.

void	SetReverseDirection (bool reverseDirection)
	Sets the reverse direction button used to reverse the normal direction vector Created in NX7.0.0.

void	SetWidth (double width)
	Sets the width of the bounded slot or tab Created in NX7.0.0.

void	UpdateEndType ()
	Updates cparln inspection feature characteristic parameters based on selected end type Created in NX9.0.0.

void	UpdateOffset ()
	Updates the cparln inspection feature offset distance and associated values Created in NX9.0.0.

void	UpdateParams ()
	Updates cparln inspection feature characteristic parameters based on selected geometry Created in NX7.0.0.

double	Width ()
	Returns the width of the bounded slot or tab Created in NX7.0.0.

Public Member Functions inherited from NXOpen::CAM::OperationBuilder
NXString	ChannelName ()
	Returns the channel's name Created in NX7.5.0.

NXString	Description ()
	Returns the description Created in NX9.0.0.

NXOpen::CAM::PostEventsCiBuilder *	EndOfPath ()
	Returns the end event builder Created in NX5.0.1.

NXOpen::CAM::UdeSet *	EndUdeSet ()
	Returns the end ude set Created in NX7.5.0.

NXOpen::CAM::GeometryCiBuilder *	Geometry ()
	Returns the geometry builder Created in NX5.0.0.

std::vector< double >	GetHoleAxisValues ()
	Get the Hole Axis values.

bool	GougeChecking ()
	Returns the gouge checking flag Created in NX9.0.0.

NXOpen::CAM::OperationBuilder::HoleAxisTypes	HoleAxisType ()
	Returns the Hole Axis Type Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	HoleDepth ()
	Returns the max depth distance builder Created in NX5.0.0.

NXOpen::CAM::OperationBuilder::HoleDepthTypes	HoleDepthType ()
	Returns the Hole Depth Type Created in NX5.0.0.

NXOpen::CAM::ArcOutputTypeCiBuilder *	MotionOutputBuilder ()
	Returns the motion output builder Created in NX8.0.0.

NXOpen::CAM::Notes *	Notes ()
	Returns the notes builder Created in NX9.0.0.

NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes	OptimizationBasedOn ()
	Returns the optimization based on in operation Created in NX5.0.0.

NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes	OptimizationDistanceMethod ()
	Returns the optimization distance method in operation Created in NX5.0.0.

NXOpen::CAM::OperationBuilder::OptimizationLevelTypes	OptimizationLevel ()
	Returns the optimization level in operation Created in NX5.0.0.

NXOpen::CAM::OperationDisplayOptionsBuilder *	PathDisplayOptions ()
	Returns the path display options builder Created in NX6.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	RetractDistance ()
	Returns the Retract Distance builder (inheritable double) Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	RetractDistanceOnToolAxisChange ()
	Returns the Retract Distance on Tool Axis Change builder (inheritable double) Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	SafeClearance ()
	Returns the safe clearance builder Created in NX6.0.0.

bool	SelectToolFlag ()
	Returns the user selected tool Created in NX5.0.0.

void	SetChannelName (const NXString &channel)
	Sets the channel's name Created in NX7.5.0.

void	SetChannelName (const char *channel)
	Sets the channel's name Created in NX7.5.0.

void	SetDescription (const NXString &description)
	Sets the description Created in NX9.0.0.

void	SetDescription (const char *description)
	Sets the description Created in NX9.0.0.

void	SetGougeChecking (bool gougeChecking)
	Sets the gouge checking flag Created in NX9.0.0.

void	SetHoleAxisType (NXOpen::CAM::OperationBuilder::HoleAxisTypes types)
	Sets the Hole Axis Type Created in NX5.0.0.

void	SetHoleAxisValues (const std::vector< double > &holeAxis)
	Set the Hole Axis values Created in NX5.0.0.

void	SetHoleDepthType (NXOpen::CAM::OperationBuilder::HoleDepthTypes types)
	Sets the Hole Depth Type Created in NX5.0.0.

void	SetOptimizationBasedOn (NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes optimBasedOn)
	Sets the optimization based on in operation Created in NX5.0.0.

void	SetOptimizationDistanceMethod (NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes optimDistance)
	Sets the optimization distance method in operation Created in NX5.0.0.

void	SetOptimizationLevel (NXOpen::CAM::OperationBuilder::OptimizationLevelTypes optimType)
	Sets the optimization level in operation Created in NX5.0.0.

void	SetSelectToolFlag (bool selToolFlag)
	Sets the user selected tool Created in NX5.0.0.

NXOpen::CAM::PostEventsCiBuilder *	StartOfPath ()
	Returns the start event builder Created in NX5.0.1.

NXOpen::CAM::UdeSet *	StartUdeSet ()
	Returns the start ude set Created in NX7.5.0.

NXOpen::CAM::ToolChangeCiBuilder *	ToolChangeSetting ()
	Returns the tool change builder Created in NX5.0.0.

NXOpen::CAM::ToolPathSplitParametersBuilder *	ToolPathSplitParametersBuilder ()
	Returns the tool path split Parameters Created in NX9.0.0.

Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::Ude *	CycleEvent ()
	Returns the cycle event Created in NX7.5.0.

NXOpen::CAM::Cycle *	CycleTable ()
	Returns the cycle Created in NX9.0.0.

NXOpen::CAM::ParamBuilder::OptimizationTypes	OptimizationMethod ()
	Returns the optim method Created in NX5.0.0.

void	SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
	Sets the optim method Created in NX5.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a CMM Inspection Cparln Feature Builder.

   A Cparln is a bounded slot defined by closed ended parallel lines.  <br> To create a new instance of this class, use @link CAM::InspectionOperationCollection::CreateInspectionCparlnFeatureBuilder  CAM::InspectionOperationCollection::CreateInspectionCparlnFeatureBuilder @endlink  <br>

Created in NX7.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::InspectionCparlnFeatureBuilder::EndTypes

The shape of the end of the bounded slot/tab (round or square)

Enumerator:

EndTypesRound	Bounded slot/tab has round end.
EndTypesSquare	Bounded slot/tab has square end.

Member Function Documentation

NXOpen::CAM::CamInspectionOperationCsysreferencetypes NXOpen::CAM::InspectionCparlnFeatureBuilder::CsysReferenceType ( )

Returns the coordinate system reference type
Created in NX7.0.0.

License requirements : None

NXOpen::CAM::InspectionCparlnFeatureBuilder::EndTypes NXOpen::CAM::InspectionCparlnFeatureBuilder::EndType ( )

Returns the end type of the bounded slot or tab (round or square)
Created in NX7.0.0.

License requirements : None

void NXOpen::CAM::InspectionCparlnFeatureBuilder::FlipNormal ( )

Flips the cparln inspection feature normal vector
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXOpen::CAM::CamInspectionOperationInneroutertypes NXOpen::CAM::InspectionCparlnFeatureBuilder::InnerOuterType ( )

Returns the inspection feature inner outer type (slot/tab)
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::Length ( )

Returns the length of the bounded slot or tab
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::LengthDirectionI ( )

Returns the slot or tab length direction I component
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::LengthDirectionJ ( )

Returns the slot or tab length direction J component
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::LengthDirectionK ( )

Returns the slot or tab length direction K component
Created in NX7.0.0.

License requirements : None

NXOpen::Direction* NXOpen::CAM::InspectionCparlnFeatureBuilder::LengthDirVector ( )

Returns the length direction vector selector
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::LocationPointX ( )

Returns the location point X coordinate at the center of the face of the slot or tab
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::LocationPointY ( )

Returns the location point Y coordinate at the center of the face of the slot or tab
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::LocationPointZ ( )

Returns the location point Z coordinate at the center of the face of the slot or tab
Created in NX7.0.0.

License requirements : None

NXString NXOpen::CAM::InspectionCparlnFeatureBuilder::Name ( )

Returns the slot or tab feature name
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::NormalDirectionI ( )

Returns the slot or tab normal direction I component
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::NormalDirectionJ ( )

Returns the slot or tab normal direction J component
Created in NX7.0.0.

License requirements : None

double NXOpen::CAM::InspectionCparlnFeatureBuilder::NormalDirectionK ( )

Returns the slot or tab normal direction K component
Created in NX7.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::InspectionCparlnFeatureBuilder::OffsetDistance ( )

Returns the offset distance
Created in NX9.0.0.

License requirements : None

bool NXOpen::CAM::InspectionCparlnFeatureBuilder::ReverseDirection ( )

Returns the reverse direction button used to reverse the normal direction vector
Created in NX7.0.0.

License requirements : None

void NXOpen::CAM::InspectionCparlnFeatureBuilder::ReverseOffsetDirection ( )

Reverses the offset direction
Created in NX9.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXOpen::SelectNXObjectList* NXOpen::CAM::InspectionCparlnFeatureBuilder::SelectedGeometry ( )

Returns the selected geometry, consisting of two parallel lines
Created in NX7.0.0.

License requirements : None

NXOpen::SelectFace* NXOpen::CAM::InspectionCparlnFeatureBuilder::SelectProjectionFaces ( )

Returns the selector for projection faces
Created in NX7.0.0.

License requirements : None

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetCsysReferenceType ( NXOpen::CAM::CamInspectionOperationCsysreferencetypes csysReferenceType )

Sets the coordinate system reference type
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

csysReferenceType csysreferencetype

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetEndType ( NXOpen::CAM::InspectionCparlnFeatureBuilder::EndTypes endType )

Sets the end type of the bounded slot or tab (round or square)
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

endType endtype

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetInnerOuterType ( NXOpen::CAM::CamInspectionOperationInneroutertypes innerOuterType )

Sets the inspection feature inner outer type (slot/tab)
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

innerOuterType inneroutertype

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLength ( double length )

Sets the length of the bounded slot or tab
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

length length

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLengthDirectionI ( double lengthDirectionI )

Sets the slot or tab length direction I component
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

lengthDirectionI lengthdirectioni

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLengthDirectionJ ( double lengthDirectionJ )

Sets the slot or tab length direction J component
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

lengthDirectionJ lengthdirectionj

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLengthDirectionK ( double lengthDirectionK )

Sets the slot or tab length direction K component
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

lengthDirectionK lengthdirectionk

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLengthDirVector ( NXOpen::Direction * lengthDirVector )

Sets the length direction vector selector
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

lengthDirVector lengthdirvector

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLocationPointX ( double locationPointX )

Sets the location point X coordinate at the center of the face of the slot or tab
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

locationPointX locationpointx

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLocationPointY ( double locationPointY )

Sets the location point Y coordinate at the center of the face of the slot or tab
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

locationPointY locationpointy

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetLocationPointZ ( double locationPointZ )

Sets the location point Z coordinate at the center of the face of the slot or tab
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

locationPointZ locationpointz

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetName ( const NXString & name )

Sets the slot or tab feature name
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

name name

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetName ( const char * name )

Sets the slot or tab feature name
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

name name

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetNormalDirectionI ( double normalDirectionI )

Sets the slot or tab normal direction I component
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

normalDirectionI normaldirectioni

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetNormalDirectionJ ( double normalDirectionJ )

Sets the slot or tab normal direction J component
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

normalDirectionJ normaldirectionj

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetNormalDirectionK ( double normalDirectionK )

Sets the slot or tab normal direction K component
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

normalDirectionK normaldirectionk

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetReverseDirection ( bool reverseDirection )

Sets the reverse direction button used to reverse the normal direction vector
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

reverseDirection reversedirection

void NXOpen::CAM::InspectionCparlnFeatureBuilder::SetWidth ( double width )

Sets the width of the bounded slot or tab
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters

width width

void NXOpen::CAM::InspectionCparlnFeatureBuilder::UpdateEndType ( )

Updates cparln inspection feature characteristic parameters based on selected end type
Created in NX9.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionCparlnFeatureBuilder::UpdateOffset ( )

Updates the cparln inspection feature offset distance and associated values
Created in NX9.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionCparlnFeatureBuilder::UpdateParams ( )

Updates cparln inspection feature characteristic parameters based on selected geometry
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

double NXOpen::CAM::InspectionCparlnFeatureBuilder::Width ( )

Returns the width of the bounded slot or tab
Created in NX7.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAM_InspectionCparlnFeatureBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation