Represents a collector More...

Inheritance diagram for NXOpen.ScCollector:

Public Member Functions
unsafe void	AddEvaluationFilter (NXOpen.ScEvaluationFiltertype filterType)
	Sets the evaluation filter on ScCollector More...

unsafe NXOpen.ScCollector	CopyCollector ()
	Copy collector object More...

unsafe void	Destroy ()
	Destroy the ScCollector object More...

unsafe NXOpen.ScCollectorAllowTypes	GetAllowedWireframeType ()
	Get the allowed wireframe type(viz. More...

unsafe bool	GetMultiComponent ()
	Gets the option set on ScCollector for collection from multiple components. More...

unsafe bool	GetNonFeatureMode ()
	Gets the option set on ScCollector for collection in non-feature mode. More...

unsafe NXOpen.TaggedObject[]	GetObjects ()
	Returns the contents of a collector. More...

unsafe NXOpen.TaggedObject[]	GetObjectsSortedById ()
	Returns the contents of a collector which are guaranteed to be sorted. More...

unsafe void	GetRules (out NXOpen.SelectionIntentRule[] rules)
	Returns the rules of the a collector. More...

unsafe bool	IsEvaluationFilterEnabled (NXOpen.ScEvaluationFiltertype filterType)
	Checks whether the evaluation filter is present on ScCollector More...

unsafe void	RemoveEvaluationFilter (NXOpen.ScEvaluationFiltertype filterType)
	Removes the evaluation filter on ScCollector More...

unsafe void	RemoveMissingParents ()
	Deletes the references of missing parents from collector More...

unsafe void	RemoveRule (int ruleIndex)
	Remove collector rule More...

unsafe void	RemoveRules (NXOpen.SelectionIntentRule[] rules)
	Remove collector rules More...

unsafe void	ReplaceRules (NXOpen.SelectionIntentRule[] rules, bool createRulesWoUpdate)
	Replace collector rules. More...

unsafe void	ReplaceRules (NXOpen.SelectionIntentRule[] rules, NXOpen.DisplayableObject[] negatedEntities, bool createRulesWoUpdate)
	Replace collector rules and specify negated entities. More...

unsafe void	SetAllowedWireframeType (NXOpen.ScCollectorAllowTypes allowedEntityTypes)
	Set the allowed wireframe type(viz. More...

unsafe void	SetAllowRefCurves (bool allowRefCurves)
	Sets whether to allow reference curves or not in the ScCollector More...

unsafe void	SetInterpart (bool interpart)
	Sets inter-part status More...

unsafe void	SetMultiComponent ()
	Sets the true option on ScCollector for collection from multiple components. More...

unsafe void	SetNonFeatureMode ()
	Sets the true option on ScCollector for collection in non-feature mode. More...

Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void	Blank ()
	Blanks the object. More...

unsafe void	Highlight ()
	Highlights the object. More...

unsafe void	RedisplayObject ()
	Redisplays the object in all views. More...

unsafe void	RemoveViewDependency ()
	Remove dependency on all views from an object. More...

unsafe void	SetNameLocation (NXOpen.Point3d location)
	Sets the location of the object's name. More...

unsafe void	Unblank ()
	Unblanks the object. More...

unsafe void	Unhighlight ()
	Unhighlights the object. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

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

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

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

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

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

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

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

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

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

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

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string 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...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string 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...

unsafe string	GetUserAttributeAsString (string 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...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

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

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

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

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

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe int	GetUserAttributeSize (string 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...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string 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...

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

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

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

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

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

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

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

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

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

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

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

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

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

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

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

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

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

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

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

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

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

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

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Additional Inherited Members
Public Types inherited from NXOpen.DisplayableObject
enum	ObjectFont { Solid = 1, Dashed, Phantom, Centerline, Dotted, LongDashed, DottedDashed, Eight = 11, Nine, Ten, Eleven }
	specifies the object font for objects such as lines More...

enum	ObjectWidth { Normal, Thick, Thin, One = 5, Two, Three, Four, Five, Six, Seven, Eight, Nine }
	specifies object width for objects such as lines and text More...

Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Properties inherited from NXOpen.DisplayableObject
unsafe int	Color `[get, set]`
	Returns or sets the color of the object. More...

unsafe bool	IsBlanked `[get]`
	Returns the blank status of this object. More...

unsafe int	Layer `[get, set]`
	Returns or sets the layer that the object is in. More...

unsafe NXOpen.DisplayableObject.ObjectFont	LineFont `[get, set]`
	Returns or sets the line font of the object. More...

unsafe NXOpen.DisplayableObject.ObjectWidth	LineWidth `[get, set]`
	Returns or sets the line width of the object. More...

unsafe NXOpen.Point3d	NameLocation `[get]`
	Returns the location of the object's name. 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

unsafe void NXOpen.ScCollector.AddEvaluationFilter ( NXOpen.ScEvaluationFiltertype filterType )

inline

Sets the evaluation filter on ScCollector

Created in NX11.0.0

License requirements: None.

Parameters

filterType Enum Value

unsafe NXOpen.ScCollector NXOpen.ScCollector.CopyCollector ( )

inline

Copy collector object

Created in NX8.0.0

License requirements: None.

Returns

unsafe void NXOpen.ScCollector.Destroy ( )

inline

Destroy the ScCollector object

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.ScCollectorAllowTypes NXOpen.ScCollector.GetAllowedWireframeType ( )

inline

Get the allowed wireframe type(viz.

curve, point or both) on the curve ScCollector

Created in NX1847.0.0

License requirements: None.

Returns: Allowed entity types.

unsafe bool NXOpen.ScCollector.GetMultiComponent ( )

inline

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.

Created in NX9.0.0

License requirements: None.

Returns: Multi-component option set on ScCollector

unsafe bool NXOpen.ScCollector.GetNonFeatureMode ( )

inline

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.

Created in NX9.0.0

License requirements: None.

Returns: Non-feature mode set on ScCollector

unsafe NXOpen.TaggedObject [] NXOpen.ScCollector.GetObjects ( )

inline

Returns the contents of a collector.

Created in NX6.0.0

License requirements: None.

Returns

unsafe NXOpen.TaggedObject [] NXOpen.ScCollector.GetObjectsSortedById ( )

inline

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

Created in NX11.0.0

License requirements: None.

Returns

unsafe void NXOpen.ScCollector.GetRules ( out NXOpen.SelectionIntentRule[] rules )

inline

Returns the rules of the a collector.

Created in NX6.0.0

License requirements: None.

Parameters

rules Selection intent rules.

unsafe bool NXOpen.ScCollector.IsEvaluationFilterEnabled ( NXOpen.ScEvaluationFiltertype filterType )

inline

Checks whether the evaluation filter is present on ScCollector

Created in NX11.0.0

License requirements: None.

Parameters

filterType Enum Value

Returns

unsafe void NXOpen.ScCollector.RemoveEvaluationFilter ( NXOpen.ScEvaluationFiltertype filterType )

inline

Removes the evaluation filter on ScCollector

Created in NX11.0.0

License requirements: None.

Parameters

filterType Enum Value

unsafe void NXOpen.ScCollector.RemoveMissingParents ( )

inline

Deletes the references of missing parents from collector

Created in NX1847.0.0

License requirements: None.

unsafe void NXOpen.ScCollector.RemoveRule ( int ruleIndex )

inline

Remove collector rule

Created in NX7.0.0

License requirements: None.

Parameters

ruleIndex index (starting from 0) of the rule to be removed

unsafe void NXOpen.ScCollector.RemoveRules ( NXOpen.SelectionIntentRule[] rules )

inline

Remove collector rules

Created in NX8.0.0

License requirements: None.

Parameters

rules Selection intent rules to be removed

unsafe void NXOpen.ScCollector.ReplaceRules	(	NXOpen.SelectionIntentRule[]	rules,
		bool	createRulesWoUpdate
	)

inline

Replace collector rules.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters

rules	Selection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.
createRulesWoUpdate	Flag to tell whether rules should be created wo_update

unsafe void NXOpen.ScCollector.ReplaceRules	(	NXOpen.SelectionIntentRule[]	rules,
		NXOpen.DisplayableObject[]	negatedEntities,
		bool	createRulesWoUpdate
	)

inline

Replace collector rules and specify negated entities.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters

rules	Selection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.
negatedEntities	Entities in the rules that should be removed from the collector.
createRulesWoUpdate	Flag to tell whether rules should be created wo_update

unsafe void NXOpen.ScCollector.SetAllowedWireframeType ( NXOpen.ScCollectorAllowTypes allowedEntityTypes )

inline

Set the allowed wireframe type(viz.

curve, point or both) on the curve ScCollector

Created in NX1847.0.0

License requirements: None.

Parameters

allowedEntityTypes Allowed entity types.

unsafe void NXOpen.ScCollector.SetAllowRefCurves ( bool allowRefCurves )

inline

Sets whether to allow reference curves or not in the ScCollector

Created in NX11.0.2

License requirements: None.

Parameters

allowRefCurves True to allow reference curves in ScCollector

unsafe void NXOpen.ScCollector.SetInterpart ( bool interpart )

inline

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

interpart True to set collector as interpart

unsafe void NXOpen.ScCollector.SetMultiComponent ( )

inline

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.

unsafe void NXOpen.ScCollector.SetNonFeatureMode ( )

inline

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:

ScCollector.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation