NXOpen::ScCollector Class Reference

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

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::ScCollector:

Public Member Functions
NXOpen::ScCollector *	CopyCollector ()
	Copy collector object.
void	Destroy ()
	Destroy the ScCollector object Created in NX5.0.0.
bool	GetMultiComponent ()
	Gets the option set on ScCollector for collection from multiple components.
bool	GetNonFeatureMode ()
	Gets the option set on ScCollector for collection in non-feature mode.
std::vector < NXOpen::TaggedObject * >	GetObjects ()
	Returns the contents of a collector.
void	GetRules (std::vector< NXOpen::SelectionIntentRule * > &rules)
	Returns the rules of the a collector.
void	RemoveRule (int ruleIndex)
	Remove collector rule Created in NX7.0.0.
void	RemoveRules (const std::vector< NXOpen::SelectionIntentRule * > &rules)
	Remove collector rules Created in NX8.0.0.
void	ReplaceRules (const std::vector< NXOpen::SelectionIntentRule * > &rules, bool createRulesWoUpdate)
	Replace collector rules.
void	ReplaceRules (const std::vector< NXOpen::SelectionIntentRule * > &rules, const std::vector< NXOpen::DisplayableObject * > &negatedEntities, bool createRulesWoUpdate)
	Replace collector rules and specify negated entities.
void	SetInterpart (bool interpart)
	Sets inter-part status This function sets the value of interpart flag on ScCollector.
void	SetMultiComponent ()
	Sets the true option on ScCollector for collection from multiple components.
void	SetNonFeatureMode ()
	Sets the true option on ScCollector for collection in non-feature mode.
Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object.
int	Color ()
	Returns the color of the object.
void	Highlight ()
	Highlights the object.
bool	IsBlanked ()
	Returns the blank status of this object.
int	Layer ()
	Returns the layer that the object is in.
NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object.
NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object.
NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name.
void	RedisplayObject ()
	Redisplays the object in all views.
void	SetColor (int color)
	Sets the color of the object.
void	SetLayer (int layer)
	Sets the layer that the object is in.
void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object.
void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object.
void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name.
void	Unblank ()
	Unblanks the object.
void	Unhighlight ()
	Unhighlights the object.
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::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

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

Created in NX4.0.0.

Member Function Documentation

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.

<br> 

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.

<br> 

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

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

rules

Selection intent rules.

void NXOpen::ScCollector::RemoveRule

(

int

ruleIndex

)

Remove collector rule
Created in NX7.0.0.

License requirements : None

Parameters

ruleIndex

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

rules

Selection 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

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

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

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

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

interpart

True to set collector as interpart

void NXOpen::ScCollector::SetMultiComponent

(

)

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

<br> 

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.

<br> 

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