cam setup
To obtain an instance of this class, use NXOpen::Part::CAMSetup

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::CAM::CAMSetup:

Public Types
enum	OutputUnits { OutputUnitsInch, OutputUnitsMetric, OutputUnitsPostDefined }
	Output units used in output clsf and postprocess. More...

enum	Paste { PasteBefore, PasteInside, PasteAfter }
	Paste position. More...

enum	PostprocessSettingsOutputWarning { PostprocessSettingsOutputWarningYes, PostprocessSettingsOutputWarningNo, PostprocessSettingsOutputWarningPostDefined }
	Output warning setting for Postprocess. More...

enum	PostprocessSettingsReviewTool { PostprocessSettingsReviewToolOn, PostprocessSettingsReviewToolOff, PostprocessSettingsReviewToolPostDefined }
	Review tool setting for Postprocess. More...

enum	Ude { UdeStart, UdeEnd }
	The UDE type. More...

enum	View { ViewProgramOrder, ViewMachineMethod, ViewGeometry, ViewMachineTool }
	ONT view. More...

Public Types inherited from NXOpen::CAM::CAMObject
enum	Attr { AttrProjDiffTaxis = 1, AttrProfileFlipMside, AttrBndSplineTangent, AttrBlankNormalDiffTaxis, AttrBndHasSleepObj, AttrClrnrNotParallelTaxis, AttrBndNotParallelFloor, AttrFloorNotUpToDate, AttrSingleProfileWithFirstCut, AttrCutterConversionProblem, AttrAcceptDrivePosition = 100, AttrReparametrization = 110, AttrBetweenFromStart = 120, AttrCurveCutRange = 130, AttrFixGssmCornerData = 140, AttrPlmConversion = 150, AttrPlmFeedcomp, AttrPlmFillet, AttrPlmSlowdown, AttrPlmGeometry, AttrWedmPoints = 160, AttrCavityMillInheritTrimBnds = 170, AttrRtdObsolete = 1000, AttrZlevelHolderParamChange = 2000, AttrNcmObsoleteSeqControl = 2100, AttrNcmObsoleteCustomFeed, AttrNcmObsoleteLocalRetract, AttrNcmClearTraversalZero, AttrNcmObsoleteEngretToClearance, AttrGmcInvalidNxVersion = 2201, AttrProbingInvalidNxVersion, AttrInspPathInvalidNxVersion = 2300, AttrCustomDataGougingObsolete, AttrCustomDataGougingPartObsolete, AttrCustomDataGougingDriveObsolete, AttrCustomDataIgnoreLoopsObsolete, AttrCustomDataIgnoreLoopsRemoved, AttrLimitToolRunOn = 2400 }
	Represents the CAM attribute type. More...

enum	FeedRateUnit { FeedRateUnitNone, FeedRateUnitPerMinute, FeedRateUnitPerRevolution }
	The unit of feed rate. More...

enum	Status { StatusComplete, StatusRepost, StatusRegen, StatusApproved = 4 }
	The status of the object. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
void	ApproveObjects (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Approve objects Created in NX6.0.0. More...

void	BufferObjects (NXOpen::CAM::CAMSetup::View view, const std::vector< NXOpen::CAM::CAMObject * > &objectsToBeBuffered)
	Buffer objects to the clipboard and prepare for copy later Created in NX6.0.0. More...

NXOpen::CAM::NCGroupCollection *	CAMGroupCollection ()
	Returns the NCGroupCollection instance belonging to this setup Created in NX3.0.0. More...

NXOpen::CAM::OperationCollection *	CAMOperationCollection ()
	Returns the OperationCollection instance belonging to this setup Created in NX3.0.0. More...

std::vector < NXOpen::CAM::CAMObject * >	CopyObjects (NXOpen::CAM::CAMSetup::View view, const std::vector< NXOpen::CAM::CAMObject * > &objectsToBeMoved, NXOpen::CAM::CAMObject *destinationObject, NXOpen::CAM::CAMSetup::Paste pastePosition)
	Copy objects. More...

std::vector < NXOpen::CAM::CAMObject * >	CopyObjectsWithReference (NXOpen::CAM::CAMSetup::View view, const std::vector< NXOpen::CAM::CAMObject * > &objectsToBeMoved, NXOpen::CAM::CAMObject *destinationObject, NXOpen::CAM::CAMSetup::Paste pastePosition)
	Copy objects with reference. More...

NXOpen::CAM::CutDepthChecker *	CreateCutDepthChecker ()
	Creates a Cut Depth Checker. More...

NXOpen::CAM::FeatureProcessBuilder *	CreateFeatureProcessBuilder ()
	Creates a CAM.FeatureProcessBuilder. More...

NXOpen::CAM::FeatureRecognitionBuilder *	CreateFeatureRecognitionBuilder (NXOpen::CAM::CAMObject *param)
	Creates a CAM.FeatureRecognitionBuilder. More...

NXOpen::CAM::FeatureTeaching *	CreateFeatureTeaching (NXOpen::CAM::CAMObject *param)
	Creates a CAM.FeatureTeaching. More...

NXOpen::CAM::ObjectsFeedsBuilder *	CreateFeedsBuilder (const std::vector< NXOpen::CAM::CAMObject * > &params)
	Create Feeds builder. More...

NXOpen::CAM::FeedsOptimizeBuilder *	CreateFeedsOptimizeBuilder (NXOpen::CAM::CAMObject *param)
	Creates a feeds optimize builder. More...

NXOpen::CAM::NCAssistantBuilder *	CreateNCAssistantBuilder ()
	Creates NC Assistant builder. More...

NXOpen::CAM::NcmctPartMountingBuilder *	CreateNcmctPartMountingBuilder (const NXString &libRef)
	Creates a Part Mounting Builder. More...

NXOpen::CAM::NcmctPartMountingBuilder *	CreateNcmctPartMountingBuilder (const char *libRef)
	Creates a Part Mounting Builder. More...

NXOpen::CAM::ObjectNotes *	CreateObjectNotes (NXOpen::CAM::CAMObject *opr)
	Create Notes. More...

NXOpen::CAM::ObjectsUdeSet *	CreateObjectsUdeSet (const std::vector< NXOpen::CAM::CAMObject * > &params, NXOpen::CAM::CAMSetup::Ude udeType)
	Create ObjectsUdeSet. More...

NXOpen::CAM::ObjectsUdeSet *	CreateObjectsUdeSet (const std::vector< NXOpen::CAM::CAMObject * > &params, NXOpen::CAM::CAMSetup::Ude udeType, const std::vector< NXOpen::CAM::CAMFeature * > &features)
	Create ObjectsUdeSet for features. More...

NXOpen::CAM::OperationTeaching *	CreateOperationTeaching (NXOpen::CAM::CAMObject *param)
	Creates a CAM.OperationTeaching. More...

NXOpen::CAM::OperationTransformBuilder *	CreateOperationTransformBuilder (const std::vector< NXOpen::CAM::CAMObject * > &objectsToTransform)
	Create Transform builder. More...

NXOpen::CAM::PreprocessGeometryBuilder *	CreatePreprocessGeometryBuilder ()
	Creates a preprocess geometry builder. More...

NXOpen::CAM::SurfaceRegions *	CreateSurfaceRegions (NXOpen::Features::Feature *feature)
	Creates a surface regions builder. More...

NXOpen::CAM::ToolPathDivideBuilder *	CreateToolPathDivideBuilder (const std::vector< NXOpen::CAM::CAMObject * > &tpObjectsToDivide)
	Create Tool Path Divide builder. More...

NXOpen::CAM::ToolPathSplitBuilder *	CreateToolPathSplitBuilder (const std::vector< NXOpen::CAM::CAMObject * > &tpObjectsToDivide)
	Create Tool Path Split by Holder builder. More...

NXOpen::CAM::ToolPathTiltBuilder *	CreateToolPathTiltBuilder (const std::vector< NXOpen::CAM::CAMObject * > &tpObjectsToTilt)
	Create Tool Path Tilt builder. More...

void	CustomizationUpdateFromObject (NXOpen::CAM::CAMObject destinationObject, NXOpen::CAM::CAMObject sourceObject)
	Customize from Object Created in NX7.5.0. More...

void	CustomizationUpdateFromTemplate (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Customize from Template Created in NX7.5.0. More...

void	CutObjects (NXOpen::CAM::CAMSetup::View view, const std::vector< NXOpen::CAM::CAMObject * > &objectsToBeMoved)
	Cut objects Created in NX4.0.0. More...

void	Delete3dWorkpieces (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Delete 3D workpieces of the selected operations Created in NX9.0.0. More...

void	DeleteToolPath (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Delete tool path Created in NX4.0.0. More...

void	DeleteVnckMachineData ()
	Removes vnck machine data Created in NX8.5.0. More...

void	DivideToolPaths (const std::vector< NXOpen::CAM::CAMObject * > &objects, NXOpen::CAM::ToolPathDivideBuilder *builder)
	Tool Path Divide Created in NX4.0.0. More...

void	GenerateToolPath (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Generate tool path Created in NX4.0.0. More...

NXOpen::CAM::CAMObject *	GetCamExitObject ()
	Get the param object which is invoking the exit API. More...

NXString	GetMachineLibref ()
	Get machine libref. More...

NXString	GetPartMaterial ()
	Part material. More...

void	GetPartMaterialData (NXString libref, NXString name, NXString description, NXString code, NXString *hardness)
	Get part material data Created in NX8.0.2. More...

NXOpen::CAM::NCGroup *	GetRoot (NXOpen::CAM::CAMSetup::View branch)
	Get root of the specified branch. More...

void	GougeCheck (const std::vector< NXOpen::CAM::CAMObject * > &objects, bool checkForHolderCollision)
	Gouge Check More...

void	GougeCheck (const std::vector< NXOpen::CAM::CAMObject * > &objects, bool checkForHolderCollision, bool useParametric, bool useUserdefStock, double userdefStock)
	Gouge Check Created in NX9.0.0. More...

bool	HasSuppressedGeom (NXOpen::CAM::CAMObject *param)
	Check for suppressed geometry. More...

bool	IsGroup (NXOpen::CAM::CAMObject *camObject)
	Check if the specified object is a group. More...

bool	IsLibrarySetup ()
	Returns the flag indicating if this setup is initialized from a library. More...

bool	IsOperation (NXOpen::CAM::CAMObject *camobject)
	Check if the specified object is an operation. More...

bool	IsToolPathLocked (NXOpen::CAM::CAMObject *object)
	Lock Tool Path. More...

NXString	LibraryReference ()
	Returns the template library reference Created in NX7.5.3. More...

void	ListToolPath (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	List tool path Created in NX4.0.0. More...

void	LockToolPaths (const std::vector< NXOpen::CAM::CAMObject * > &objects, bool lock)
	Lock Tool Path Created in NX6.0.0. More...

void	MinToolLen (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Minimum tool length Created in NX7.5.0. More...

void	MoveObjects (NXOpen::CAM::CAMSetup::View view, const std::vector< NXOpen::CAM::CAMObject * > &objectsToBeMoved, NXOpen::CAM::CAMObject *destinationObject, NXOpen::CAM::CAMSetup::Paste pastePosition)
	Move objects Created in NX4.0.0. More...

void	Optimize (const std::vector< NXOpen::CAM::CAMObject * > &objects, bool consolidateTools, bool minimizeToolChanges, bool createOptimizationGroup)
	Optimize Created in NX6.0.0. More...

bool	OutputBallCenter ()
	Returns the setting for ball center output at posting time Created in NX9.0.1. More...

void	OutputClsf (const std::vector< NXOpen::CAM::CAMObject * > &objects, const NXString &clsfFormat, const NXString &outfileName, NXOpen::CAM::CAMSetup::OutputUnits outputUnits)
	Output CLSF Created in NX4.0.0. More...

void	OutputClsf (const std::vector< NXOpen::CAM::CAMObject * > &objects, const char clsfFormat, const char outfileName, NXOpen::CAM::CAMSetup::OutputUnits outputUnits)
	Output CLSF Created in NX4.0.0. More...

void	ParallelCreate3d (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Parallel create 3D Created in NX9.0.1. More...

void	ParallelGenerate (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Parallel Generate tool path Created in NX7.5.5. More...

void	Postprocess (const std::vector< NXOpen::CAM::CAMObject * > &objects, const NXString &machineType, const NXString &outfileName, NXOpen::CAM::CAMSetup::OutputUnits outputUnits)
	Postprocess Created in NX4.0.0. More...

void	Postprocess (const std::vector< NXOpen::CAM::CAMObject * > &objects, const char machineType, const char outfileName, NXOpen::CAM::CAMSetup::OutputUnits outputUnits)
	Postprocess Created in NX4.0.0. More...

void	PostprocessWithSetting (const std::vector< NXOpen::CAM::CAMObject * > &objects, const NXString &machineType, const NXString &outfileName, NXOpen::CAM::CAMSetup::OutputUnits outputUnits, NXOpen::CAM::CAMSetup::PostprocessSettingsOutputWarning outputWarning, NXOpen::CAM::CAMSetup::PostprocessSettingsReviewTool reviewTool)
	Postprocess Created in NX8.0.0. More...

void	PostprocessWithSetting (const std::vector< NXOpen::CAM::CAMObject * > &objects, const char machineType, const char outfileName, NXOpen::CAM::CAMSetup::OutputUnits outputUnits, NXOpen::CAM::CAMSetup::PostprocessSettingsOutputWarning outputWarning, NXOpen::CAM::CAMSetup::PostprocessSettingsReviewTool reviewTool)
	Postprocess Created in NX8.0.0. More...

void	RemoveDependencies (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Remove dependencies of selected objects Created in NX9.0.0. More...

void	RemoveMachine ()
	Removes: More...

void	RemoveSuppressedGeom (NXOpen::CAM::CAMObject *param)
	Remove suppressed geometry Created in NX5.0.4. More...

void	ReplayToolPath (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Replay tool path Created in NX4.0.0. More...

void	RestoreDependencies (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Restore dependencies of selected objects Created in NX9.0.0. More...

NXOpen::CAM::NCGroup *	RetrieveDevice (const NXString &libRef)
	Retrieve a device from library. More...

NXOpen::CAM::NCGroup *	RetrieveDevice (const char *libRef)
	Retrieve a device from library. More...

NXOpen::CAM::Tool *	RetrieveTool (const NXString &libRef, bool *success)
	Retrieve a tool from library. More...

NXOpen::CAM::Tool *	RetrieveTool (const char libRef, bool success)
	Retrieve a tool from library. More...

NXOpen::CAM::Tool *	RetrieveTool (const NXString &libRef, NXOpen::CAM::CAMObject target, NXOpen::CAM::CAMObject nextTarget, bool success)
	Retrieve a tool from library to the target. More...

NXOpen::CAM::Tool *	RetrieveTool (const char libRef, NXOpen::CAM::CAMObject target, NXOpen::CAM::CAMObject *nextTarget, bool success)
	Retrieve a tool from library to the target. More...

void	SetLibraryReference (const NXString &libraryReference)
	Sets the template library reference Created in NX7.5.3. More...

void	SetLibraryReference (const char *libraryReference)
	Sets the template library reference Created in NX7.5.3. More...

std::vector < NXOpen::CAM::CAMObject::ErrorItem >	SetMachiningData (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Set Machining Data. More...

void	SetOutputBallCenter (bool outputBallCenter)
	Sets the setting for ball center output at posting time Created in NX9.0.1. More...

void	SetPartMaterial (const NXString &libRef)
	Part material Created in NX8.0.1. More...

void	SetPartMaterial (const char *libRef)
	Part material Created in NX8.0.1. More...

void	SetTemplateStatus (const std::vector< NXOpen::CAM::CAMObject * > &objects, bool useAsParent, bool createIfParentCreated)
	Set Template status Created in NX6.0.0. More...

void	Show2dWorkpiece (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Show 2D workpiece Created in NX4.0.0. More...

void	Show2dWorkpieceIn (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Show ingoing 2D workpiece Created in NX5.0.0. More...

void	Show2dWorkpieceOut (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Show outgoing 2D workpiece Created in NX5.0.0. More...

void	Show3dWorkpiece (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Show 3D workpiece Created in NX4.0.0. More...

void	ShowSpinning3dWorkpiece (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Show spinning 3D workpiece Created in NX9.0.1. More...

void	SplitToolPaths (const std::vector< NXOpen::CAM::CAMObject * > &objects, NXOpen::CAM::ToolPathSplitBuilder *builder)
	Tool Path Split by Holder Created in NX6.0.0. More...

void	SwitchLayerLayout (NXOpen::CAM::CAMObject *object)
	Switch Layer and Layout Created in NX9.0.1. More...

void	TiltToolPaths (const std::vector< NXOpen::CAM::CAMObject * > &objects, NXOpen::CAM::ToolPathTiltBuilder *builder)
	Tool Path Tilt Created in NX7.5.0. More...

void	UnapproveObjects (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Unapprove objects Created in NX7.5.0. More...

void	UpdateGeometryDependencies (const std::vector< NXOpen::CAM::CAMObject * > &objects)
	Update geometry dependencies of selected objects Created in NX9.0.0. More...

Public Member Functions inherited from NXOpen::CAM::CAMObject
bool	GetBooleanValue (const NXString &title)
	Get the boolean value of the parameter index from the object. More...

bool	GetBooleanValue (const char *title)
	Get the boolean value of the parameter index from the object. More...

NXOpen::CAM::CAMObject::FeedRateUnit	GetFeedRate (const NXString &title, double *value)
	Get the feed rate value and unit of the parameter index from the object. More...

NXOpen::CAM::CAMObject::FeedRateUnit	GetFeedRate (const char title, double value)
	Get the feed rate value and unit of the parameter index from the object. More...

int	GetFeedRateColor (const NXString &title)
	Get the feed rate color of the parameter index from the object. More...

int	GetFeedRateColor (const char *title)
	Get the feed rate color of the parameter index from the object. More...

std::vector< int >	GetIntegerArrayValue (const NXString &title)
	Get the integer array value of the parameter index from the object. More...

std::vector< int >	GetIntegerArrayValue (const char *title)
	Get the integer array value of the parameter index from the object. More...

int	GetIntegerValue (const NXString &title)
	Get the integer value of the parameter index from the object. More...

int	GetIntegerValue (const char *title)
	Get the integer value of the parameter index from the object. More...

NXOpen::NXObject *	GetObject (const NXString &title)
	Get the object value of the parameter index from the object. More...

NXOpen::NXObject *	GetObject (const char *title)
	Get the object value of the parameter index from the object. More...

std::vector< NXOpen::NXObject * >	GetObjectArrayValue (const NXString &title)
	Get the object array value of the parameter index from the object. More...

std::vector< NXOpen::NXObject * >	GetObjectArrayValue (const char *title)
	Get the object array value of the parameter index from the object. More...

std::vector< double >	GetRealArrayValue (const NXString &title)
	Get the real array value of the parameter index from the object. More...

std::vector< double >	GetRealArrayValue (const char *title)
	Get the real array value of the parameter index from the object. More...

double	GetRealValue (const NXString &title)
	Get the real value of the parameter index from the object. More...

double	GetRealValue (const char *title)
	Get the real value of the parameter index from the object. More...

NXOpen::CAM::CAMObject::Status	GetStatus ()
	Get the status of the input object. More...

std::vector< NXString >	GetStringArrayValue (const NXString &title)
	Get the string array value of the parameter index from the object. More...

std::vector< NXString >	GetStringArrayValue (const char *title)
	Get the string array value of the parameter index from the object. More...

NXString	GetStringValue (const NXString &title)
	Get the string value of the parameter index from the object. More...

NXString	GetStringValue (const char *title)
	Get the string value of the parameter index from the object. More...

int	GetWireEdmFeedRate (const NXString &title, double *value)
	Get the feed rate value and side of the parameter index from the object, side is only used in wire edm. More...

int	GetWireEdmFeedRate (const char title, double value)
	Get the feed rate value and side of the parameter index from the object, side is only used in wire edm. More...

bool	Has911Attribute (NXOpen::CAM::CAMObject::Attr attrId)
	Check if a 911 attribute exists in an object. More...

void	Remove911Attribute (NXOpen::CAM::CAMObject::Attr attrId)
	Remove a specific 911 attribute from an object. More...

void	RemoveAll911Attributes ()
	Remove all 911 attributes from an object. More...

void	SetBooleanValue (const NXString &title, bool value)
	Set a boolean value to the parameter index for the object. More...

void	SetBooleanValue (const char *title, bool value)
	Set a boolean value to the parameter index for the object. More...

void	SetFeedRate (const NXString &title, double value, NXOpen::CAM::CAMObject::FeedRateUnit unit)
	Set feed rate value and unit to the parameter index for the object. More...

void	SetFeedRate (const char *title, double value, NXOpen::CAM::CAMObject::FeedRateUnit unit)
	Set feed rate value and unit to the parameter index for the object. More...

void	SetFeedRateColor (const NXString &title, int value)
	Set feed rate display color to the parameter index for the object. More...

void	SetFeedRateColor (const char *title, int value)
	Set feed rate display color to the parameter index for the object. More...

void	SetIntegerArrayValue (const NXString &title, const std::vector< int > &value)
	Set integer array value to the parameter index for the object. More...

void	SetIntegerArrayValue (const char *title, const std::vector< int > &value)
	Set integer array value to the parameter index for the object. More...

void	SetIntegerValue (const NXString &title, int value)
	Set an integer value to the parameter index for the object. More...

void	SetIntegerValue (const char *title, int value)
	Set an integer value to the parameter index for the object. More...

void	SetObject (const NXString &title, NXOpen::NXObject *value)
	Set a object to the parameter index for the object. More...

void	SetObject (const char title, NXOpen::NXObject value)
	Set a object to the parameter index for the object. More...

void	SetObjectArrayValue (const NXString &title, const std::vector< NXOpen::NXObject * > &value)
	Set object array to the parameter index for the object Created in NX4.0.0. More...

void	SetObjectArrayValue (const char title, const std::vector< NXOpen::NXObject > &value)
	Set object array to the parameter index for the object Created in NX4.0.0. More...

void	SetRealArrayValue (const NXString &title, const std::vector< double > &value)
	Set real array to the parameter index for the object. More...

void	SetRealArrayValue (const char *title, const std::vector< double > &value)
	Set real array to the parameter index for the object. More...

void	SetRealValue (const NXString &title, double value)
	Set a real value to the parameter index for the object. More...

void	SetRealValue (const char *title, double value)
	Set a real value to the parameter index for the object. More...

void	SetStringArrayValue (const NXString &title, std::vector< NXString > &value)
	Set string array to the parameter index for the object Created in NX4.0.0. More...

void	SetStringArrayValue (const char *title, std::vector< NXString > &value)
	Set string array to the parameter index for the object Created in NX4.0.0. More...

void	SetStringValue (const NXString &title, const NXString &value)
	Set a string value to the parameter index for the object. More...

void	SetStringValue (const char title, const char value)
	Set a string value to the parameter index for the object. More...

void	SetWireEdmFeedRate (const NXString &title, double value, int side)
	Set feed rate value and side to the parameter index for the object, side is only used in wire edm. More...

void	SetWireEdmFeedRate (const char *title, double value, int side)
	Set feed rate value and side to the parameter index for the object, side is only used in wire edm. More...

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type. More...

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index. More...

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title. More...

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title. More...

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index. More...

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index. More...

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title. More...

double	GetRealAttribute (const char *title)
	Gets a real attribute by title. More...

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index. More...

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index. More...

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title. More...

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title. More...

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index. More...

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index. More...

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title. More...

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title. More...

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...

virtual NXString	Name ()
	Returns the custom name of the object. More...

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...

virtual void	Print ()
	Prints a representation of this object to the system log file. More...

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute. More...

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute. More...

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute. More...

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute. More...

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute. More...

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute. More...

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...

virtual void	SetName (const char *name)
	Sets the custom name of the object. More...

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string. More...

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string. More...

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute. More...

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute. More...

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

cam setup
To obtain an instance of this class, use NXOpen::Part::CAMSetup

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::CAMSetup::OutputUnits

Output units used in output clsf and postprocess.

Enumerator
OutputUnitsInch	use inch as output unit
OutputUnitsMetric	use metric as output unit
OutputUnitsPostDefined	use post defined unit as output unit

enum NXOpen::CAM::CAMSetup::Paste

Paste position.

Enumerator
PasteBefore	paste before
PasteInside	paste inside
PasteAfter	paste after

enum NXOpen::CAM::CAMSetup::PostprocessSettingsOutputWarning

Output warning setting for Postprocess.

Enumerator
PostprocessSettingsOutputWarningYes	output the warning file
PostprocessSettingsOutputWarningNo	not output the warning file
PostprocessSettingsOutputWarningPostDefined	use post defined setting

enum NXOpen::CAM::CAMSetup::PostprocessSettingsReviewTool

Review tool setting for Postprocess.

Enumerator
PostprocessSettingsReviewToolOn	show the review tool window
PostprocessSettingsReviewToolOff	not show the review tool window
PostprocessSettingsReviewToolPostDefined	use post defined setting

enum NXOpen::CAM::CAMSetup::Ude

The UDE type.

Enumerator
UdeStart	start UDE
UdeEnd	end UDE

enum NXOpen::CAM::CAMSetup::View

ONT view.

Enumerator
ViewProgramOrder	program order
ViewMachineMethod	machine method
ViewGeometry	geometry
ViewMachineTool	machine tool

Member Function Documentation

void NXOpen::CAM::CAMSetup::ApproveObjects ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Approve objects
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::BufferObjects	(	NXOpen::CAM::CAMSetup::View	view,
		const std::vector< NXOpen::CAM::CAMObject * > &	objectsToBeBuffered
	)

Buffer objects to the clipboard and prepare for copy later
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

view	view
objectsToBeBuffered	array of objects to be buffered

NXOpen::CAM::NCGroupCollection* NXOpen::CAM::CAMSetup::CAMGroupCollection ( )

Returns the NCGroupCollection instance belonging to this setup
Created in NX3.0.0.

NXOpen::CAM::OperationCollection* NXOpen::CAM::CAMSetup::CAMOperationCollection ( )

Returns the OperationCollection instance belonging to this setup
Created in NX3.0.0.

std::vector<NXOpen::CAM::CAMObject *> NXOpen::CAM::CAMSetup::CopyObjects	(	NXOpen::CAM::CAMSetup::View	view,
		const std::vector< NXOpen::CAM::CAMObject * > &	objectsToBeMoved,
		NXOpen::CAM::CAMObject *	destinationObject,
		NXOpen::CAM::CAMSetup::Paste	pastePosition
	)

Copy objects.

Returns: array of new objects
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

view	view
objectsToBeMoved	array of objects to be moved
destinationObject	the destination object
pastePosition	paste inside or after the destination object

std::vector<NXOpen::CAM::CAMObject *> NXOpen::CAM::CAMSetup::CopyObjectsWithReference	(	NXOpen::CAM::CAMSetup::View	view,
		const std::vector< NXOpen::CAM::CAMObject * > &	objectsToBeMoved,
		NXOpen::CAM::CAMObject *	destinationObject,
		NXOpen::CAM::CAMSetup::Paste	pastePosition
	)

Copy objects with reference.

Returns: array of new objects
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

view	view
objectsToBeMoved	array of objects to be moved
destinationObject	the destination object
pastePosition	paste inside or after the destination object

NXOpen::CAM::CutDepthChecker* NXOpen::CAM::CAMSetup::CreateCutDepthChecker ( )

Creates a Cut Depth Checker.

Note: Commit will not return an object

Returns: the cut depth checker object
Created in NX8.5.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::FeatureProcessBuilder* NXOpen::CAM::CAMSetup::CreateFeatureProcessBuilder ( )

Creates a CAM.FeatureProcessBuilder.

Returns: Created in NX7.5.0.

License requirements : ug_holemaking ("UG Holemaking")

NXOpen::CAM::FeatureRecognitionBuilder* NXOpen::CAM::CAMSetup::CreateFeatureRecognitionBuilder ( NXOpen::CAM::CAMObject * param )

Creates a CAM.FeatureRecognitionBuilder.

Returns: Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

param not used

NXOpen::CAM::FeatureTeaching* NXOpen::CAM::CAMSetup::CreateFeatureTeaching ( NXOpen::CAM::CAMObject * param )

Creates a CAM.FeatureTeaching.

Returns: Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

param not used

NXOpen::CAM::ObjectsFeedsBuilder* NXOpen::CAM::CAMSetup::CreateFeedsBuilder ( const std::vector< NXOpen::CAM::CAMObject * > & params )

Create Feeds builder.

Returns: created object feed builder
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

params array of objects

NXOpen::CAM::FeedsOptimizeBuilder* NXOpen::CAM::CAMSetup::CreateFeedsOptimizeBuilder ( NXOpen::CAM::CAMObject * param )

Creates a feeds optimize builder.

Returns: feeds optimize builder created
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

param the object to be edited

NXOpen::CAM::NCAssistantBuilder* NXOpen::CAM::CAMSetup::CreateNCAssistantBuilder ( )

Creates NC Assistant builder.

Returns: NC Assistant builder created
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::NcmctPartMountingBuilder* NXOpen::CAM::CAMSetup::CreateNcmctPartMountingBuilder ( const NXString & libRef )

Creates a Part Mounting Builder.

Note: Commit a Part Mounting Builder will perform the Part Mounting and no object is returned.

Returns: part mounting builder created
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

libRef a unique library reference identifier
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::NcmctPartMountingBuilder* NXOpen::CAM::CAMSetup::CreateNcmctPartMountingBuilder ( const char * libRef )

Creates a Part Mounting Builder.

Note: Commit a Part Mounting Builder will perform the Part Mounting and no object is returned.

Returns: part mounting builder created
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

libRef a unique library reference identifier
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::ObjectNotes* NXOpen::CAM::CAMSetup::CreateObjectNotes ( NXOpen::CAM::CAMObject * opr )

Create Notes.

Returns: created object notes
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

opr opr

NXOpen::CAM::ObjectsUdeSet* NXOpen::CAM::CAMSetup::CreateObjectsUdeSet	(	const std::vector< NXOpen::CAM::CAMObject * > &	params,
		NXOpen::CAM::CAMSetup::Ude	udeType
	)

Create ObjectsUdeSet.

Returns: created objects ude set
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

params	array of operations or groups
udeType	ude type

NXOpen::CAM::ObjectsUdeSet* NXOpen::CAM::CAMSetup::CreateObjectsUdeSet	(	const std::vector< NXOpen::CAM::CAMObject * > &	params,
		NXOpen::CAM::CAMSetup::Ude	udeType,
		const std::vector< NXOpen::CAM::CAMFeature * > &	features
	)

Create ObjectsUdeSet for features.

Returns: created objects ude set
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

params	array of operations
udeType	ude type
features	array of features

NXOpen::CAM::OperationTeaching* NXOpen::CAM::CAMSetup::CreateOperationTeaching ( NXOpen::CAM::CAMObject * param )

Creates a CAM.OperationTeaching.

Returns: Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

param not used

NXOpen::CAM::OperationTransformBuilder* NXOpen::CAM::CAMSetup::CreateOperationTransformBuilder ( const std::vector< NXOpen::CAM::CAMObject * > & objectsToTransform )

Create Transform builder.

Note: Commit a Transform Builder will apply a transformation.

Returns: created Transform Builder
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objectsToTransform array of objects to transform

NXOpen::CAM::PreprocessGeometryBuilder* NXOpen::CAM::CAMSetup::CreatePreprocessGeometryBuilder ( )

Creates a preprocess geometry builder.

Returns: preprocess geometry builder created
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::SurfaceRegions* NXOpen::CAM::CAMSetup::CreateSurfaceRegions ( NXOpen::Features::Feature * feature )

Creates a surface regions builder.

Returns: surface regions builder created
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

feature Feature to be edited

NXOpen::CAM::ToolPathDivideBuilder* NXOpen::CAM::CAMSetup::CreateToolPathDivideBuilder ( const std::vector< NXOpen::CAM::CAMObject * > & tpObjectsToDivide )

Create Tool Path Divide builder.

Returns: array of new objects
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

tpObjectsToDivide array of objects to divide

NXOpen::CAM::ToolPathSplitBuilder* NXOpen::CAM::CAMSetup::CreateToolPathSplitBuilder ( const std::vector< NXOpen::CAM::CAMObject * > & tpObjectsToDivide )

Create Tool Path Split by Holder builder.

Returns: array of new objects
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

tpObjectsToDivide array of objects to divide

NXOpen::CAM::ToolPathTiltBuilder* NXOpen::CAM::CAMSetup::CreateToolPathTiltBuilder ( const std::vector< NXOpen::CAM::CAMObject * > & tpObjectsToTilt )

Create Tool Path Tilt builder.

Returns: array of new objects
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

tpObjectsToTilt array of objects to tilt

void NXOpen::CAM::CAMSetup::CustomizationUpdateFromObject	(	NXOpen::CAM::CAMObject *	destinationObject,
		NXOpen::CAM::CAMObject *	sourceObject
	)

Customize from Object
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

destinationObject	destination object for customization
sourceObject	source object for customization

void NXOpen::CAM::CAMSetup::CustomizationUpdateFromTemplate ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Customize from Template
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects destination objects for customization

void NXOpen::CAM::CAMSetup::CutObjects	(	NXOpen::CAM::CAMSetup::View	view,
		const std::vector< NXOpen::CAM::CAMObject * > &	objectsToBeMoved
	)

Cut objects
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

view	view
objectsToBeMoved	array of objects to be moved

void NXOpen::CAM::CAMSetup::Delete3dWorkpieces ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Delete 3D workpieces of the selected operations
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of operations

void NXOpen::CAM::CAMSetup::DeleteToolPath ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Delete tool path
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::DeleteVnckMachineData ( )

Removes vnck machine data
Created in NX8.5.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::CAMSetup::DivideToolPaths	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		NXOpen::CAM::ToolPathDivideBuilder *	builder
	)

Tool Path Divide
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
builder	builder containing split parameters

void NXOpen::CAM::CAMSetup::GenerateToolPath ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Generate tool path
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

NXOpen::CAM::CAMObject* NXOpen::CAM::CAMSetup::GetCamExitObject ( )

Get the param object which is invoking the exit API.

Returns: the cam exit object
Created in NX8.5.0.

License requirements : cam_base ("CAM BASE")

NXString NXOpen::CAM::CAMSetup::GetMachineLibref ( )

Get machine libref.

Returns: Created in NX8.5.0.

License requirements : None

NXString NXOpen::CAM::CAMSetup::GetPartMaterial ( )

Part material.

Returns: Created in NX8.0.1.

License requirements : None

void NXOpen::CAM::CAMSetup::GetPartMaterialData	(	NXString *	libref,
		NXString *	name,
		NXString *	description,
		NXString *	code,
		NXString *	hardness
	)

Get part material data
Created in NX8.0.2.

License requirements : None

Parameters

libref	libref
name	name
description	description
code	code
hardness	hardness

NXOpen::CAM::NCGroup* NXOpen::CAM::CAMSetup::GetRoot ( NXOpen::CAM::CAMSetup::View branch )

Get root of the specified branch.

Returns: root of the specified branch
Created in NX7.5.0.

License requirements : None

Parameters

branch branch from which to get setup root

void NXOpen::CAM::CAMSetup::GougeCheck	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		bool	checkForHolderCollision
	)

Gouge Check

Deprecated:: Deprecated in NX9.0.0.

Use new version with additional arguments instead.

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects to do gouge checking
checkForHolderCollision	check for tool holder collision

void NXOpen::CAM::CAMSetup::GougeCheck	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		bool	checkForHolderCollision,
		bool	useParametric,
		bool	useUserdefStock,
		double	userdefStock
	)

Gouge Check
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects to do gouge checking
checkForHolderCollision	check for tool holder collision
useParametric	use parametric tool shape
useUserdefStock	use user defined stock
userdefStock	user defined stock

bool NXOpen::CAM::CAMSetup::HasSuppressedGeom ( NXOpen::CAM::CAMObject * param )

Check for suppressed geometry.

Returns: Created in NX5.0.4.

License requirements : cam_base ("CAM BASE")

Parameters

param object to test

bool NXOpen::CAM::CAMSetup::IsGroup ( NXOpen::CAM::CAMObject * camObject )

Check if the specified object is a group.

Returns: Created in NX7.5.0.

License requirements : None

Parameters

camObject camobject

bool NXOpen::CAM::CAMSetup::IsLibrarySetup ( )

Returns the flag indicating if this setup is initialized from a library.

Created in NX7.5.3.

License requirements : None

bool NXOpen::CAM::CAMSetup::IsOperation ( NXOpen::CAM::CAMObject * camobject )

Check if the specified object is an operation.

Returns: Created in NX7.5.0.

License requirements : None

Parameters

camobject camobject

bool NXOpen::CAM::CAMSetup::IsToolPathLocked ( NXOpen::CAM::CAMObject * object )

Lock Tool Path.

Returns: tool path lock status
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

object object whose tool path is checked

NXString NXOpen::CAM::CAMSetup::LibraryReference ( )

Returns the template library reference
Created in NX7.5.3.

License requirements : None

void NXOpen::CAM::CAMSetup::ListToolPath ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

List tool path
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::LockToolPaths	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		bool	lock
	)

Lock Tool Path
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
lock	lock the tool path if true, else unlock the tool path

void NXOpen::CAM::CAMSetup::MinToolLen ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Minimum tool length
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::MoveObjects	(	NXOpen::CAM::CAMSetup::View	view,
		const std::vector< NXOpen::CAM::CAMObject * > &	objectsToBeMoved,
		NXOpen::CAM::CAMObject *	destinationObject,
		NXOpen::CAM::CAMSetup::Paste	pastePosition
	)

Move objects
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

view	view
objectsToBeMoved	array of objects to be moved
destinationObject	the destination object
pastePosition	paste inside or after the destination object

void NXOpen::CAM::CAMSetup::Optimize	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		bool	consolidateTools,
		bool	minimizeToolChanges,
		bool	createOptimizationGroup
	)

Optimize
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects to optimize
consolidateTools	consolidate tools
minimizeToolChanges	minimize tool changes
createOptimizationGroup	create optimization group

bool NXOpen::CAM::CAMSetup::OutputBallCenter ( )

Returns the setting for ball center output at posting time
Created in NX9.0.1.

License requirements : None

void NXOpen::CAM::CAMSetup::OutputClsf	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		const NXString &	clsfFormat,
		const NXString &	outfileName,
		NXOpen::CAM::CAMSetup::OutputUnits	outputUnits
	)

Output CLSF
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
clsfFormat	clsf format NOTE: The full Unicode character set is not supported for this parameter.
outfileName	output file name NOTE: The full Unicode character set is not supported for this parameter.
outputUnits	output file unit

void NXOpen::CAM::CAMSetup::OutputClsf	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		const char *	clsfFormat,
		const char *	outfileName,
		NXOpen::CAM::CAMSetup::OutputUnits	outputUnits
	)

Output CLSF
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
clsfFormat	clsf format NOTE: The full Unicode character set is not supported for this parameter.
outfileName	output file name NOTE: The full Unicode character set is not supported for this parameter.
outputUnits	output file unit

void NXOpen::CAM::CAMSetup::ParallelCreate3d ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Parallel create 3D
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::ParallelGenerate ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Parallel Generate tool path
Created in NX7.5.5.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::Postprocess	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		const NXString &	machineType,
		const NXString &	outfileName,
		NXOpen::CAM::CAMSetup::OutputUnits	outputUnits
	)

Postprocess
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
machineType	machine type NOTE: The full Unicode character set is not supported for this parameter.
outfileName	output file name NOTE: The full Unicode character set is not supported for this parameter.
outputUnits	output file unit

void NXOpen::CAM::CAMSetup::Postprocess	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		const char *	machineType,
		const char *	outfileName,
		NXOpen::CAM::CAMSetup::OutputUnits	outputUnits
	)

Postprocess
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
machineType	machine type NOTE: The full Unicode character set is not supported for this parameter.
outfileName	output file name NOTE: The full Unicode character set is not supported for this parameter.
outputUnits	output file unit

void NXOpen::CAM::CAMSetup::PostprocessWithSetting	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		const NXString &	machineType,
		const NXString &	outfileName,
		NXOpen::CAM::CAMSetup::OutputUnits	outputUnits,
		NXOpen::CAM::CAMSetup::PostprocessSettingsOutputWarning	outputWarning,
		NXOpen::CAM::CAMSetup::PostprocessSettingsReviewTool	reviewTool
	)

Postprocess
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
machineType	machine type NOTE: The full Unicode character set is not supported for this parameter.
outfileName	output file name NOTE: The full Unicode character set is not supported for this parameter.
outputUnits	output file unit
outputWarning	whether ouput warning file
reviewTool	whether active review tool window

void NXOpen::CAM::CAMSetup::PostprocessWithSetting	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		const char *	machineType,
		const char *	outfileName,
		NXOpen::CAM::CAMSetup::OutputUnits	outputUnits,
		NXOpen::CAM::CAMSetup::PostprocessSettingsOutputWarning	outputWarning,
		NXOpen::CAM::CAMSetup::PostprocessSettingsReviewTool	reviewTool
	)

Postprocess
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
machineType	machine type NOTE: The full Unicode character set is not supported for this parameter.
outfileName	output file name NOTE: The full Unicode character set is not supported for this parameter.
outputUnits	output file unit
outputWarning	whether ouput warning file
reviewTool	whether active review tool window

void NXOpen::CAM::CAMSetup::RemoveDependencies ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Remove dependencies of selected objects
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::RemoveMachine ( )

Removes:

The machine part component from the CAM assembly
The machine kinematics from the CAM Setup
Carriers and Pockets from the CAM Setup, this means cleanup the Operation Navigator

Created in NX8.5.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::CAMSetup::RemoveSuppressedGeom ( NXOpen::CAM::CAMObject * param )

Remove suppressed geometry
Created in NX5.0.4.

License requirements : cam_base ("CAM BASE")

Parameters

param object to operate on

void NXOpen::CAM::CAMSetup::ReplayToolPath ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Replay tool path
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::RestoreDependencies ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Restore dependencies of selected objects
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

NXOpen::CAM::NCGroup* NXOpen::CAM::CAMSetup::RetrieveDevice ( const NXString & libRef )

Retrieve a device from library.

Returns: machine device created
Created in NX8.0.0.

License requirements : None

Parameters

libRef a unique library reference identifier
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::NCGroup* NXOpen::CAM::CAMSetup::RetrieveDevice ( const char * libRef )

Retrieve a device from library.

Returns: machine device created
Created in NX8.0.0.

License requirements : None

Parameters

libRef a unique library reference identifier
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::Tool* NXOpen::CAM::CAMSetup::RetrieveTool	(	const NXString &	libRef,
		bool *	success
	)

Retrieve a tool from library.

Returns: created the tool library
Created in NX7.5.0.

License requirements : None

Parameters

libRef	the library name NOTE: The full Unicode character set is not supported for this parameter.
success	success

NXOpen::CAM::Tool* NXOpen::CAM::CAMSetup::RetrieveTool	(	const char *	libRef,
		bool *	success
	)

Retrieve a tool from library.

Returns: created the tool library
Created in NX7.5.0.

License requirements : None

Parameters

libRef	the library name NOTE: The full Unicode character set is not supported for this parameter.
success	success

NXOpen::CAM::Tool* NXOpen::CAM::CAMSetup::RetrieveTool	(	const NXString &	libRef,
		NXOpen::CAM::CAMObject *	target,
		NXOpen::CAM::CAMObject **	nextTarget,
		bool *	success
	)

Retrieve a tool from library to the target.

Returns: created the tool library
Created in NX8.5.0.

License requirements : None

Parameters

libRef	the library name NOTE: The full Unicode character set is not supported for this parameter.
target	the target where the tool is mounted
nextTarget	the next target where the tool can be mounted
success	success

NXOpen::CAM::Tool* NXOpen::CAM::CAMSetup::RetrieveTool	(	const char *	libRef,
		NXOpen::CAM::CAMObject *	target,
		NXOpen::CAM::CAMObject **	nextTarget,
		bool *	success
	)

Retrieve a tool from library to the target.

Returns: created the tool library
Created in NX8.5.0.

License requirements : None

Parameters

libRef	the library name NOTE: The full Unicode character set is not supported for this parameter.
target	the target where the tool is mounted
nextTarget	the next target where the tool can be mounted
success	success

void NXOpen::CAM::CAMSetup::SetLibraryReference ( const NXString & libraryReference )

Sets the template library reference
Created in NX7.5.3.

License requirements : cam_base ("CAM BASE")

Parameters

libraryReference libraryreference

void NXOpen::CAM::CAMSetup::SetLibraryReference ( const char * libraryReference )

Sets the template library reference
Created in NX7.5.3.

License requirements : cam_base ("CAM BASE")

Parameters

libraryReference libraryreference

std::vector<NXOpen::CAM::CAMObject::ErrorItem> NXOpen::CAM::CAMSetup::SetMachiningData ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Set Machining Data.

Returns: array of errors
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::SetOutputBallCenter ( bool outputBallCenter )

Sets the setting for ball center output at posting time
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")

Parameters

outputBallCenter outputballcenter

void NXOpen::CAM::CAMSetup::SetPartMaterial ( const NXString & libRef )

Part material
Created in NX8.0.1.

License requirements : cam_base ("CAM BASE")

Parameters

libRef NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::CAMSetup::SetPartMaterial ( const char * libRef )

Part material
Created in NX8.0.1.

License requirements : cam_base ("CAM BASE")

Parameters

libRef NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::CAMSetup::SetTemplateStatus	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		bool	useAsParent,
		bool	createIfParentCreated
	)

Set Template status
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects to adjust
useAsParent	object can be used as a template or not
createIfParentCreated	create if parent is created

void NXOpen::CAM::CAMSetup::Show2dWorkpiece ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Show 2D workpiece
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::Show2dWorkpieceIn ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Show ingoing 2D workpiece
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::Show2dWorkpieceOut ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Show outgoing 2D workpiece
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::Show3dWorkpiece ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Show 3D workpiece
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::ShowSpinning3dWorkpiece ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Show spinning 3D workpiece
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::SplitToolPaths	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		NXOpen::CAM::ToolPathSplitBuilder *	builder
	)

Tool Path Split by Holder
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
builder	builder containing split parameters

void NXOpen::CAM::CAMSetup::SwitchLayerLayout ( NXOpen::CAM::CAMObject * object )

Switch Layer and Layout
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")

Parameters

object the object for which the layer and layout has to be switched

void NXOpen::CAM::CAMSetup::TiltToolPaths	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		NXOpen::CAM::ToolPathTiltBuilder *	builder
	)

Tool Path Tilt
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects	array of objects
builder	builder containing tilt parameters

void NXOpen::CAM::CAMSetup::UnapproveObjects ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Unapprove objects
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

void NXOpen::CAM::CAMSetup::UpdateGeometryDependencies ( const std::vector< NXOpen::CAM::CAMObject * > & objects )

Update geometry dependencies of selected objects
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

objects array of objects

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

CAM_CAMSetup.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation