Represents interface for all CAM Object
To create or edit an instance of this class, use NXOpen::CAM::ParamBuilder

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::CAM::CAMObject:

Classes
struct	ErrorItem
	Error Item. More...

Public Types
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
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

Represents interface for all CAM Object
To create or edit an instance of this class, use NXOpen::CAM::ParamBuilder

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::CAMObject::Attr

Represents the CAM attribute type.

Enumerator
AttrProfileFlipMside	profile flip mside
AttrBndSplineTangent	bnd spline tangent
AttrBlankNormalDiffTaxis	blank normal diff taxis
AttrBndHasSleepObj	bnd has sleep obj
AttrClrnrNotParallelTaxis	clrnr not parallel taxis
AttrBndNotParallelFloor	bnd not parallel floor
AttrFloorNotUpToDate	floor not up to date
AttrSingleProfileWithFirstCut	single profile with first cut
AttrCutterConversionProblem	cutter conversion problem
AttrPlmFeedcomp	plm feedcomp
AttrPlmFillet	plm fillet
AttrPlmSlowdown	plm slowdown
AttrPlmGeometry	plm geometry
AttrNcmObsoleteCustomFeed	ncm obsolete custom feed
AttrNcmObsoleteLocalRetract	ncm obsolete local retract
AttrNcmClearTraversalZero	ncm clear traversal zero
AttrNcmObsoleteEngretToClearance	ncm obsolete engret to clearance
AttrProbingInvalidNxVersion	probing invalid nx version
AttrCustomDataGougingObsolete	custom data gouging obsolete
AttrCustomDataGougingPartObsolete	custom data gouging part obsolete
AttrCustomDataGougingDriveObsolete	custom data gouging drive obsolete
AttrCustomDataIgnoreLoopsObsolete	custom data ignore loops obsolete
AttrCustomDataIgnoreLoopsRemoved	custom data ignore loops removed

enum NXOpen::CAM::CAMObject::FeedRateUnit

The unit of feed rate.

Enumerator
FeedRateUnitNone	no feed rate unit
FeedRateUnitPerMinute	use per minute as the feed rate unit
FeedRateUnitPerRevolution	use per revolution as the feed rate unit

enum NXOpen::CAM::CAMObject::Status

The status of the object.

Enumerator
StatusComplete	Object path has been output.
StatusRepost	Object path must be post-processed.
StatusRegen	Object path must be regenerated.

Member Function Documentation

bool NXOpen::CAM::CAMObject::GetBooleanValue ( const NXString & title )

Get the boolean value of the parameter index from the object.

Returns: the boolean value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::CAM::CAMObject::GetBooleanValue ( const char * title )

Get the boolean value of the parameter index from the object.

Returns: the boolean value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::CAMObject::FeedRateUnit NXOpen::CAM::CAMObject::GetFeedRate	(	const NXString &	title,
		double *	value
	)

Get the feed rate value and unit of the parameter index from the object.

Returns: the feed rate unit
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value

NXOpen::CAM::CAMObject::FeedRateUnit NXOpen::CAM::CAMObject::GetFeedRate	(	const char *	title,
		double *	value
	)

Get the feed rate value and unit of the parameter index from the object.

Returns: the feed rate unit
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value

int NXOpen::CAM::CAMObject::GetFeedRateColor ( const NXString & title )

Get the feed rate color of the parameter index from the object.

Returns: the color number
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::CAM::CAMObject::GetFeedRateColor ( const char * title )

Get the feed rate color of the parameter index from the object.

Returns: the color number
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

std::vector<int> NXOpen::CAM::CAMObject::GetIntegerArrayValue ( const NXString & title )

Get the integer array value of the parameter index from the object.

Returns: the integer array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

std::vector<int> NXOpen::CAM::CAMObject::GetIntegerArrayValue ( const char * title )

Get the integer array value of the parameter index from the object.

Returns: the integer array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::CAM::CAMObject::GetIntegerValue ( const NXString & title )

Get the integer value of the parameter index from the object.

Returns: the integer value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::CAM::CAMObject::GetIntegerValue ( const char * title )

Get the integer value of the parameter index from the object.

Returns: the integer value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::NXObject* NXOpen::CAM::CAMObject::GetObject ( const NXString & title )

Get the object value of the parameter index from the object.

Returns: the object value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::NXObject* NXOpen::CAM::CAMObject::GetObject ( const char * title )

Get the object value of the parameter index from the object.

Returns: the object value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

std::vector<NXOpen::NXObject *> NXOpen::CAM::CAMObject::GetObjectArrayValue ( const NXString & title )

Get the object array value of the parameter index from the object.

Returns: the object array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

std::vector<NXOpen::NXObject *> NXOpen::CAM::CAMObject::GetObjectArrayValue ( const char * title )

Get the object array value of the parameter index from the object.

Returns: the object array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

std::vector<double> NXOpen::CAM::CAMObject::GetRealArrayValue ( const NXString & title )

Get the real array value of the parameter index from the object.

Returns: the real array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

std::vector<double> NXOpen::CAM::CAMObject::GetRealArrayValue ( const char * title )

Get the real array value of the parameter index from the object.

Returns: the real array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

double NXOpen::CAM::CAMObject::GetRealValue ( const NXString & title )

Get the real value of the parameter index from the object.

Returns: the real value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

double NXOpen::CAM::CAMObject::GetRealValue ( const char * title )

Get the real value of the parameter index from the object.

Returns: the real value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::CAMObject::Status NXOpen::CAM::CAMObject::GetStatus ( )

Get the status of the input object.

Returns: the object's status
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

std::vector<NXString> NXOpen::CAM::CAMObject::GetStringArrayValue ( const NXString & title )

Get the string array value of the parameter index from the object.

Returns: the string array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

std::vector<NXString> NXOpen::CAM::CAMObject::GetStringArrayValue ( const char * title )

Get the string array value of the parameter index from the object.

Returns: the string array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::CAM::CAMObject::GetStringValue ( const NXString & title )

Get the string value of the parameter index from the object.

Returns: the string value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::CAM::CAMObject::GetStringValue ( const char * title )

Get the string value of the parameter index from the object.

Returns: the string value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title the name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::CAM::CAMObject::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.

Returns: the feed rate side
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value

int NXOpen::CAM::CAMObject::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.

Returns: the feed rate side
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value

bool NXOpen::CAM::CAMObject::Has911Attribute ( NXOpen::CAM::CAMObject::Attr attrId )

Check if a 911 attribute exists in an object.

Returns: true – 911 attribute exists
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

attrId the attribute Id

void NXOpen::CAM::CAMObject::Remove911Attribute ( NXOpen::CAM::CAMObject::Attr attrId )

Remove a specific 911 attribute from an object.

Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

attrId the attribute Id

void NXOpen::CAM::CAMObject::RemoveAll911Attributes ( )

Remove all 911 attributes from an object.

Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::CAMObject::SetBooleanValue	(	const NXString &	title,
		bool	value
	)

Set a boolean value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the boolean value

void NXOpen::CAM::CAMObject::SetBooleanValue	(	const char *	title,
		bool	value
	)

Set a boolean value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the boolean value

void NXOpen::CAM::CAMObject::SetFeedRate	(	const NXString &	title,
		double	value,
		NXOpen::CAM::CAMObject::FeedRateUnit	unit
	)

Set feed rate value and unit to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value
unit	the feed rate unit

void NXOpen::CAM::CAMObject::SetFeedRate	(	const char *	title,
		double	value,
		NXOpen::CAM::CAMObject::FeedRateUnit	unit
	)

Set feed rate value and unit to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value
unit	the feed rate unit

void NXOpen::CAM::CAMObject::SetFeedRateColor	(	const NXString &	title,
		int	value
	)

Set feed rate display color to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the paramter index NOTE: The full Unicode character set is not supported for this parameter.
value	the color number

void NXOpen::CAM::CAMObject::SetFeedRateColor	(	const char *	title,
		int	value
	)

Set feed rate display color to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the paramter index NOTE: The full Unicode character set is not supported for this parameter.
value	the color number

void NXOpen::CAM::CAMObject::SetIntegerArrayValue	(	const NXString &	title,
		const std::vector< int > &	value
	)

Set integer array value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the integer array

void NXOpen::CAM::CAMObject::SetIntegerArrayValue	(	const char *	title,
		const std::vector< int > &	value
	)

Set integer array value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the integer array

void NXOpen::CAM::CAMObject::SetIntegerValue	(	const NXString &	title,
		int	value
	)

Set an integer value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the integer value

void NXOpen::CAM::CAMObject::SetIntegerValue	(	const char *	title,
		int	value
	)

Set an integer value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the integer value

void NXOpen::CAM::CAMObject::SetObject	(	const NXString &	title,
		NXOpen::NXObject *	value
	)

Set a object to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the object

void NXOpen::CAM::CAMObject::SetObject	(	const char *	title,
		NXOpen::NXObject *	value
	)

Set a object to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the object

void NXOpen::CAM::CAMObject::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.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the object array

void NXOpen::CAM::CAMObject::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.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the object array

void NXOpen::CAM::CAMObject::SetRealArrayValue	(	const NXString &	title,
		const std::vector< double > &	value
	)

Set real array to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the real array

void NXOpen::CAM::CAMObject::SetRealArrayValue	(	const char *	title,
		const std::vector< double > &	value
	)

Set real array to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the real array

void NXOpen::CAM::CAMObject::SetRealValue	(	const NXString &	title,
		double	value
	)

Set a real value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the real value

void NXOpen::CAM::CAMObject::SetRealValue	(	const char *	title,
		double	value
	)

Set a real value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the real value

void NXOpen::CAM::CAMObject::SetStringArrayValue	(	const NXString &	title,
		std::vector< NXString > &	value
	)

Set string array to the parameter index for the object
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the string array NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::CAMObject::SetStringArrayValue	(	const char *	title,
		std::vector< NXString > &	value
	)

Set string array to the parameter index for the object
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the string array NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::CAMObject::SetStringValue	(	const NXString &	title,
		const NXString &	value
	)

Set a string value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the string value NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::CAMObject::SetStringValue	(	const char *	title,
		const char *	value
	)

Set a string value to the parameter index for the object.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the string value NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::CAMObject::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.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value
side	Inside = 0, Outside = 1

void NXOpen::CAM::CAMObject::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.

Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

title	the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
value	the feed rate value
side	Inside = 0, Outside = 1

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

CAM_CAMObject.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation