NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAM::NCGroup Class Reference

Represents a NC group
To obtain an instance of this class us CAM::NCGroupCollection

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::CAM::NCGroup:
NXOpen::CAM::CAMObject NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::CAM::FeatureGeometry NXOpen::CAM::InspectionGroup NXOpen::CAM::Method NXOpen::CAM::OrientGeometry NXOpen::CAM::Tool NXOpen::CAM::FeatureGeometryGroup NXOpen::CAM::InspectionTool

Public Member Functions

std::vector
< NXOpen::CAM::CAMObject * > 		GetMembers ()
 Get all members of the group(single level)
 
NXOpen::CAM::NCGroup * GetParent ()
 Get parent of the group.
 
- Public Member Functions inherited from NXOpen::CAM::CAMObject
bool GetBooleanValue (const NXString &title)
 Get the boolean value of the parameter index from the object.
 
bool GetBooleanValue (const char *title)
 Get the boolean value of the parameter index from the object.
 
NXOpen::CAM::CAMObject::FeedRateUnit GetFeedRate (const NXString &title, double *value)
 Get the feed rate value and unit of the parameter index from the object.
 
NXOpen::CAM::CAMObject::FeedRateUnit GetFeedRate (const char *title, double *value)
 Get the feed rate value and unit of the parameter index from the object.
 
int GetFeedRateColor (const NXString &title)
 Get the feed rate color of the parameter index from the object.
 
int GetFeedRateColor (const char *title)
 Get the feed rate color of the parameter index from the object.
 
std::vector< int > GetIntegerArrayValue (const NXString &title)
 Get the integer array value of the parameter index from the object.
 
std::vector< int > GetIntegerArrayValue (const char *title)
 Get the integer array value of the parameter index from the object.
 
int GetIntegerValue (const NXString &title)
 Get the integer value of the parameter index from the object.
 
int GetIntegerValue (const char *title)
 Get the integer value of the parameter index from the object.
 
NXOpen::NXObject * GetObject (const NXString &title)
 Get the object value of the parameter index from the object.
 
NXOpen::NXObject * GetObject (const char *title)
 Get the object value of the parameter index from the object.
 
std::vector< NXOpen::NXObject * > GetObjectArrayValue (const NXString &title)
 Get the object array value of the parameter index from the object.
 
std::vector< NXOpen::NXObject * > GetObjectArrayValue (const char *title)
 Get the object array value of the parameter index from the object.
 
std::vector< double > GetRealArrayValue (const NXString &title)
 Get the real array value of the parameter index from the object.
 
std::vector< double > GetRealArrayValue (const char *title)
 Get the real array value of the parameter index from the object.
 
double GetRealValue (const NXString &title)
 Get the real value of the parameter index from the object.
 
double GetRealValue (const char *title)
 Get the real value of the parameter index from the object.
 
NXOpen::CAM::CAMObject::Status GetStatus ()
 Get the status of the input object.
 
std::vector< NXString > GetStringArrayValue (const NXString &title)
 Get the string array value of the parameter index from the object.
 
std::vector< NXString > GetStringArrayValue (const char *title)
 Get the string array value of the parameter index from the object.
 
NXString GetStringValue (const NXString &title)
 Get the string value of the parameter index from the object.
 
NXString GetStringValue (const char *title)
 Get the string value of the parameter index from the object.
 
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.
 
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.
 
bool Has911Attribute (NXOpen::CAM::CAMObject::Attr attrId)
 Check if a 911 attribute exists in an object.
 
void Remove911Attribute (NXOpen::CAM::CAMObject::Attr attrId)
 Remove a specific 911 attribute from an object.
 
void RemoveAll911Attributes ()
 Remove all 911 attributes from an object.
 
void SetBooleanValue (const NXString &title, bool value)
 Set a boolean value to the parameter index for the object.
 
void SetBooleanValue (const char *title, bool value)
 Set a boolean value to the parameter index for the object.
 
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.
 
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.
 
void SetFeedRateColor (const NXString &title, int value)
 Set feed rate display color to the parameter index for the object.
 
void SetFeedRateColor (const char *title, int value)
 Set feed rate display color to the parameter index for the object.
 
void SetIntegerArrayValue (const NXString &title, const std::vector< int > &value)
 Set integer array value to the parameter index for the object.
 
void SetIntegerArrayValue (const char *title, const std::vector< int > &value)
 Set integer array value to the parameter index for the object.
 
void SetIntegerValue (const NXString &title, int value)
 Set an integer value to the parameter index for the object.
 
void SetIntegerValue (const char *title, int value)
 Set an integer value to the parameter index for the object.
 
void SetObject (const NXString &title, NXOpen::NXObject *value)
 Set a object to the parameter index for the object.
 
void SetObject (const char *title, NXOpen::NXObject *value)
 Set a object to the parameter index for the object.
 
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.
 
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.
 
void SetRealArrayValue (const NXString &title, const std::vector< double > &value)
 Set real array to the parameter index for the object.
 
void SetRealArrayValue (const char *title, const std::vector< double > &value)
 Set real array to the parameter index for the object.
 
void SetRealValue (const NXString &title, double value)
 Set a real value to the parameter index for the object.
 
void SetRealValue (const char *title, double value)
 Set a real value to the parameter index for the object.
 
void SetStringArrayValue (const NXString &title, std::vector< NXString > &value)
 Set string array to the parameter index for the object
Created in NX4.0.0.
 
void SetStringArrayValue (const char *title, std::vector< NXString > &value)
 Set string array to the parameter index for the object
Created in NX4.0.0.
 
void SetStringValue (const NXString &title, const NXString &value)
 Set a string value to the parameter index for the object.
 
void SetStringValue (const char *title, const char *value)
 Set a string value to the parameter index for the object.
 
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.
 
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.
 
- Public Member Functions inherited from NXOpen::NXObject
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type.
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes all attributes of a specific type with the option to update or not.
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title.
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title.
 
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.
 
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.
 
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 and Index.
 
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 and Index.
 
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not.
 
virtual NXOpen::INXObject * FindObject (const NXString &journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
NXOpen::INXObject * FindObject (const char *journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
std::vector
< NXOpen::NXObject::AttributeInformation > 		GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type.
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index.
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index.
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index.
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index.
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title.
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title.
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index.
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index.
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title.
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title.
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index.
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index.
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title.
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title.
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index.
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index.
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title.
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title.
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index.
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index.
 
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.
 
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.
 
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.
 
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.
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute.
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute.
 
std::vector
< NXOpen::NXObject::AttributeInformation > 		GetUserAttributes ()
 Gets all the attributes that have been set on the given object.
 
std::vector
< NXOpen::NXObject::AttributeInformation > 		GetUserAttributes (bool includeUnset)
 Gets all the attributes that have been set on the given object.
 
std::vector
< NXOpen::NXObject::AttributeInformation > 		GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes that have been set on the given object.
 
std::vector< NXString > GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object.
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes.
 
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).
 
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).
 
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not.
 
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object.
 
virtual NXString Name ()
 Returns the custom name of the object.
 
virtual
NXOpen::Assemblies::Component * 		OwningComponent ()
 Returns the owning component, if this object is an occurrence.
 
virtual NXOpen::BasePart * OwningPart ()
 Returns the owning part of this object
Created in NX3.0.0.
 
virtual void Print ()
 Prints a representation of this object to the system log file.
 
virtual NXOpen::INXObject * Prototype ()
 Returns the prototype of this object if it is an occurrence.
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute.
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute.
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not.
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not.
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute.
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute.
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not.
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not.
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute.
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute.
 
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.
 
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.
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value.
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value.
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not.
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not.
 
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.
 
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.
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object.
 
void SetName (const char *name)
 Sets the custom name of the object.
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string.
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string.
 
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.
 
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.
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute.
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not.
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not.
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute.
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 
- Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject * FindObject (const char *journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
void SetName (const char *name)
 Sets the custom name of the object.
 

Additional Inherited Members

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

Detailed Description

Represents a NC group
To obtain an instance of this class us CAM::NCGroupCollection

Created in NX4.0.0.


Member Function Documentation

std::vector<NXOpen::CAM::CAMObject *> NXOpen::CAM::NCGroup::GetMembers ( )

Get all members of the group(single level)

Returns
array of members
Created in NX7.5.0.

License requirements : None
NXOpen::CAM::NCGroup* NXOpen::CAM::NCGroup::GetParent ( )

Get parent of the group.

Returns
parent of this group
Created in NX7.5.0.

License requirements : None
The documentation for this class was generated from the following file:
Copyright 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.