Represents a component in a Assemblies::ComponentAssembly . More...

Inheritance diagram for NXOpen::Assemblies::Component:

Public Types
enum	RepresentationMode { RepresentationModeLightweight, RepresentationModePartial, RepresentationModeExact, RepresentationModeNone }
	组件的表示状态. More...

Public Types inherited from NXOpen::DisplayableObject
enum	ObjectFont { ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline, ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed }
	指定对象（如行）的对象字体 Created in NX3.0.0. More...

enum	ObjectWidth { ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5, ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive, ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine }
	指定对象，如行和文本的对象宽度 Created in NX3.0.0. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	指定日期和时间属性的格式. More...

Public Member Functions
NXOpen::Assemblies::CollaborativeContentType	CollaborativeContentType ()
	返回此组件的协作内容类型.

NXOpen::PartFamily::InstanceSelectionCriteria *	CreateEmptyPartFamilyInstanceSelectionCriteria (NXOpen::PartFamily::Template *family)
	创建一个空的PartFamily::InstanceSelectionCriteria.

virtual void	DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
	从该对象中移除特性的输入列表.

void	DeleteInstanceUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	删除给定类型、标题和索引所遇到的第一个属性.

void	DeleteInstanceUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	删除给定类型、标题和索引所遇到的第一个属性.

void	DeleteInstanceUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	删除与给定类型相匹配的属性，以选择是否更新.

void	DeletePartFamilyInstanceSelectionCriteria ()
	Deletes PartFamily::InstanceSelectionCriteria 与此组件关联的 Created in NX9.0.0.

NXOpen::PDM::DesignElementRevision *	DesignElementRevision ()
	Returns the PDM::DesignElementRevision 对应于这个组件.

NXOpen::PDM::DesignSubordinateRevision *	DesignSubordinateRevision ()
	Returns the PDM::DesignSubordinateRevision 对应于这个组件.

NXOpen::Assemblies::ComponentAssembly *	DirectOwner ()
	Returns the Assemblies::ComponentAssembly 它将这个组件拥有为“顶级”组件.

NXOpen::ErrorList *	DisplayComponentsExact (const std::vector< NXOpen::Assemblies::Component * > &components)
	.

NXOpen::ErrorList *	DisplayComponentsLightweight (const std::vector< NXOpen::Assemblies::Component * > &components)
	设置要使用轻量级表示来显示的组件数组

NXString	DisplayName ()
	返回原型零件的显示名称.

NXString	EmptyPartRefsetName ()
	返回表示空集的引用集的名称.

NXString	EntirePartRefsetName ()
	返回表示整个部分的引用集的名称.

void	EstablishPositionOverride (NXOpen::Assemblies::Component *parent)
	确保给定父级的给定组件上有对组件的定位覆盖.

NXOpen::NXObject *	FindOccurrence (NXOpen::NXObject *proto)
	给定一个原型对象，返回该组件中相应的事件.

NXOpen::Positioning::ComponentConstraint *	FixConstraint ()
	返回一个固定 Positioning::ComponentConstraint 此组件 .

NXString	GetAsRequiredQuantity ()
	获取此组件上所需的数量.

virtual NXOpen::Routing::CharacteristicList *	GetCharacteristics ()
	获取该对象上的所有特性值.

std::vector < NXOpen::Assemblies::Component * >	GetChildren ()
	然而这返回组件的子组件，它不返回非几何部件（NGCS）使此方法也返回同时，设置以下环境变量 : UGII_ALLOW_NGC_IN_UGOPEN=YES.

NXOpen::Assemblies::ComponentQuantity	GetComponentQuantityType ()
	获取组件的数量类型

NXOpen::Assemblies::Component::RepresentationMode	GetComponentRepresentationMode ()
	返回组件主体的表示模式.

std::vector < NXOpen::Positioning::ComponentConstraint * >	GetConstraints ()
	Returns the Positioning::ComponentConstraint s 直接连接到这个组件.

NXOpen::Assemblies::DegreesOfFreedom	GetDegreesOfFreedom ()
	Returns the DegreesOfFreedom for this component.

NXOpen::Assemblies::DegreesOfFreedom	GetDegreesOfFreedom (const std::vector< NXOpen::Assemblies::Component * > &components)
	Returns the DegreesOfFreedom for this component.

virtual NXOpen::Routing::CharacteristicList *	GetDestinationCharacteristics ()
	从输入对象返回目标特性

bool	GetInstanceBooleanUserAttribute (const NXString &title, int index)
	通过标题和数组索引获取布尔属性.

bool	GetInstanceBooleanUserAttribute (const char *title, int index)
	通过标题和数组索引获取布尔属性.

int	GetInstanceIntegerUserAttribute (const NXString &title, int index)
	通过标题和数组索引获取整数属性.

int	GetInstanceIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetInstanceRealUserAttribute (const NXString &title, int index)
	通过标题和数组索引获取一个真正的属性.

double	GetInstanceRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetInstanceStringUserAttribute (const NXString &title, int index)
	通过标题和数组索引获取字符串属性.

NXString	GetInstanceStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetInstanceTimeUserAttribute (const NXString &title, int index)
	按标题和数组索引获取时间属性

NXString	GetInstanceTimeUserAttribute (const char *title, int index)
	按标题和数组索引获取时间属性.

NXOpen::NXObject::AttributeInformation	GetInstanceUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	获取给定对象、类型和数组索引上的对象（如果有的话）遇到的第一个属性.

NXOpen::NXObject::AttributeInformation	GetInstanceUserAttribute (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	GetInstanceUserAttributeAsString (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	GetInstanceUserAttributeAsString (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	GetInstanceUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	确定的位置锁定的特定属性

bool	GetInstanceUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	确定给定的属性的位置锁定 .

std::vector < NXOpen::NXObject::AttributeInformation >	GetInstanceUserAttributes ()
	获取在给定对象上设置的所有属性.

std::vector < NXOpen::NXObject::AttributeInformation >	GetInstanceUserAttributes (bool includeUnset)
	得到了所有的属性已设置给定的对象，以及从模板信息属性尚未设置（如果includeunset '是'真正的'）。

std::vector< NXString >	GetInstanceUserAttributesAsStrings ()
	获取在给定对象上设置的所有属性.

virtual int	GetIntegerCharacteristic (const NXString &name)
	获取与输入名称关联的整数特性的值.

int	GetIntegerCharacteristic (const char *name)
	Get the value of an integer characteristic associated with the input name.

int	GetIntegerQuantity ()
	获取组件的整数数量的值.

int	GetLayerOption ()
	获取图层选项.

bool	GetNonGeometricState ()
	获取组件状态为几何或非几何.

NXOpen::PartFamily::InstanceSelectionCriteria *	GetPartFamilyInstanceSelectionCriteria ()
	Obtains thePartFamily::InstanceSelectionCriteria , if it exists.

void	GetPosition (NXOpen::Point3d position, NXOpen::Matrix3x3 orientation)
	获取组件的位置.

NXOpen::Assemblies::Component *	GetPositionOverrideParent ()
	找到组件的位置被覆盖的最高级别的父级.

NXOpen::Assemblies::PositionOverrideType	GetPositionOverrideType ()
	获取组件上的最高级别定位重写的类型.

virtual double	GetRealCharacteristic (const NXString &name)
	获取与输入名称相关联的真正特性的值.

double	GetRealCharacteristic (const char *name)
	Get the value of a real characteristic associated with the input name.

double	GetRealQuantity (NXString *quantityUnits)
	获取此组件上实数和相应单位的值.

virtual NXString	GetStringCharacteristic (const NXString &name)
	获取与输入名称相关联的字符串特性的值.

NXString	GetStringCharacteristic (const char *name)
	Get the value of a string characteristic associated with the input name.

bool	HasInstanceUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	如果给定的标题、类型和数组索引在对象上存在，如果属性不是数组，则索引将被忽略（如果事先知道，我们建议将索引设置为- 1）以节省时间。

bool	HasInstanceUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if and 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	IsFixed ()
	返回此组件的固定状态.

bool	IsSuppressed ()
	返回组件在控件布局中的受抑状态.

NXOpen::Assemblies::Component *	Parent ()
	返回组件的父元素.

std::vector < NXOpen::Positioning::ComponentConstraint * >	RecallAndListConstraints ()
	Recalls the Positioning::ComponentConstraint s以前在这个组件上记住，从它们创建新的约束 .

void	RecallConstraints ()
	Recalls the Positioning::ComponentConstraint 以前在该组件的一部分上记住了，从它们创建新的约束.

NXString	ReferenceSet ()
	返回用于此组件的引用集的名称.

void	RemovePositionOverride (NXOpen::Assemblies::Component *parent)
	删除给定父级或以下组件上的最高级别定位覆盖.

void	RemoveRememberedConstraints ()
	删除存储在组件上的所有记住的约束.

virtual void	SetCharacteristic (const NXString &name, int value)
	设置与输入名称相关联的整数特征值，如果不存在，则向列表添加一个新特性.

void	SetCharacteristic (const char *name, int value)
	Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

virtual void	SetCharacteristic (const NXString &name, double value)
	Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

void	SetCharacteristic (const char *name, double value)
	Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

virtual void	SetCharacteristic (const NXString &name, const NXString &value)
	Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

void	SetCharacteristic (const char name, const char value)
	Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

virtual void	SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
	在这个对象上设置所有的特征值 .

void	SetInstanceBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	创建或修改具有更新或不更新选项的布尔属性.

void	SetInstanceBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetInstanceTimeUserAttribute (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	SetInstanceTimeUserAttribute (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	SetInstanceUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetInstanceUserAttribute (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	SetInstanceUserAttribute (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	SetInstanceUserAttribute (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	SetInstanceUserAttribute (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	SetInstanceUserAttribute (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	SetInstanceUserAttribute (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	SetInstanceUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetInstanceUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetInstanceUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetInstanceUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetLayerOption (int layer)
	设置图层选项

void	SetPartFamilyInstanceSelectionCriteria (NXOpen::PartFamily::InstanceSelectionCriteria *selectionCriteria)
	Hooks PartFamily::InstanceSelectionCriteria to this component Created in NX9.0.0.

void	SetPositioningVaried (const std::vector< NXOpen::Assemblies::Component * > &components, bool setAsVaried)
	Set positioning for the selected Assemblies::Component s across all possible Assemblies::Arrangement s.

void	SetUsedArrangement (NXOpen::Assemblies::Arrangement *newArrangement)
	Changes the Arrangement used for this component.

NXOpen::Assemblies::Subset *	Subset ()
	Returns the Assemblies::Subset that corresponds to this component.

void	Suppress ()
	Suppresses the component in the ComponentAssembly that contains its controlling Arrangement.

NXOpen::ErrorList *	Suppress (const std::vector< NXOpen::Assemblies::Component * > &components)
	Suppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.

NXOpen::Assemblies::Arrangement *	SuppressingArrangement ()
	Returns the Assemblies::Arrangement 控制该组件的抑制状态的排列.

void	Unsuppress ()
	Unsuppresses the component in the ComponentAssembly that contains its controlling Arrangement.

NXOpen::ErrorList *	Unsuppress (const std::vector< NXOpen::Assemblies::Component * > &components)
	Unsuppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.

void	UpdateStructure (const std::vector< NXOpen::Assemblies::Component * > &components, int nLevels)
	Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels, ignoring components already processed by previous calls.

void	UpdateStructure (const std::vector< NXOpen::Assemblies::Component * > &components, int nLevels, bool checkComponentsVisited)
	Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels.

NXOpen::Assemblies::Arrangement *	UsedArrangement ()
	Returns the Arrangement used for this component.

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.

Public Member Functions inherited from NXOpen::Routing::ICharacteristic
int	GetIntegerCharacteristic (const char *name)
	Get the value of an integer characteristic associated with the input name.

double	GetRealCharacteristic (const char *name)
	Get the value of a real characteristic associated with the input name.

NXString	GetStringCharacteristic (const char *name)
	Get the value of a string characteristic associated with the input name.

void	SetCharacteristic (const char *name, int value)
	Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

void	SetCharacteristic (const char *name, double value)
	Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

void	SetCharacteristic (const char name, const char value)
	Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Detailed Description

Represents a component in a Assemblies::ComponentAssembly .

Note that a Component is an occurrence whose prototype is a Part . See NXObject::Prototype .

Components are arranged in a tree, with each component having a single parent, and one or more children. The top of the tree is the Root Component (see Assemblies::ComponentAssembly::RootComponent which has a NULL parent. The components below the root are referred to as "Top Level" components, which represent the component parts that have been added directly to the ComponentAssembly. (Calling Assemblies::ComponentAssembly::AddComponent will create a new Top Level component.) Components beneath the top level represent components defined in sub-assemblies of the main assembly.

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Assemblies::Component::RepresentationMode

Representation status of a component.

Enumerator:

RepresentationModeLightweight	The component's solid bodies are all displayed using the lightweight representation.
RepresentationModePartial	The component's solid bodies are displayed with some being exact and some being shown lightweight.
RepresentationModeExact	The component's solid bodies are displayed with the exact data.
RepresentationModeNone	There are no bodies to display for the current component.

Member Function Documentation

NXOpen::Assemblies::CollaborativeContentType NXOpen::Assemblies::Component::CollaborativeContentType ( )

Returns the collaborative content type of this component.

Created in NX8.5.0.

License requirements : None

NXOpen::PartFamily::InstanceSelectionCriteria* NXOpen::Assemblies::Component::CreateEmptyPartFamilyInstanceSelectionCriteria ( NXOpen::PartFamily::Template * family )

Creates an empty PartFamily::InstanceSelectionCriteria.

Returns: Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

family family

virtual void NXOpen::Assemblies::Component::DeleteCharacterstics ( NXOpen::Routing::CharacteristicList * values )

virtual

Removes the input list of characteristics from this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Assemblies::Component::DeleteInstanceUserAttribute	(	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.

   If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored,
   otherwise the last element of the array is deleted.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .

Created in NX8.0.0.

License requirements : None

Parameters

type	type
title	title
deleteEntireArray	delete entire array
option	option

void NXOpen::Assemblies::Component::DeleteInstanceUserAttribute	(	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.

   If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored,
   otherwise the last element of the array is deleted.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .

Created in NX8.0.0.

License requirements : None

Parameters

type	type
title	title
deleteEntireArray	delete entire array
option	option

void NXOpen::Assemblies::Component::DeleteInstanceUserAttributes	(	NXOpen::NXObject::AttributeType	type,
		NXOpen::Update::Option	option
	)

Deletes the attributes encountered with the given Type with option to update or not.

   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .

Created in NX8.0.0.

License requirements : None

Parameters

type	type
option	option

void NXOpen::Assemblies::Component::DeletePartFamilyInstanceSelectionCriteria ( )

Deletes PartFamily::InstanceSelectionCriteria associated with this component
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::PDM::DesignElementRevision* NXOpen::Assemblies::Component::DesignElementRevision ( )

Returns the PDM::DesignElementRevision that corresponds to this component.

   This can be NULL if the component is not a design element.
   This will return parent reuse design element revision if this component represent a @link DesignSubordinateRevision DesignSubordinateRevision@endlink  .

Created in NX8.5.0.

License requirements : None

NXOpen::PDM::DesignSubordinateRevision* NXOpen::Assemblies::Component::DesignSubordinateRevision ( )

Returns the PDM::DesignSubordinateRevision that corresponds to this component.

   This can be NULL if the component is not a subordinate design element.

Created in NX8.5.0.

License requirements : None

NXOpen::Assemblies::ComponentAssembly* NXOpen::Assemblies::Component::DirectOwner ( )

Returns the Assemblies::ComponentAssembly which owns this component as a "Top Level" component.

   For components in a multi-level assembly, this is NOT the same the part that owns this component object. 
   I.e. it is not the same as calling:
    @code 
    NXObject.OwningPart()
    @endcode 
    @code 
   BasePart.ComponentAssembly()
    @endcode

Created in NX3.0.0.

License requirements : None

NXOpen::ErrorList* NXOpen::Assemblies::Component::DisplayComponentsExact ( const std::vector< NXOpen::Assemblies::Component * > & components )

Sets an array of components to display using the exact representation.

@return  list of errors encountered during the display as exact

Created in NX7.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters

components Array of componets to be set to exact

NXOpen::ErrorList* NXOpen::Assemblies::Component::DisplayComponentsLightweight ( const std::vector< NXOpen::Assemblies::Component * > & components )

Sets an array of components to display using the lightweight representation.

@return  list of errors encountered during the display as lightweight

Created in NX7.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters

components Array of components to be set to lightweight

NXString NXOpen::Assemblies::Component::DisplayName ( )

Returns the displayable name of the prototype part.

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXString NXOpen::Assemblies::Component::EmptyPartRefsetName ( )

Returns the name of the reference set which represents the empty set.

This can be used as a parameter to Assemblies::ComponentAssembly::ReplaceReferenceSet .

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXString NXOpen::Assemblies::Component::EntirePartRefsetName ( )

Returns the name of the reference set which represents the entire part.

This can be used as a parameter to Assemblies::ComponentAssembly::ReplaceReferenceSet .

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::Component::EstablishPositionOverride ( NXOpen::Assemblies::Component * parent )

Ensures there is a positioning override on component in the given part of the given parent.

This method does nothing if the component already has a positioning override in the parent, or if any necessary data is unloaded.

parent may be NULL, in which case the positioning override will be created in the same part as the component.

Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

parent The parent of the component in which the override is to be created

NXOpen::NXObject* NXOpen::Assemblies::Component::FindOccurrence ( NXOpen::NXObject * proto )

Given a prototype object, returns the corresponding occurrence in this component.

Returns: the occurrence of the prototype in this component
Created in NX3.0.0.

License requirements : None

Parameters

proto the prototype

NXOpen::Positioning::ComponentConstraint* NXOpen::Assemblies::Component::FixConstraint ( )

Returns a fix Positioning::ComponentConstraint of this component.

   The constraint may be suppressed or NULL.  If the part 
   controlling the position of this component is not loaded then NULL
   will be returned.

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXString NXOpen::Assemblies::Component::GetAsRequiredQuantity ( )

Gets the as-required quantity on this component.

@return  As-Required string "A/R"

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

virtual NXOpen::Routing::CharacteristicList* NXOpen::Assemblies::Component::GetCharacteristics ( )

virtual

Get all of the characteristics values on the this object.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

std::vector<NXOpen::Assemblies::Component *> NXOpen::Assemblies::Component::GetChildren ( )

Returns the child components of this component However, it does not return non-geometric components (NGCs) To enable this method to also return NGCs, set the following environment variable: UGII_ALLOW_NGC_IN_UGOPEN=YES.

Returns: Created in NX3.0.0.

License requirements : None

NXOpen::Assemblies::ComponentQuantity NXOpen::Assemblies::Component::GetComponentQuantityType ( )

Gets the quantity type of the components.

Returns Assemblies::ComponentQuantity .

Returns: Quantity type an enumeration value
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::Component::RepresentationMode NXOpen::Assemblies::Component::GetComponentRepresentationMode ( )

Returns the representation mode for the component's bodies.

  This mode is dependent on the currently used reference set for the component.
@return  The mode for the components display. An enumeration value.

Created in NX7.5.0.

License requirements : None

std::vector<NXOpen::Positioning::ComponentConstraint *> NXOpen::Assemblies::Component::GetConstraints ( )

Returns the Positioning::ComponentConstraint s directly connected to this component.

If the part containing those constraints is not loaded then no constraints will be returned.

Returns: Constraints directly connected to this component
Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::DegreesOfFreedom NXOpen::Assemblies::Component::GetDegreesOfFreedom ( )

Returns the DegreesOfFreedom for this component.

   Any constraints that reference unloaded data are ignored in the degrees of freedom calculation. An example
   would be if a constraint was referencing geometry in an unloaded component. When this occurs there may be
   a greater number of degrees of freedom than if all the data were loaded.
@return  The degrees of freedom of this component.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::DegreesOfFreedom NXOpen::Assemblies::Component::GetDegreesOfFreedom ( const std::vector< NXOpen::Assemblies::Component * > & components )

Returns the DegreesOfFreedom for this component.

   The degrees of freedom are found relative to the components passed in.
   Those components are regarded as fixed and only constraints directly 
   connecting this component with those in the array are considered.

   Note that any directly connected constraints that reference unloaded data
   are ignored in the degrees of freedom calculation. An example would be if
   a constraint was referencing geometry in an unloaded component. When this
   occurs there may be a greater number of degrees of freedom than if all
   the data were loaded.         
@return  The degrees of freedom of this component.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components Components relative to which the degrees of freedom will be found.

virtual NXOpen::Routing::CharacteristicList* NXOpen::Assemblies::Component::GetDestinationCharacteristics ( )

virtual

Returns the destination characteristics from the input object.

         Retrieves the description of which destination characteristics to read
         from the application view and then reads those destination 
         characteristics from the object
         <ul>
             <li>Ports: Reads characteristics from the port.</li>
             <li>RCPs: Attempts to find a port at the RCP, reads characteristics from
                         the port if it exists, otherwise reads from the
                         stock associated with the rcp.</li>
             <li>Segments: Reads characteristics from the stock associated with the segment.</li>
             <li>Components: Reads characteristics directly from the component.</li>
             <li>Stock: Reads characteristics from the stock or from the stock's data.</li>
         </ul>
    @return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

bool NXOpen::Assemblies::Component::GetInstanceBooleanUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a boolean attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

bool NXOpen::Assemblies::Component::GetInstanceBooleanUserAttribute	(	const char *	title,
		int	index
	)

Gets a boolean attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

int NXOpen::Assemblies::Component::GetInstanceIntegerUserAttribute	(	const NXString &	title,
		int	index
	)

Gets an integer attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

int NXOpen::Assemblies::Component::GetInstanceIntegerUserAttribute	(	const char *	title,
		int	index
	)

Gets an integer attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

double NXOpen::Assemblies::Component::GetInstanceRealUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a real attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

double NXOpen::Assemblies::Component::GetInstanceRealUserAttribute	(	const char *	title,
		int	index
	)

Gets a real attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::Assemblies::Component::GetInstanceStringUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a string attribute by Title and array Index.

   For reference type string attributes, the calculated StringValue is returned.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   Gets a string attribute value by title.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::Assemblies::Component::GetInstanceStringUserAttribute	(	const char *	title,
		int	index
	)

Gets a string attribute by Title and array Index.

   For reference type string attributes, the calculated StringValue is returned.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   Gets a string attribute value by title.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::Assemblies::Component::GetInstanceTimeUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a time attribute by Title and array Index.

   The date format set by the Customer Defaults is used.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink . 
   Gets a time attribute by title.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::Assemblies::Component::GetInstanceTimeUserAttribute	(	const char *	title,
		int	index
	)

Gets a time attribute by Title and array Index.

   The date format set by the Customer Defaults is used.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink . 
   Gets a time attribute by title.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXOpen::NXObject::AttributeInformation NXOpen::Assemblies::Component::GetInstanceUserAttribute	(	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.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

NXOpen::NXObject::AttributeInformation NXOpen::Assemblies::Component::GetInstanceUserAttribute	(	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.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

NXString NXOpen::Assemblies::Component::GetInstanceUserAttributeAsString	(	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.

   The value of the attribute is converted to and returned as a string.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributesAsStrings NXObject::GetUserAttributesAsStrings@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, the calculated StringValue is returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

NXString NXOpen::Assemblies::Component::GetInstanceUserAttributeAsString	(	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.

   The value of the attribute is converted to and returned as a string.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributesAsStrings NXObject::GetUserAttributesAsStrings@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, the calculated StringValue is returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

bool NXOpen::Assemblies::Component::GetInstanceUserAttributeLock	(	const NXString &	title,
		NXOpen::NXObject::AttributeType	type
	)

Determine the lock of the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

bool NXOpen::Assemblies::Component::GetInstanceUserAttributeLock	(	const char *	title,
		NXOpen::NXObject::AttributeType	type
	)

Determine the lock of the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::Assemblies::Component::GetInstanceUserAttributes ( )

Gets all the attributes that have been set on the given object.

   The elements of array attributes are returned individually in order of increasing indices. 
   The returned Title of an array element is the array title (without index). The Index data member holds the index.
   The date format set by the Customer Defaults is used.
   Reference type attributes are returned as being of type @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink ,
   and both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::Assemblies::Component::GetInstanceUserAttributes ( bool includeUnset )

Gets all the attributes that have been set on the given object, as well as information from attribute templates that have not been set (if 'IncludeUnset' is 'true').

   The elements of array attributes are returned individually in order of increasing indices. 
   The returned Title of an array element is the array title (without index). The Index data member holds the index.
   The date format set by the Customer Defaults is used.
   Reference type attributes are returnes as being of type @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink ,
   and both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

includeUnset includeunset

std::vector<NXString> NXOpen::Assemblies::Component::GetInstanceUserAttributesAsStrings ( )

Gets all the attributes that have been set on the given object.

   The values are returned as strings.
   The elements of array attributes are returned individually in order of increasing indices. 
   The returned Title of an array element is the array title (without index). The Index data member holds the index.
   This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
   Reference type attributes return the calculated StringValue.
   The date format set by the Customer Defaults is used.  @return

Created in NX8.0.0.

License requirements : None

virtual int NXOpen::Assemblies::Component::GetIntegerCharacteristic ( const NXString & name )

virtual

Get the value of an integer characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

int NXOpen::Assemblies::Component::GetIntegerCharacteristic ( const char * name )

Get the value of an integer characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::Assemblies::Component::GetIntegerQuantity ( )

Gets the value of the integer quantity of component.

@return  Integer quantity value

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

int NXOpen::Assemblies::Component::GetLayerOption ( )

Gets the layer option.

This controls which layer the component's geometry will appear on in its parent part.

Returns: The layer option of the component in its parent part -1 Means that the component's geometry has the layer settings defined in its orginal part 1-255 Means the components geometry is on the specified layer

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

bool NXOpen::Assemblies::Component::GetNonGeometricState ( )

Gets the component state as Geometric or Non-Geometric.

@return  True if the component is non-geometric, false otherwise

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::PartFamily::InstanceSelectionCriteria* NXOpen::Assemblies::Component::GetPartFamilyInstanceSelectionCriteria ( )

Obtains thePartFamily::InstanceSelectionCriteria , if it exists.

Returns: Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Assemblies::Component::GetPosition	(	NXOpen::Point3d *	position,
		NXOpen::Matrix3x3 *	orientation
	)

Gets the position of a component.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

position	The origin of this component
orientation	The orientation of this component

NXOpen::Assemblies::Component* NXOpen::Assemblies::Component::GetPositionOverrideParent ( )

Find the highest level parent in which the position of component is overridden.

This will be NULL if the component is not overridden. It will be the root component if the component is overridden in the same part as itself. It will be NULL if the position of the component is overridden in a parent assembly which is currently unloaded.

Returns: Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::PositionOverrideType NXOpen::Assemblies::Component::GetPositionOverrideType ( )

Gets the type of the highest level positioning override on the component.

@return

Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

virtual double NXOpen::Assemblies::Component::GetRealCharacteristic ( const NXString & name )

virtual

Get the value of a real characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

double NXOpen::Assemblies::Component::GetRealCharacteristic ( const char * name )

Get the value of a real characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

double NXOpen::Assemblies::Component::GetRealQuantity ( NXString * quantityUnits )

Gets the value of real quantity and corresponding units on this component.

@return  Real quantity value

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

quantityUnits Units

virtual NXString NXOpen::Assemblies::Component::GetStringCharacteristic ( const NXString & name )

virtual

Get the value of a string characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

NXString NXOpen::Assemblies::Component::GetStringCharacteristic ( const char * name )

Get the value of a string characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::Assemblies::Component::HasInstanceUserAttribute	(	const NXString &	title,
		NXOpen::NXObject::AttributeType	type,
		int	index
	)

Determines if and 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).

   The first element of an array has Index 0 (zero).
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

bool NXOpen::Assemblies::Component::HasInstanceUserAttribute	(	const char *	title,
		NXOpen::NXObject::AttributeType	type,
		int	index
	)

Determines if and 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).

   The first element of an array has Index 0 (zero).
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

bool NXOpen::Assemblies::Component::IsFixed ( )

Returns the fixed state of this component.

True if there is an unsuppressed Positioning::ComponentConstraint fix constraint on this component and false otherwise. If the part controlling the position of this component is not loaded then false will be returned.

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

bool NXOpen::Assemblies::Component::IsSuppressed ( )

Returns the suppressed state of the component in its controlling arrangement.

   (See @link Assemblies::Component::SuppressingArrangement Assemblies::Component::SuppressingArrangement@endlink .)

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::Component* NXOpen::Assemblies::Component::Parent ( )

Returns the parent of the component.

For the root component of an assembly, this will be NULL. See Assemblies::ComponentAssembly::RootComponent .

Created in NX3.0.0.

License requirements : None

std::vector<NXOpen::Positioning::ComponentConstraint *> NXOpen::Assemblies::Component::RecallAndListConstraints ( )

Recalls the Positioning::ComponentConstraint s previously remembered on the part of this component, creating new constraints from them.

The new constraints are incomplete and refer to the component.

Returns: The constraints created by the recall operation
Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::Component::RecallConstraints ( )

Recalls the Positioning::ComponentConstraint s previously remembered on the part of this component, creating new constraints from them.

The new constraints are incomplete and refer to the component.

Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXString NXOpen::Assemblies::Component::ReferenceSet ( )

Returns the name of the reference set used for this component.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::Component::RemovePositionOverride ( NXOpen::Assemblies::Component * parent )

Removes the highest level positioning override on component in or below the given parent.

parent may be NULL, in which case the highest level positioning override on component is removed. This method does nothing if there is no positioning override on the component, or if any necessary data is unloaded.

Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

parent The parent of the component in or below which the override is to be removed

void NXOpen::Assemblies::Component::RemoveRememberedConstraints ( )

Remove all the remembered constraints stored on the part of this component.

Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

virtual void NXOpen::Assemblies::Component::SetCharacteristic	(	const NXString &	name,
		int	value
	)

virtual

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Assemblies::Component::SetCharacteristic	(	const char *	name,
		int	value
	)

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

virtual void NXOpen::Assemblies::Component::SetCharacteristic	(	const NXString &	name,
		double	value
	)

virtual

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Assemblies::Component::SetCharacteristic	(	const char *	name,
		double	value
	)

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

virtual void NXOpen::Assemblies::Component::SetCharacteristic	(	const NXString &	name,
		const NXString &	value
	)

virtual

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Assemblies::Component::SetCharacteristic	(	const char *	name,
		const char *	value
	)

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	NOTE: The full Unicode character set is not supported for this parameter.

virtual void NXOpen::Assemblies::Component::SetCharacteristics ( NXOpen::Routing::CharacteristicList * values )

virtual

Set all of the characteristics values on this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Assemblies::Component::SetInstanceBooleanUserAttribute	(	const NXString &	title,
		int	index,
		bool	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a boolean attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceBooleanUserAttribute	(	const char *	title,
		int	index,
		bool	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a boolean attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceTimeUserAttribute	(	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.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.
option	option

void NXOpen::Assemblies::Component::SetInstanceTimeUserAttribute	(	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.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	const NXOpen::NXObject::AttributeInformation &	info,
		NXOpen::Update::Option	option
	)

Creates or modifies an attribute with the option to update or not.

   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, set the type to @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink  and specify a ReferenceValue.

   The following data members of the Info structure are ignored by this method:
       Alias
       Inherited
       Required
       Unset
       Locked

   The following data members of an attribute cannot be edited once the attribute is set:
       Type 
       Title
       TitleAlias
       Array
       ArrayElementIndex
       The dimensionality of the Unit specification (cannot change from mm to microA, but from mm to cm is fine) 

   The following data members can be set and modified only if the attribute is not associated with a template:
       Category

   The following data of an attribute can be set if and only if the attribute is not associated with a template. It cannot be modified once set.
       Array

Created in NX8.0.0.

License requirements : None

Parameters

info	info
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	const NXString &	title,
		int	index,
		int	value,
		NXOpen::Update::Option	option
	)

Creates or modifies an integer attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	const char *	title,
		int	index,
		int	value,
		NXOpen::Update::Option	option
	)

Creates or modifies an integer attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	const NXString &	title,
		int	index,
		double	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a real attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	const char *	title,
		int	index,
		double	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a real attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	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.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	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.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	const NXString &	title,
		int	index,
		NXOpen::Update::Option	option
	)

Creates or modifies a null attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttribute	(	const char *	title,
		int	index,
		NXOpen::Update::Option	option
	)

Creates or modifies a null attribute with the option to update or not.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
option	option

void NXOpen::Assemblies::Component::SetInstanceUserAttributeLock	(	const NXString &	title,
		NXOpen::NXObject::AttributeType	type,
		bool	lock
	)

Lock or unlock the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
lock	lock

void NXOpen::Assemblies::Component::SetInstanceUserAttributeLock	(	const char *	title,
		NXOpen::NXObject::AttributeType	type,
		bool	lock
	)

Lock or unlock the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
lock	lock

void NXOpen::Assemblies::Component::SetLayerOption ( int layer )

Sets the layer option.

This controls which layer the component's geometry will appear on in its parent part.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

layer The new layer for this component in its parent part -1 Means use the original layer settings defined in the component's part. 0 Means use the current work layer 1-255 Means use the specified layer.

void NXOpen::Assemblies::Component::SetPartFamilyInstanceSelectionCriteria ( NXOpen::PartFamily::InstanceSelectionCriteria * selectionCriteria )

Hooks PartFamily::InstanceSelectionCriteria to this component
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

selectionCriteria selectioncriteria

void NXOpen::Assemblies::Component::SetPositioningVaried	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		bool	setAsVaried
	)

Set positioning for the selected Assemblies::Component s across all possible Assemblies::Arrangement s.

Positioning can be set to either the same in all Assemblies::Arrangement s, set_as_varied = FALSE, or individually positioned in each, set_as_varied = TRUE.
Created in NX7.5.2.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	The components whose positioning will be altered.
setAsVaried	If FALSE components will have same position in all Assemblies::Arrangement s, TRUE allows the position to be varied.

void NXOpen::Assemblies::Component::SetUsedArrangement ( NXOpen::Assemblies::Arrangement * newArrangement )

Changes the Arrangement used for this component.

If this is the root component (i.e. it has no parent) then this is equivalent to setting the active arrangement in the owner. (See Assemblies::Component::DirectOwner and Assemblies::ComponentAssembly::SetActiveArrangement .) For non-root components, this sets the arrangement used for this component in the context of its parent component. Note that this method should only be used for components which have children.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

newArrangement The new Assemblies::Arrangement . This Arrangement must be defined in a the ComponentAssembly of this Component's prototype part.

NXOpen::Assemblies::Subset* NXOpen::Assemblies::Component::Subset ( )

Returns the Assemblies::Subset that corresponds to this component.

   This can be NULL if the component is not a subset.

Created in NX8.5.0.

License requirements : None

void NXOpen::Assemblies::Component::Suppress ( )

Suppresses the component in the ComponentAssembly that contains its controlling Arrangement.

   The component will be suppressed in all Arrangements in the ComponentAssembly, not just
   in the controlling arrangement.
    <br> This is equivalent to calling: <br> 

    <br> @link Assemblies::Component::SuppressingArrangement Assemblies::Component::SuppressingArrangement@endlink  <br> 
    <br> @link Assemblies::Arrangement::Owner Assemblies::Arrangement::Owner@endlink  <br> 
    <br> @link Assemblies::ComponentAssembly::SuppressComponents Assemblies::ComponentAssembly::SuppressComponents@endlink  <br>

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::ErrorList* NXOpen::Assemblies::Component::Suppress ( const std::vector< NXOpen::Assemblies::Component * > & components )

Suppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.

The component will be suppressed in all Arrangements in the ComponentAssembly.
This is equivalent to calling:

Assemblies::Component::SuppressingArrangement

Assemblies::Arrangement::Owner

And then calling

Assemblies::ComponentAssembly::SuppressComponents

on the component array. Note that all components should have the same suppressing Arrangement.

Returns: list of errors encountered during the suppress
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components Components to be suppressed. Each component will be suppressed in its controlling arrangement. Note that the components must all be underneath the same assembly

NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::Component::SuppressingArrangement ( )

Returns the Assemblies::Arrangement that controls this component's suppression state.

The controlling Arrangement will be defined in a Assemblies::ComponentAssembly in the tree above this Component.
Note: In the current release, Arrangements are only used for controlling a component's suppression state. In future releases, further attributes will be controlled via Arrangements.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::Component::Unsuppress ( )

Unsuppresses the component in the ComponentAssembly that contains its controlling Arrangement.

   The component will be unsuppressed in all Arrangements in the ComponentAssembly.
    <br> This is equivalent to calling: <br> 

    <br> @link Assemblies::Component::SuppressingArrangement Assemblies::Component::SuppressingArrangement@endlink  <br> 
    <br> @link Assemblies::Arrangement::Owner Assemblies::Arrangement::Owner@endlink  <br> 
   @link Assemblies::ComponentAssembly::UnsuppressComponents Assemblies::ComponentAssembly::UnsuppressComponents@endlink

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::ErrorList* NXOpen::Assemblies::Component::Unsuppress ( const std::vector< NXOpen::Assemblies::Component * > & components )

Unsuppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.

The component will be unsuppressed in all Arrangements in the ComponentAssembly. This is equivalent to calling:

Assemblies::Component::SuppressingArrangement

Assemblies::Arrangement::Owner

Assemblies::ComponentAssembly::UnsuppressComponents

on the component array. Note that all components should have the same suppressing Arrangement.

Returns: list of errors encountered during the unsuppress
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components Components to be unsuppressed. Each component will be unsuppressed in its controlling arrangement. Note that the components must all be underneath the same assembly

void NXOpen::Assemblies::Component::UpdateStructure	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		int	nLevels
	)

Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels, ignoring components already processed by previous calls.

Created in NX4.0.0.

License requirements : gateway ("UG GATEWAY")

Parameters

components	Component tags to start update structure from
nLevels	The number of levels to update. If -1 then all levels are updated.

void NXOpen::Assemblies::Component::UpdateStructure	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		int	nLevels,
		bool	checkComponentsVisited
	)

Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels.

Created in NX4.0.1.

License requirements : gateway ("UG GATEWAY")

Parameters

components	Component tags to start update structure from
nLevels	The number of levels to update. If -1 then all levels are updated.
checkComponentsVisited	If true, only perform update structure on each component once this session.

NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::Component::UsedArrangement ( )

Returns the Arrangement used for this component.

See Assemblies::Component::SetUsedArrangement

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

The documentation for this class was generated from the following file:

Assemblies_Component.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation