ScCollector Class

class NXOpen.ScCollector

Bases: NXOpen.DisplayableObject

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()

New in version NX4.0.0.

Properties

Property	Description
Color	Returns or sets the color of the object.
IsBlanked	Returns the blank status of this object.
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Layer	Returns or sets the layer that the object is in.
LineFont	Returns or sets the line font of the object.
LineWidth	Returns or sets the line width of the object.
Name	Returns the custom name of the object.
NameLocation	Returns the location of the object’s name.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.

Methods

Method	Description
AddEvaluationFilter	Sets the evaluation filter on ScCollector
Blank	Blanks the object.
CopyCollector	Copy collector object
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
Destroy	Destroy the ScCollector object
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetMultiComponent	Gets the option set on ScCollector for collection from multiple components.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetNonFeatureMode	Gets the option set on ScCollector for collection in non-feature mode.
GetObjects	Returns the contents of a collector.
GetObjectsSortedById	Returns the contents of a collector which are guaranteed to be sorted.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetRules	Returns the rules of the a collector.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Highlight	Highlights the object.
IsEvaluationFilterEnabled	Checks whether the evaluation filter is present on ScCollector
Print	Prints a representation of this object to the system log file.
RedisplayObject	Redisplays the object in all views.
RemoveEvaluationFilter	Removes the evaluation filter on ScCollector
RemoveRule	Remove collector rule
RemoveRules	Remove collector rules
RemoveViewDependency	Remove dependency on all views from an object.
ReplaceRules	Replace collector rules.
SetAllowRefCurves	Sets whether to allow reference curves or not in the ScCollector
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetInterpart	Sets inter-part status
SetMultiComponent	Sets the true option on ScCollector for collection from multiple components.
SetName	Sets the custom name of the object.
SetNameLocation	Sets the location of the object’s name.
SetNonFeatureMode	Sets the true option on ScCollector for collection in non-feature mode.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
Unblank	Unblanks the object.
Unhighlight	Unhighlights the object.

Property Detail

IsOccurrence

ScCollector.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

ScCollector.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

ScCollector.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

ScCollector.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

ScCollector.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

ScCollector.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

AddEvaluationFilter

ScCollector.AddEvaluationFilter

Sets the evaluation filter on ScCollector

Signature AddEvaluationFilter(filterType)

Parameters:filterType (NXOpen.ScEvaluationFiltertype) – Enum Value

New in version NX11.0.0.

License requirements: None.

CopyCollector

ScCollector.CopyCollector

Copy collector object

Signature CopyCollector()

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

Destroy

ScCollector.Destroy

Destroy the ScCollector object

Signature Destroy()

New in version NX5.0.0.

License requirements: None.

FindObject

ScCollector.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetMultiComponent

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.

Signature GetMultiComponent()

Returns:Multi-component option set on ScCollector Return type:bool

New in version NX9.0.0.

License requirements: None.

GetNonFeatureMode

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.

Signature GetNonFeatureMode()

Returns:Non-feature mode set on ScCollector Return type:bool

New in version NX9.0.0.

License requirements: None.

GetObjects

ScCollector.GetObjects

Returns the contents of a collector.

Signature GetObjects()

Returns: Return type:list of NXOpen.TaggedObject

New in version NX6.0.0.

License requirements: None.

GetObjectsSortedById

ScCollector.GetObjectsSortedById

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

Signature GetObjectsSortedById()

Returns: Return type:list of NXOpen.TaggedObject

New in version NX11.0.0.

License requirements: None.

GetRules

ScCollector.GetRules

Returns the rules of the a collector.

Signature GetRules()

Returns:Selection intent rules. Return type:list of NXOpen.SelectionIntentRule

New in version NX6.0.0.

License requirements: None.

IsEvaluationFilterEnabled

ScCollector.IsEvaluationFilterEnabled

Checks whether the evaluation filter is present on ScCollector

Signature IsEvaluationFilterEnabled(filterType)

Parameters:filterType (NXOpen.ScEvaluationFiltertype) – Enum Value Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

Print

ScCollector.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveEvaluationFilter

ScCollector.RemoveEvaluationFilter

Removes the evaluation filter on ScCollector

Signature RemoveEvaluationFilter(filterType)

Parameters:filterType (NXOpen.ScEvaluationFiltertype) – Enum Value

New in version NX11.0.0.

License requirements: None.

RemoveRule

ScCollector.RemoveRule

Remove collector rule

Signature RemoveRule(ruleIndex)

Parameters:ruleIndex (int) – index (starting from 0) of the rule to be removed

New in version NX7.0.0.

License requirements: None.

RemoveRules

ScCollector.RemoveRules

Remove collector rules

Signature RemoveRules(rules)

Parameters:rules (list of NXOpen.SelectionIntentRule) – Selection intent rules to be removed

New in version NX8.0.0.

License requirements: None.

ReplaceRules

ScCollector.ReplaceRules

Overloaded method ReplaceRules

• ReplaceRules(rules, createRulesWoUpdate)
• ReplaceRules(rules, negatedEntities, createRulesWoUpdate)

-------------------------------------

Replace collector rules.

Signature ReplaceRules(rules, createRulesWoUpdate)

Parameters:

• rules (list of NXOpen.SelectionIntentRule) – Selection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.
• createRulesWoUpdate (bool) – Flag to tell whether rules should be created wo_update

New in version NX4.0.0.

License requirements: gateway (“UG GATEWAY”)

-------------------------------------

Replace collector rules and specify negated entities.

Signature ReplaceRules(rules, negatedEntities, createRulesWoUpdate)

Parameters:

• rules (list of NXOpen.SelectionIntentRule) – Selection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.
• negatedEntities (list of NXOpen.DisplayableObject) – Entities in the rules that should be removed from the collector.
• createRulesWoUpdate (bool) – Flag to tell whether rules should be created wo_update

New in version NX5.0.0.

License requirements: gateway (“UG GATEWAY”)

-------------------------------------

SetAllowRefCurves

ScCollector.SetAllowRefCurves

Sets whether to allow reference curves or not in the ScCollector

Signature SetAllowRefCurves(allowRefCurves)

Parameters:allowRefCurves (bool) – True to allow reference curves in ScCollector

New in version NX11.0.2.

License requirements: None.

SetInterpart

ScCollector.SetInterpart

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.

Signature SetInterpart(interpart)

Parameters:interpart (bool) – True to set collector as interpart

New in version NX6.0.0.

License requirements: None.

SetMultiComponent

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.

Signature SetMultiComponent()

New in version NX9.0.0.

License requirements: None.

SetName

ScCollector.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

SetNonFeatureMode

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.

Signature SetNonFeatureMode()

New in version NX9.0.0.

License requirements: None.