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

Represents a collector
ScCollector consists of collection of either faces, bodies, edges, curves or a mixed collection of these entities. More...

Inheritance diagram for NXOpen::ScCollector:
NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

Public Member Functions

void AddEvaluationFilter (NXOpen::ScEvaluationFiltertype filterType)
 Sets the evaluation filter on ScCollector
Created in NX11.0.0. More...
 
NXOpen::ScCollectorCopyCollector ()
 Copy collector object. More...
 
void Destroy ()
 Destroy the ScCollector object
Created in NX5.0.0. More...
 
bool GetMultiComponent ()
 Gets the option set on ScCollector for collection from multiple components. More...
 
bool GetNonFeatureMode ()
 Gets the option set on ScCollector for collection in non-feature mode. More...
 
std::vector
< NXOpen::TaggedObject * > 
GetObjects ()
 Returns the contents of a collector. More...
 
std::vector
< NXOpen::TaggedObject * > 
GetObjectsSortedById ()
 Returns the contents of a collector which are guaranteed to be sorted. More...
 
void GetRules (std::vector< NXOpen::SelectionIntentRule * > &rules)
 Returns the rules of the a collector. More...
 
bool IsEvaluationFilterEnabled (NXOpen::ScEvaluationFiltertype filterType)
 Checks whether the evaluation filter is present on ScCollector. More...
 
void RemoveEvaluationFilter (NXOpen::ScEvaluationFiltertype filterType)
 Removes the evaluation filter on ScCollector
Created in NX11.0.0. More...
 
void RemoveRule (int ruleIndex)
 Remove collector rule
Created in NX7.0.0. More...
 
void RemoveRules (const std::vector< NXOpen::SelectionIntentRule * > &rules)
 Remove collector rules
Created in NX8.0.0. More...
 
void ReplaceRules (const std::vector< NXOpen::SelectionIntentRule * > &rules, bool createRulesWoUpdate)
 Replace collector rules. More...
 
void ReplaceRules (const std::vector< NXOpen::SelectionIntentRule * > &rules, const std::vector< NXOpen::DisplayableObject * > &negatedEntities, bool createRulesWoUpdate)
 Replace collector rules and specify negated entities. More...
 
void SetAllowRefCurves (bool allowRefCurves)
 Sets whether to allow reference curves or not in the ScCollector
Created in NX11.0.2. More...
 
void SetInterpart (bool interpart)
 Sets inter-part status
This function sets the value of interpart flag on ScCollector. More...
 
void SetMultiComponent ()
 Sets the true option on ScCollector for collection from multiple components. More...
 
void SetNonFeatureMode ()
 Sets the true option on ScCollector for collection in non-feature mode. More...
 
- Public Member Functions inherited from NXOpen::DisplayableObject
void Blank ()
 Blanks the object. More...
 
int Color ()
 Returns the color of the object. More...
 
void Highlight ()
 Highlights the object. More...
 
bool IsBlanked ()
 Returns the blank status of this object. More...
 
int Layer ()
 Returns the layer that the object is in. More...
 
NXOpen::DisplayableObject::ObjectFont LineFont ()
 Returns the line font of the object. More...
 
NXOpen::DisplayableObject::ObjectWidth LineWidth ()
 Returns the line width of the object. More...
 
NXOpen::Point3d NameLocation ()
 Returns the location of the object's name. More...
 
void RedisplayObject ()
 Redisplays the object in all views. More...
 
void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
void SetColor (int color)
 Sets the color of the object. More...
 
void SetLayer (int layer)
 Sets the layer that the object is in. More...
 
void SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the line font of the object. More...
 
void SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
 Sets the line width of the object. More...
 
void SetNameLocation (const NXOpen::Point3d &location)
 Sets the location of the object's name. More...
 
void Unblank ()
 Unblanks the object. More...
 
void Unhighlight ()
 Unhighlights the object. More...
 
- Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIteratorCreateAttributeIterator ()
 Create an attribute iterator. More...
 
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::AttributeIterator *iterator, NXOpen::Update::Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator
Created in NX8.0.0. 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::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (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...
 
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 Gets the value of PDM Reference attribute for given object. 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::AttributeIterator *iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. 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 (NXOpen::AttributeIterator *iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. 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< NXStringGetUserAttributesAsStrings ()
 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 (NXOpen::AttributeIterator *iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator. 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::BasePartOwningPart ()
 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::INXObjectPrototype ()
 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 SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of PDM Reference attribute on 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...
 

Additional Inherited Members

- Public Types inherited from NXOpen::DisplayableObject
enum  ObjectFont {
  ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline,
  ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed
}
 specifies the object font for objects such as lines
Created in NX3.0.0. More...
 
enum  ObjectWidth {
  ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5,
  ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive,
  ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine
}
 specifies object width for objects such as lines and text
Created in NX3.0.0. More...
 

Detailed Description

Represents a collector
ScCollector consists of collection of either faces, bodies, edges, curves or a mixed collection of these entities.

The collection is defined by selection intent rules. Please refer documentation of ScRuleFactory for more details on available selection intent rules. ScRuleFactory .

To create a new instance of this class, use NXOpen::ScCollectorCollection::CreateCollector

Created in NX4.0.0.

Member Function Documentation

void NXOpen::ScCollector::AddEvaluationFilter ( NXOpen::ScEvaluationFiltertype  filterType)

Sets the evaluation filter on ScCollector
Created in NX11.0.0.



License requirements : None

Parameters
filterTypeEnum Value
NXOpen::ScCollector* NXOpen::ScCollector::CopyCollector ( )

Copy collector object.

Returns

Created in NX8.0.0.

License requirements : None
void NXOpen::ScCollector::Destroy ( )

Destroy the ScCollector object
Created in NX5.0.0.



License requirements : None

bool NXOpen::ScCollector::GetMultiComponent ( )

Gets the option set on ScCollector for collection from multiple components.


A multi-component ScCollector can have collection from multiple components i.e., multiple parts or multiple instances of same part or both.

Returns
Multi-component option set on ScCollector
Created in NX9.0.0.

License requirements : None
bool NXOpen::ScCollector::GetNonFeatureMode ( )

Gets the option set on ScCollector for collection in non-feature mode.


An ScCollector in non-feature mode does not reference the feature data of the part from which the collection is done.

Returns
Non-feature mode set on ScCollector
Created in NX9.0.0.

License requirements : None
std::vector<NXOpen::TaggedObject *> NXOpen::ScCollector::GetObjects ( )

Returns the contents of a collector.

Returns

Created in NX6.0.0.

License requirements : None
std::vector<NXOpen::TaggedObject *> NXOpen::ScCollector::GetObjectsSortedById ( )

Returns the contents of a collector which are guaranteed to be sorted.

Returns

Created in NX11.0.0.

License requirements : None
void NXOpen::ScCollector::GetRules ( std::vector< NXOpen::SelectionIntentRule * > &  rules)

Returns the rules of the a collector.


Created in NX6.0.0.

License requirements : None

Parameters
rulesSelection intent rules.
bool NXOpen::ScCollector::IsEvaluationFilterEnabled ( NXOpen::ScEvaluationFiltertype  filterType)

Checks whether the evaluation filter is present on ScCollector.

Returns

Created in NX11.0.0.

License requirements : None
Parameters
filterTypeEnum Value
void NXOpen::ScCollector::RemoveEvaluationFilter ( NXOpen::ScEvaluationFiltertype  filterType)

Removes the evaluation filter on ScCollector
Created in NX11.0.0.



License requirements : None

Parameters
filterTypeEnum Value
void NXOpen::ScCollector::RemoveRule ( int  ruleIndex)

Remove collector rule
Created in NX7.0.0.



License requirements : None

Parameters
ruleIndexindex (starting from 0) of the rule to be removed
void NXOpen::ScCollector::RemoveRules ( const std::vector< NXOpen::SelectionIntentRule * > &  rules)

Remove collector rules
Created in NX8.0.0.



License requirements : None

Parameters
rulesSelection intent rules to be removed
void NXOpen::ScCollector::ReplaceRules ( const std::vector< NXOpen::SelectionIntentRule * > &  rules,
bool  createRulesWoUpdate 
)

Replace collector rules.


Created in NX4.0.0.

License requirements : gateway ("UG GATEWAY")

Parameters
rulesSelection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.
createRulesWoUpdateFlag to tell whether rules should be created wo_update
void NXOpen::ScCollector::ReplaceRules ( const std::vector< NXOpen::SelectionIntentRule * > &  rules,
const std::vector< NXOpen::DisplayableObject * > &  negatedEntities,
bool  createRulesWoUpdate 
)

Replace collector rules and specify negated entities.


Created in NX5.0.0.

License requirements : gateway ("UG GATEWAY")

Parameters
rulesSelection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.
negatedEntitiesEntities in the rules that should be removed from the collector.
createRulesWoUpdateFlag to tell whether rules should be created wo_update
void NXOpen::ScCollector::SetAllowRefCurves ( bool  allowRefCurves)

Sets whether to allow reference curves or not in the ScCollector
Created in NX11.0.2.



License requirements : None

Parameters
allowRefCurvesTrue to allow reference curves in ScCollector
void NXOpen::ScCollector::SetInterpart ( bool  interpart)

Sets inter-part status
This function sets the value of interpart flag on ScCollector.

Error will be raised while setting this option on ScCollector in following conditions: (1) ScCollector is NULL. (2) ScCollector object is not of SC_collector class. (3) ScCollector is of hybrid part option. (4) Multi-component option is already set on ScCollector.


Created in NX6.0.0.

License requirements : None

Parameters
interpartTrue to set collector as interpart
void NXOpen::ScCollector::SetMultiComponent ( )

Sets the true option on ScCollector for collection from multiple components.


A multi-component ScCollector can have collection from multiple components i.e., multiple parts or multiple instances of same part or both. This method should be used only if such collection is desired. Error will be raised while setting this option on ScCollector in following conditions: (1) Inter-part option is already set on ScCollector.


Created in NX9.0.0.

License requirements : None

void NXOpen::ScCollector::SetNonFeatureMode ( )

Sets the true option on ScCollector for collection in non-feature mode.


An ScCollector in non-feature mode does not reference the feature data of the part from which the collection is done. The option should be set on an empty ScCollector only. For a non-empty ScCollector, setting this option will raise error in following conditions: (1) ScCollector is referencing feature data and non-feature mode is set true. (2) ScCollector is not referencing feature data and non-feature mode is set false.


Created in NX9.0.0.

License requirements : None


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