NXOpen::Assemblies::ComponentAssembly Class Reference

Represents the set of Assemblies::Component s that make up an assembly. More...

Inheritance diagram for NXOpen::Assemblies::ComponentAssembly:

Public Types
enum	CheckinCheckoutOption { CheckinCheckoutOptionDesignElement, CheckinCheckoutOptionSourceItem, CheckinCheckoutOptionBoth, CheckinCheckoutOptionDefault }
	检查并检查组件的选项.  More...
enum	CloseModified { CloseModifiedFalse, CloseModifiedTrue }
	指示组件在修改组件时应如何处理组件部分.  More...
enum	OpenComponentStatus { OpenComponentStatusSuccessfullyOpened, OpenComponentStatusDeletedByOpen, OpenComponentStatusCouldNotOpen }
	Open Component Status. More...
enum	OpenOption { OpenOptionComponentOnly, OpenOptionImmediateChildren, OpenOptionWholeAssembly, OpenOptionReapplyRevRule }
	打开组件的开放选项.  More...
enum	OrderTargetLocation { OrderTargetLocationPlaceBefore, OrderTargetLocationPlaceAfter }
	选项控制是否重新排序Assemblies::Component s are placed before or after the target Assemblies::Component. More...
enum	SubstitutionMode { SubstitutionModeNonAssociative, SubstitutionModeSingleComponent, SubstitutionModeAll }
	定义如何执行组件替换操作.  More...
enum	SuppressedState {   SuppressedStateInherit, SuppressedStateSuppressed, SuppressedStateUnsuppressed, SuppressedStateSuppressedByExp,   SuppressedStateUnsuppressedByExp }
	定义了组件的抑制状态.  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 }
	Specifies the format of the date and time attribute. More...

Public Member Functions
NXOpen::Assemblies::Arrangement *	ActiveArrangement ()
	返回当前活动的Assemblies::Arrangement for this ComponentAssembly.
NXOpen::Assemblies::Component *	AddComponent (const NXString &partToAdd, const NXString &referenceSetName, const NXString &componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	创建一个新的Assemblies::Component 在这个程序集中，基于现有的部分文件.
NXOpen::Assemblies::Component *	AddComponent (const char *partToAdd, const char *referenceSetName, const char *componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	Creates a new Assemblies::Component in this assembly, based on an existing part file.
NXOpen::Assemblies::Component *	AddComponent (const NXString &partToAdd, const NXString &referenceSetName, const NXString &componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus, bool uomAsNgc)
	Creates a new Assemblies::Component 在这个程序集中，基于现有的部分文件.
NXOpen::Assemblies::Component *	AddComponent (const char *partToAdd, const char *referenceSetName, const char *componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus, bool uomAsNgc)
	Creates a new Assemblies::Component in this assembly, based on an existing part file.
NXOpen::Assemblies::Component *	AddComponent (NXOpen::BasePart *partToAdd, const NXString &referenceSetName, const NXString &componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	Creates a new Assemblies::Component in this assembly, based on an existing part file.
NXOpen::Assemblies::Component *	AddComponent (NXOpen::BasePart *partToAdd, const char *referenceSetName, const char *componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	Creates a new Assemblies::Component in this assembly, based on an existing part file.
NXOpen::Assemblies::Component *	AddMasterPartComponent (const NXString &partToAdd, const NXString &referenceSetName, const NXString &componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	创建一个新的Assemblies::Component在本装配中作为主件.
NXOpen::Assemblies::Component *	AddMasterPartComponent (const char *partToAdd, const char *referenceSetName, const char *componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	Creates a new Assemblies::Component in this assembly as master part.
NXOpen::Assemblies::Component *	AddMasterPartComponent (NXOpen::Part *partToAdd, const NXString &referenceSetName, const NXString &componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	Creates a new Assemblies::Component in this assembly as master part.
NXOpen::Assemblies::Component *	AddMasterPartComponent (NXOpen::Part *partToAdd, const char *referenceSetName, const char *componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, NXOpen::PartLoadStatus **loadStatus)
	Creates a new Assemblies::Component in this assembly as master part.
NXOpen::PartLoadStatus *	AddPendingComponent (const NXString &partToAdd, NXOpen::NXObject *pendingComponent, const NXString &referenceSetName, const NXString &componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, bool uomAsNgc)
	Add a pending Assemblies::Component in this assembly.
NXOpen::PartLoadStatus *	AddPendingComponent (const char *partToAdd, NXOpen::NXObject *pendingComponent, const char *referenceSetName, const char *componentName, const NXOpen::Point3d &basePoint, const NXOpen::Matrix3x3 &orientation, int layer, bool uomAsNgc)
	Add a pending Assemblies::Component in this assembly.
NXOpen::Assemblies::ArrangementCollection *	Arrangements ()
	收集Assemblies::Arrangement 定义在ComponentAssembly Created in NX3.0.0.
void	ChangeByName (const NXString &name, const std::vector< NXOpen::Assemblies::Component * > &partOccs)
	Changes the current Arrangement of the given Component s to the Arrangement with the given name.
void	ChangeByName (const char *name, const std::vector< NXOpen::Assemblies::Component * > &partOccs)
	Changes the current Arrangement of the given Component s to the Arrangement with the given name.
NXOpen::ErrorList *	CheckinComponents (const std::vector< NXOpen::Assemblies::Component * > &partOccs, NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkinInputOption)
	按选项在组件数组中进行检查Assemblies::ComponentAssembly::CheckinCheckoutOption .
NXOpen::ErrorList *	CheckinWorkset ()
	检查工作的组.
NXOpen::ErrorList *	CheckoutAllModifiedObjects (std::vector< NXOpen::NXObject * > &checkedOutObjects)
	检查当前会话中的所有修改对象.
NXOpen::ErrorList *	CheckoutComponents (const std::vector< NXOpen::Assemblies::Component * > &partOccs, NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkoutInputOption)
	按选项检查组件数组Assemblies::ComponentAssembly::CheckinCheckoutOption .
NXOpen::ErrorList *	CheckoutWorkset ()
	检查工作集.
NXOpen::Assemblies::ClearanceSetCollection *	ClearanceSets ()
	The collection of Assemblies::ClearanceSet s defined in the ComponentAssembly Created in NX9.0.0.
NXOpen::PartCloseStatus *	CloseComponents (const std::vector< NXOpen::Assemblies::Component * > &componentsToClose, NXOpen::BasePart::CloseWholeTree wholeTree, NXOpen::Assemblies::ComponentAssembly::CloseModified closeModified)
	给定一组组件，关闭组件.
NXOpen::Assemblies::ComponentPatternCollection *	ComponentPatterns ()
	The collection of Assemblies::ComponentPattern defined in the ComponentAssembly Created in NX9.0.0.
void	ConvertRememberedMcs ()
	将此组件中所有记住的匹配约束转换为所记住的程序集约束.
std::vector < NXOpen::Assemblies::Component * >	CopyComponents (const std::vector< NXOpen::Assemblies::Component * > &components)
	给定一组组件，创建组件的副本，以便每个副本在原始组件的父组件下创建.
NXOpen::Assemblies::ComponentPatternBuilder *	CreateComponentPatternBuilder (NXOpen::Assemblies::ComponentPattern *compPattern)
	Creates a Assemblies::ComponentPatternBuilder object This can be used to create or edit a component pattern.
NXOpen::Positioning::ComponentConstraintGroupBuilder *	CreateConstraintGroupBuilder (NXOpen::Positioning::ComponentConstraintGroup *group, NXOpen::Assemblies::Component *contextComponent)
	Creates a Positioning::ComponentConstraintGroupBuilder object.
NXOpen::Positioning::MatingConverter *	CreateMatingConverter ()
	Creates a Positioning::MatingConverter object for this assembly.
void	DeleteMatingConditions ()
	删除此装配中的所有匹配条件.
NXOpen::Assemblies::ExplosionCollection *	Explosions ()
	The collection of Assemblies::Explosion s defined in the ComponentAssembly Created in NX3.0.0.
NXString	GetAsRequiredQuantity (NXOpen::Assemblies::Component *component)
	获取此组件上所需的数量.
void	GetCheckedoutStatusOfObjects (std::vector< NXOpen::NXObject * > &checkedOutObjects, std::vector< NXOpen::NXObject * > &uncheckedOutObjects)
	返回的检出情况（检出/未检出）的所有对象的开放 in NX.
void	GetComponentOrders (std::vector< NXOpen::Assemblies::ComponentOrder * > &orders)
	Returns all Assemblies::ComponentOrder s 可用部件 Created in NX9.0.0.
NXOpen::Assemblies::ComponentQuantity	GetComponentQuantityType (NXOpen::Assemblies::Component *component)
	获取组件的数量类型.
int	GetIntegerQuantity (NXOpen::Assemblies::Component *component)
	获取组件的整数数量的值.
bool	GetNonGeometricState (NXOpen::Assemblies::Component *component)
	获取组件状态为几何或非几何.
double	GetRealQuantity (NXOpen::Assemblies::Component *component, NXString *units)
	获取此组件上实数和相应单位的值.
NXOpen::Assemblies::ComponentAssembly::SuppressedState	GetSuppressedState (NXOpen::Assemblies::Component *component, bool *controlled)
	获取组件在控件配置中的抑制状态.
NXOpen::Assemblies::ComponentAssembly::SuppressedState	GetSuppressedState (NXOpen::Assemblies::Component *component, NXOpen::Assemblies::Arrangement *arrangement, bool *controlled)
	获取给定设置中组件的抑制状态.
NXOpen::Expression *	GetSuppressionExpression (NXOpen::Assemblies::Component *component)
	获取控制控件中组件的抑制的表达式.
NXOpen::Expression *	GetSuppressionExpression (NXOpen::Assemblies::Component *component, NXOpen::Assemblies::Arrangement *arrangement)
	获取表达式控制在给定的编排成分抑制.
NXOpen::Assemblies::Component *	MapComponentFromParent (NXOpen::Assemblies::Component *component)
	将父组件中的组件映射到此程序集中的相应组件.
std::vector < NXOpen::Assemblies::Component * >	MapComponentsFromSubassembly (NXOpen::Assemblies::Component *component)
	将子组件中的组件映射到父装配中的相应组件上.
void	MoveComponent (NXOpen::Assemblies::Component *component, const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation)
	一个组件指定一个平移和旋转的动作.
NXOpen::PartLoadStatus *	OpenComponents (NXOpen::Assemblies::ComponentAssembly::OpenOption openOption, const std::vector< NXOpen::Assemblies::Component * > &componentsToOpen, std::vector< NXOpen::Assemblies::ComponentAssembly::OpenComponentStatus > &openStatus)
	给定一个组件数组，使用open选项打开组件.
NXOpen::Assemblies::OrderCollection *	OrdersSet ()
	The collection of Assemblies::Order s defined in the ComponentAssembly Created in NX9.0.0.
NXOpen::Positioning::ComponentPositioner *	Positioner ()
	返回此组件的组件定位器.
NXOpen::ErrorList *	ReleaseSuppression (const std::vector< NXOpen::Assemblies::Component * > &components, const std::vector< NXOpen::Assemblies::Arrangement * > &arrangements)
	释放控制一组元件的抑制状态.
NXOpen::ErrorList *	ReleaseSuppression (const std::vector< NXOpen::Assemblies::Component * > &components)
	Release control of the suppression state of an array of components.
void	RemoveComponent (NXOpen::Assemblies::Component *component)
	从这个集合中移除一个组件.
void	ReorderChildrenOfParent (NXOpen::Assemblies::ComponentOrder *order, NXOpen::Assemblies::Component *parentComponent, const std::vector< NXOpen::Assemblies::Component * > &componentsToReorder)
	Assigns a new order to immediate children Assemblies::Component s of parent Assemblies::Component .
void	ReorderComponents (NXOpen::Assemblies::ComponentOrder *order, const std::vector< NXOpen::Assemblies::Component * > &componentsToReorder, NXOpen::Assemblies::Component *targetComponent, NXOpen::Assemblies::ComponentAssembly::OrderTargetLocation beforeOrAfter)
	Reorders the array of Assemblies::Component s before or after the target Assemblies::Component .
void	ReplaceReferenceSet (NXOpen::Assemblies::Component *component, const NXString &newReferenceSet)
	替换组件使用的引用集.
void	ReplaceReferenceSet (NXOpen::Assemblies::Component *component, const char *newReferenceSet)
	替换组件使用的引用集.
NXOpen::ErrorList *	ReplaceReferenceSetInOwners (const NXString &newReferenceSet, const std::vector< NXOpen::Assemblies::Component * > &components)
	设置用于表示数组中每个组件的引用集.
NXOpen::ErrorList *	ReplaceReferenceSetInOwners (const char *newReferenceSet, const std::vector< NXOpen::Assemblies::Component * > &components)
	设置用于表示数组中每个组件的引用集.
void	RestructureComponents (const std::vector< NXOpen::Assemblies::Component * > &origComponents, NXOpen::Assemblies::Component *newParentComponent, bool deleteFlag, std::vector< NXOpen::Assemblies::Component * > &newComponents, NXOpen::ErrorList **errorList)
	给定一组组件和一个指定的父函数，这个函数将将给定的组件传递给父进程。.
NXOpen::Assemblies::Component *	RootComponent ()
	Returns.
void	SetActiveArrangement (NXOpen::Assemblies::Arrangement *newArrangement)
	设置当前活动 Assemblies::Arrangement for this ComponentAssembly.
void	SetAsRequiredQuantity (NXOpen::Assemblies::Component *component)
	在组件上设置所需的数量.
void	SetDefault (NXOpen::Assemblies::Arrangement *arrangement)
	Set the default Arrangement for the given ComponentAssembly .
void	SetEmptyRefset (NXOpen::Assemblies::Component *component)
	设置用于表示组件为空的引用集的便利方法 .
void	SetEntirePartRefset (NXOpen::Assemblies::Component *component)
	设置用于表示组件为整个部分的引用集的便利方法.
void	SetIntegerQuantity (NXOpen::Assemblies::Component *component, int integerQuantity)
	在该组件上设置整数数量.
void	SetNonGeometricState (NXOpen::Assemblies::Component *component, bool nonGeometricState)
	将组件状态设置为几何或非几何.
void	SetRealQuantity (NXOpen::Assemblies::Component *component, double realQuantity, const NXString &quantityUnits)
	在这个组件上设置实数和对应的单位.
void	SetRealQuantity (NXOpen::Assemblies::Component *component, double realQuantity, const char *quantityUnits)
	Sets the real quantity and corresponding units on this component.
NXOpen::Assemblies::SubsetCollection *	Subsets ()
	The collection of Assemblies::Subset s defined in the ComponentAssembly Created in NX8.5.0.
NXOpen::Assemblies::Component *	SubstituteComponent (NXOpen::Assemblies::Component *component, NXOpen::BasePart *part, const NXString &newName, const NXString &referenceSet, int layer, NXOpen::Assemblies::ComponentAssembly::SubstitutionMode mode)
	用新组件替换旧组件.
NXOpen::Assemblies::Component *	SubstituteComponent (NXOpen::Assemblies::Component *component, NXOpen::BasePart *part, const char *newName, const char *referenceSet, int layer, NXOpen::Assemblies::ComponentAssembly::SubstitutionMode mode)
	Substitutes an old component with a new component.
NXOpen::ErrorList *	SuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components, const std::vector< NXOpen::Assemblies::Arrangement * > &arrangements)
	Suppresses an array of components.
NXOpen::ErrorList *	SuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components)
	Suppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.
NXOpen::ErrorList *	SuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components, const std::vector< NXOpen::Assemblies::Arrangement * > &arrangements, const NXString &expression)
	Suppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.
NXOpen::ErrorList *	SuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components, const std::vector< NXOpen::Assemblies::Arrangement * > &arrangements, const char *expression)
	Suppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.
NXOpen::ErrorList *	UnsuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components, const std::vector< NXOpen::Assemblies::Arrangement * > &arrangements)
	Unsuppresses an array of components in this ComponentAssembly.
NXOpen::ErrorList *	UnsuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components)
	Unsuppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.
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.

Detailed Description

Represents the set of Assemblies::Component s that make up an assembly.

Components are arranged in a tree structure, with a single component at the root. (See Assemblies::ComponentAssembly::RootComponent .) The components directly below the root are added to this assembly by calling Assemblies::ComponentAssembly::AddComponent . These "Top Level" components are said to be owned directly by this assembly. Top Level components may themselves have subcomponents.

Certain methods in this class will only operate on Top Level components. For example, Assemblies::ComponentAssembly::MoveComponent will throw an exception if the input component is not owned directly by this assembly.

Note, however, that input components will be mapped onto the correct component in the assembly. See Assemblies::ComponentAssembly::MapComponentFromParent .

For any methods that specify a component's position, the orientation matrix is in column order. The first column of the matrix specifies the X axis, the second the Y axis, and the third the Z axis.

To obtain an instance of this class, use BasePart::ComponentAssembly

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption

Check in and Check out options for components.

Enumerator:

CheckinCheckoutOptionDesignElement	Checks in or Checks out the design element.
CheckinCheckoutOptionSourceItem	Checks in or Checks out the source item that is referenced by a reuse design element or subordinate design element.
CheckinCheckoutOptionBoth	Checks in or Checks out the design element and its referenced source item.
CheckinCheckoutOptionDefault	Check In or Check Out option is determined by the system using whatever option is appropriate for the selected object type. For Reuse design element, the system defaults to checking out both the design element and the underlying item.

enum NXOpen::Assemblies::ComponentAssembly::CloseModified

Indicates how close component should handle component parts when they are modified.

Enumerator:

CloseModifiedFalse	Close only unmodified parts, not modified parts.
CloseModifiedTrue	Close all parts, modified and unmodified.

enum NXOpen::Assemblies::ComponentAssembly::OpenComponentStatus

Open Component Status.

Enumerator:

OpenComponentStatusSuccessfullyOpened	The component was opened as expected.
OpenComponentStatusDeletedByOpen	The component was deleted on load as a result of the open.
OpenComponentStatusCouldNotOpen	The component could not be opened.

enum NXOpen::Assemblies::ComponentAssembly::OpenOption

Open options for open_components.

Enumerator:

OpenOptionComponentOnly	Open the component but none of its children.
OpenOptionImmediateChildren	Open the immediate children of an already open component.
OpenOptionWholeAssembly	Open the component and all of its children.
OpenOptionReapplyRevRule	Reconfigure and open components based on current revision rules. If this option is used in native mode, it will behave just like Open Component.

enum NXOpen::Assemblies::ComponentAssembly::OrderTargetLocation

Option controls whether reordered Assemblies::Component s are placed before or after the target Assemblies::Component.

Enumerator:

OrderTargetLocationPlaceBefore	Move reordered Assemblies::Component s before the target Assemblies::Component.
OrderTargetLocationPlaceAfter	Move reordered Assemblies::Component s after the target Assemblies::Component.

enum NXOpen::Assemblies::ComponentAssembly::SubstitutionMode

Defines how a component substitution operation is performed.

Enumerator:

SubstitutionModeNonAssociative	The old component is deleted, and the new one is added.
SubstitutionModeSingleComponent	An associative substitution is performed. As far as possible, this will attempt to preserve assembly constraints and interpart links.
SubstitutionModeAll	An associative substitution is performed on all components that represent the same prototype part. This effectively substitutes one child part for a new one.

enum NXOpen::Assemblies::ComponentAssembly::SuppressedState

Defines the component supression states.

Enumerator:

SuppressedStateInherit	Inherit.
SuppressedStateSuppressed	Suppressed.
SuppressedStateUnsuppressed	Unsuppressed.
SuppressedStateSuppressedByExp	Suppressed by expression.
SuppressedStateUnsuppressedByExp	Unsuppressed by expression.

Member Function Documentation

NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ComponentAssembly::ActiveArrangement

(

)

Returns the currently active Assemblies::Arrangement for this ComponentAssembly.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddComponent	(	const NXString &	partToAdd,
		const NXString &	referenceSetName,
		const NXString &	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly, based on an existing part file.

@return  The new Component 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddComponent	(	const char *	partToAdd,
		const char *	referenceSetName,
		const char *	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly, based on an existing part file.

@return  The new Component 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddComponent	(	const NXString &	partToAdd,
		const NXString &	referenceSetName,
		const NXString &	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus,
		bool	uomAsNgc
	)

Creates a new Assemblies::Component in this assembly, based on an existing part file.

@return  The new Component 

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add
uomAsNgc	Whether to set to non-geometric if with unit-of-measure

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddComponent	(	const char *	partToAdd,
		const char *	referenceSetName,
		const char *	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus,
		bool	uomAsNgc
	)

Creates a new Assemblies::Component in this assembly, based on an existing part file.

@return  The new Component 

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add
uomAsNgc	Whether to set to non-geometric if with unit-of-measure

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddComponent	(	NXOpen::BasePart *	partToAdd,
		const NXString &	referenceSetName,
		const NXString &	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly, based on an existing part file.

@return  The new Component 

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddComponent	(	NXOpen::BasePart *	partToAdd,
		const char *	referenceSetName,
		const char *	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly, based on an existing part file.

@return  The new Component 

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddMasterPartComponent	(	const NXString &	partToAdd,
		const NXString &	referenceSetName,
		const NXString &	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly as master part.

@return  The new Component 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddMasterPartComponent	(	const char *	partToAdd,
		const char *	referenceSetName,
		const char *	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly as master part.

@return  The new Component 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddMasterPartComponent	(	NXOpen::Part *	partToAdd,
		const NXString &	referenceSetName,
		const NXString &	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly as master part.

@return  The new Component 

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::AddMasterPartComponent	(	NXOpen::Part *	partToAdd,
		const char *	referenceSetName,
		const char *	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		NXOpen::PartLoadStatus **	loadStatus
	)

Creates a new Assemblies::Component in this assembly as master part.

@return  The new Component 

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
loadStatus	Result of loading the part_to_add

NXOpen::PartLoadStatus* NXOpen::Assemblies::ComponentAssembly::AddPendingComponent	(	const NXString &	partToAdd,
		NXOpen::NXObject *	pendingComponent,
		const NXString &	referenceSetName,
		const NXString &	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		bool	uomAsNgc
	)

Add a pending Assemblies::Component in this assembly.

@return  Result of loading the
                                                                               part_to_add 

Created in NX8.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
pendingComponent	component to add
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
uomAsNgc	Whether to set to non-geometric if with unit-of-measure

NXOpen::PartLoadStatus* NXOpen::Assemblies::ComponentAssembly::AddPendingComponent	(	const char *	partToAdd,
		NXOpen::NXObject *	pendingComponent,
		const char *	referenceSetName,
		const char *	componentName,
		const NXOpen::Point3d &	basePoint,
		const NXOpen::Matrix3x3 &	orientation,
		int	layer,
		bool	uomAsNgc
	)

Add a pending Assemblies::Component in this assembly.

@return  Result of loading the
                                                                               part_to_add 

Created in NX8.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partToAdd	The part that defines the new component NOTE: The full Unicode character set is not supported for this parameter.
pendingComponent	component to add
referenceSetName	The name of the reference set used to represent the new component NOTE: The full Unicode character set is not supported for this parameter.
componentName	The name of the new component NOTE: The full Unicode character set is not supported for this parameter.
basePoint	Location of the new component
orientation	Orientation matrix for the new component, in column order.
layer	The layer to place the new component on -1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer.
uomAsNgc	Whether to set to non-geometric if with unit-of-measure

NXOpen::Assemblies::ArrangementCollection* NXOpen::Assemblies::ComponentAssembly::Arrangements

(

)

The collection of Assemblies::Arrangement s defined in the ComponentAssembly
Created in NX3.0.0.

void NXOpen::Assemblies::ComponentAssembly::ChangeByName	(	const NXString &	name,
		const std::vector< NXOpen::Assemblies::Component * > &	partOccs
	)

Changes the current Arrangement of the given Component s to the Arrangement with the given name.

Created in NX7.5.2.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

name	The name of arrangement to change to NOTE: The full Unicode character set is not supported for this parameter.
partOccs	The Component s to be modified

void NXOpen::Assemblies::ComponentAssembly::ChangeByName	(	const char *	name,
		const std::vector< NXOpen::Assemblies::Component * > &	partOccs
	)

Changes the current Arrangement of the given Component s to the Arrangement with the given name.

Created in NX7.5.2.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

name	The name of arrangement to change to NOTE: The full Unicode character set is not supported for this parameter.
partOccs	The Component s to be modified

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::CheckinComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	partOccs,
		NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption	checkinInputOption
	)

Checks in array of components as per the option Assemblies::ComponentAssembly::CheckinCheckoutOption .

@return  Any errors that occurred during the check in  

Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partOccs	Array of components to check in
checkinInputOption	Option that controls what to check in

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::CheckinWorkset

(

)

Checks in workset.

@return  Any errors that occurred during checking in of workset  

Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::CheckoutAllModifiedObjects

(

std::vector< NXOpen::NXObject * > &

checkedOutObjects

)

Checks out all modified objects in the current session.

checkedOutObjects collection will be type of BasePart or PDM::DesignElementRevision

Returns

Any errors that occurred during checking out of objects
Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

checkedOutObjects

Array of NXObjects checked out

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::CheckoutComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	partOccs,
		NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption	checkoutInputOption
	)

Checks out array of components as per the option Assemblies::ComponentAssembly::CheckinCheckoutOption .

@return  Any errors that occurred during the check out  

Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

partOccs	Array of components to check out
checkoutInputOption	Option that controls what to check out

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::CheckoutWorkset

(

)

Checks out workset.

@return  Any errors that occurred during checking out of workset  

Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::ClearanceSetCollection* NXOpen::Assemblies::ComponentAssembly::ClearanceSets

(

)

The collection of Assemblies::ClearanceSet s defined in the ComponentAssembly
Created in NX9.0.0.

NXOpen::PartCloseStatus* NXOpen::Assemblies::ComponentAssembly::CloseComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	componentsToClose,
		NXOpen::BasePart::CloseWholeTree	wholeTree,
		NXOpen::Assemblies::ComponentAssembly::CloseModified	closeModified
	)

Given an array of components, close the components.

   This close of the components will check for different reasons that the part cannot be closed. 
   The reasons will be returned in the PartCloseStatus object.    
@return  Close status for the parts  

Created in NX6.0.1.

License requirements : None

Parameters

componentsToClose	Array of components to close
wholeTree	If true, unloads all components of the part. If false, unloads only the top-level part
closeModified	Behavior of close if component parts are modified.

NXOpen::Assemblies::ComponentPatternCollection* NXOpen::Assemblies::ComponentAssembly::ComponentPatterns

(

)

The collection of Assemblies::ComponentPattern defined in the ComponentAssembly
Created in NX9.0.0.

void NXOpen::Assemblies::ComponentAssembly::ConvertRememberedMcs

(

)

Converts all remembered mating constraints in the part of this assembly to remembered assembly constraints.

Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

std::vector<NXOpen::Assemblies::Component *> NXOpen::Assemblies::ComponentAssembly::CopyComponents

(

const std::vector< NXOpen::Assemblies::Component * > &

components

)

Given an array of components, creates copies of the components such that each copy is created under the parent assembly of the original component.

The original components do not need to be under the same parent assembly as each other.
The number of new components may be different from the original number of components if problems occurred during the copy.

Returns

The newly created copies.
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components

Components to be copied.

NXOpen::Assemblies::ComponentPatternBuilder* NXOpen::Assemblies::ComponentAssembly::CreateComponentPatternBuilder

(

NXOpen::Assemblies::ComponentPattern *

compPattern

)

Creates a Assemblies::ComponentPatternBuilder object This can be used to create or edit a component pattern.

@return  

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

compPattern

The pattern definition object will be used in edit

NXOpen::Positioning::ComponentConstraintGroupBuilder* NXOpen::Assemblies::ComponentAssembly::CreateConstraintGroupBuilder	(	NXOpen::Positioning::ComponentConstraintGroup *	group,
		NXOpen::Assemblies::Component *	contextComponent
	)

Creates a Positioning::ComponentConstraintGroupBuilder object.

   This can be used to create a constraint group or edit an existing constraint group.
   The context component decides which displayed constraints are to be used from
   the member constraints of an existing constraint group. If the context component
   is NULL the displayed constraints used are in the same part as the member
   constraints.
@return  

Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

group	Group to be edited, if NULL then a new group is created
contextComponent	Context component, can be NULL

NXOpen::Positioning::MatingConverter* NXOpen::Assemblies::ComponentAssembly::CreateMatingConverter

(

)

Creates a Positioning::MatingConverter object for this assembly.

   This can be used to convert Mating Conditions in this part and in its child components
   to Assembly Constraints. Note that this part need not be the work part for this. 
@return  The new Mating Converter 

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::ComponentAssembly::DeleteMatingConditions

(

)

Delete all the mating conditions in this assembly.

This can be used before creating assembly constraints in the assembly, if the mating conditions are not being converted. Component-component mating conditions and inherited mating conditions are not deleted. Update should be called afterwards.

Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::ExplosionCollection* NXOpen::Assemblies::ComponentAssembly::Explosions

(

)

The collection of Assemblies::Explosion s defined in the ComponentAssembly
Created in NX3.0.0.

NXString NXOpen::Assemblies::ComponentAssembly::GetAsRequiredQuantity

(

NXOpen::Assemblies::Component *

component

)

Gets the as-required quantity on this component.

@return  As-Required string "A/R"

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component

The component to edit. Must be directly owned by this assembly.

void NXOpen::Assemblies::ComponentAssembly::GetCheckedoutStatusOfObjects	(	std::vector< NXOpen::NXObject * > &	checkedOutObjects,
		std::vector< NXOpen::NXObject * > &	uncheckedOutObjects
	)

Returns the checkedout status (checkedout/non checkedout) of all the objects open in NX.

Created in NX8.5.0.

License requirements : None

Parameters

checkedOutObjects	Array of NXObjects which are open in session and checked out
uncheckedOutObjects	Array of NXObjects which are open in session but not checkout

void NXOpen::Assemblies::ComponentAssembly::GetComponentOrders

(

std::vector< NXOpen::Assemblies::ComponentOrder * > &

orders

)

Returns all Assemblies::ComponentOrder s available in the part
Created in NX9.0.0.

License requirements : None

Parameters

orders

Returns array of Assemblies::ComponentOrder s in part

NXOpen::Assemblies::ComponentQuantity NXOpen::Assemblies::ComponentAssembly::GetComponentQuantityType

(

NXOpen::Assemblies::Component *

component

)

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

Parameters

component

The component to query. Must be directly owned by this assembly.

int NXOpen::Assemblies::ComponentAssembly::GetIntegerQuantity

(

NXOpen::Assemblies::Component *

component

)

Gets the value of the integer quantity of component.

@return  Integer quantity value 

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component

The component to query. Must be directly owned by this assembly.

bool NXOpen::Assemblies::ComponentAssembly::GetNonGeometricState

(

NXOpen::Assemblies::Component *

component

)

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

Parameters

component

The component to query. Must be directly owned by this assembly.

double NXOpen::Assemblies::ComponentAssembly::GetRealQuantity	(	NXOpen::Assemblies::Component *	component,
		NXString *	units
	)

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

component	The component to query. Must be directly owned by this assembly.
units	Units

NXOpen::Assemblies::ComponentAssembly::SuppressedState NXOpen::Assemblies::ComponentAssembly::GetSuppressedState	(	NXOpen::Assemblies::Component *	component,
		bool *	controlled
	)

Gets the suppression state of the component in its controlling arrangement.

@return  The suppressed state 

Created in NX6.0.4.

License requirements : None

Parameters

component	The component to query.
controlled	Is the suppression state controlled at the level of arrangement?

NXOpen::Assemblies::ComponentAssembly::SuppressedState NXOpen::Assemblies::ComponentAssembly::GetSuppressedState	(	NXOpen::Assemblies::Component *	component,
		NXOpen::Assemblies::Arrangement *	arrangement,
		bool *	controlled
	)

Gets the suppression state of the component in the given arrangement.

@return  The suppressed state 

Created in NX6.0.4.

License requirements : None

Parameters

component	The component to query.
arrangement	Arrangements in which components should be suppressed.
controlled	Is the suppression state controlled at the level of arrangement?

NXOpen::Expression* NXOpen::Assemblies::ComponentAssembly::GetSuppressionExpression

(

NXOpen::Assemblies::Component *

component

)

Gets the expression controlling the suppression of the component in its controlling arrangement.

@return  The suppression expression. 

Created in NX6.0.4.

License requirements : None

Parameters

component

The component to query.

NXOpen::Expression* NXOpen::Assemblies::ComponentAssembly::GetSuppressionExpression	(	NXOpen::Assemblies::Component *	component,
		NXOpen::Assemblies::Arrangement *	arrangement
	)

Gets the expression controlling the suppression of the component in the given arrangment.

@return  The suppression expression. 

Created in NX6.0.4.

License requirements : None

Parameters

component	The component to query.
arrangement	The arrangement in which to query the suppressed state

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::MapComponentFromParent

(

NXOpen::Assemblies::Component *

component

)

Maps a component in a parent assembly onto a corresponding component in this assembly.

For example, given an Axle assembly:

      Axle
    /      \          
   /        \         
Left        Right     
Wheel       Wheel     

and a Car assembly containing two Axle components:

                      Car
               _______ |_______                   
              /                \                  
             /                  \                 
        Front                     Rear            
        Axle                      Axle            
      /      \                  /      \          
     /        \                /        \         
Front Left  Front Right    Rear Left   Rear Right 
  Wheel       Wheel         Wheel       Wheel     

then calling Axle.MapComponentFromParent with the Front Left Wheel component will return the Left Wheel component. Note that calling Car.MapComponentFromParent on Left Wheel will not work. See Assemblies::ComponentAssembly::MapComponentsFromSubassembly .

Calling Axle.MapComponent with the Left Wheel component will simply return Left Wheel, i.e. it is a null operation.

Note that calling this method may load additional assembly data from the Axle part.

Returns

The mapped component. This will be defined in the component tree of this assembly parameter.

Created in NX3.0.0.

License requirements : None

Parameters

component

The component to map. This should be defined in the tree of a parent assembly which contains this assembly.

std::vector<NXOpen::Assemblies::Component *> NXOpen::Assemblies::ComponentAssembly::MapComponentsFromSubassembly

(

NXOpen::Assemblies::Component *

component

)

Maps a component in a subassembly onto the corresponding components in this parent assembly.

For example, given an Axle assembly:

      Axle
    /      \          
   /        \         
Left        Right     
Wheel       Wheel     

and a Car assembly containing two Axle components:

                      Car
               _______ |_______                   
              /                \                  
             /                  \                 
        Front                     Rear            
        Axle                      Axle            
      /      \                  /      \          
     /        \                /        \         
Front Left  Front Right    Rear Left   Rear Right 
  Wheel       Wheel         Wheel       Wheel     

then calling Car.MapComponentsFromSubassembly on Left Wheel will return Front Left Wheel and Rear Left Wheel. See also Assemblies::ComponentAssembly::MapComponentFromParent .

Returns

The mapped components.

Created in NX3.0.0.

License requirements : None

Parameters

component

The component to map. This must be defined in a subassembly of this assembly.

void NXOpen::Assemblies::ComponentAssembly::MoveComponent	(	NXOpen::Assemblies::Component *	component,
		const NXOpen::Vector3d &	translation,
		const NXOpen::Matrix3x3 &	rotation
	)

Moves a component by specifying a translation and rotation.

Note that these are specified in the coordinates of this assembly, which are not necessarily the coordinates of the displayed part. Note that the rotation matrix is expected to be stored in a column order fashion.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component	The component to edit. Must be directly owned by this assembly
translation	The translation delta
rotation	The rotation delta, in column order.

NXOpen::PartLoadStatus* NXOpen::Assemblies::ComponentAssembly::OpenComponents	(	NXOpen::Assemblies::ComponentAssembly::OpenOption	openOption,
		const std::vector< NXOpen::Assemblies::Component * > &	componentsToOpen,
		std::vector< NXOpen::Assemblies::ComponentAssembly::OpenComponentStatus > &	openStatus
	)

Given an array of components, open the components using the open_option.

Returns

If any components could not be loaded, this object contains the error information.
Created in NX6.0.1.

License requirements : None

Parameters

openOption	The option that controls the open operation
componentsToOpen	Array of components to open
openStatus	Shows the status of the objects in an indexed array according to if they could be opened

NXOpen::Assemblies::OrderCollection* NXOpen::Assemblies::ComponentAssembly::OrdersSet

(

)

The collection of Assemblies::Order s defined in the ComponentAssembly
Created in NX9.0.0.

NXOpen::Positioning::ComponentPositioner* NXOpen::Assemblies::ComponentAssembly::Positioner

(

)

Returns the component positioner for this assembly.

The positioner manages the component constraints.

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::ReleaseSuppression	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		const std::vector< NXOpen::Assemblies::Arrangement * > &	arrangements
	)

Release control of the suppression state of an array of components.

The components will no longer have their suppression state controlled by the given arrangements. (Note that it is not an error if the given arrangements do not control the components.)

Returns

list of errors encountered during the release
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	Assemblies::Component s to be released
arrangements	Arrangements in which components should be released. These arrangements must be defined in this ComponentAssembly

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::ReleaseSuppression

(

const std::vector< NXOpen::Assemblies::Component * > &

components

)

Release control of the suppression state of an array of components.

The components will no longer have their suppression state controlled by any of the arrangements in the ComponentAssembly.

Returns

list of errors encountered during the release
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components

Assemblies::Component s to be released

void NXOpen::Assemblies::ComponentAssembly::RemoveComponent

(

NXOpen::Assemblies::Component *

component

)

Removes a component from this assemebly.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component

The component to remove. Must be directly owned by this assembly.

void NXOpen::Assemblies::ComponentAssembly::ReorderChildrenOfParent	(	NXOpen::Assemblies::ComponentOrder *	order,
		NXOpen::Assemblies::Component *	parentComponent,
		const std::vector< NXOpen::Assemblies::Component * > &	componentsToReorder
	)

Assigns a new order to immediate children Assemblies::Component s of parent Assemblies::Component .

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

order	Assemblies::ComponentOrder in which children are reordered
parentComponent	Parent component whose children are reordered
componentsToReorder	Array of children components in new order

void NXOpen::Assemblies::ComponentAssembly::ReorderComponents	(	NXOpen::Assemblies::ComponentOrder *	order,
		const std::vector< NXOpen::Assemblies::Component * > &	componentsToReorder,
		NXOpen::Assemblies::Component *	targetComponent,
		NXOpen::Assemblies::ComponentAssembly::OrderTargetLocation	beforeOrAfter
	)

Reorders the array of Assemblies::Component s before or after the target Assemblies::Component .

  @link Assemblies::Component Assemblies::Component@endlink s to reorder and the target @link Assemblies::Component Assemblies::Component@endlink  should be children of 
  the same immediate parent.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

order	Assemblies::ComponentOrder in which components are reordered
componentsToReorder	Array of components to be reordered
targetComponent	Components are moved before or after this component
beforeOrAfter	Whether to move components before or after the target component

void NXOpen::Assemblies::ComponentAssembly::ReplaceReferenceSet	(	NXOpen::Assemblies::Component *	component,
		const NXString &	newReferenceSet
	)

Replaces the reference set used by a component.

Note that the names of the default reference sets Empty and Entire Part can be obtained from Assemblies::Component::EmptyPartRefsetName or Assemblies::Component::EntirePartRefsetName .
Created in NX3.0.0.

License requirements : None

Parameters

component	The component to edit. Must be directly owned by this assembly.
newReferenceSet	The name of the new reference set NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ComponentAssembly::ReplaceReferenceSet	(	NXOpen::Assemblies::Component *	component,
		const char *	newReferenceSet
	)

Replaces the reference set used by a component.

Note that the names of the default reference sets Empty and Entire Part can be obtained from Assemblies::Component::EmptyPartRefsetName or Assemblies::Component::EntirePartRefsetName .
Created in NX3.0.0.

License requirements : None

Parameters

component	The component to edit. Must be directly owned by this assembly.
newReferenceSet	The name of the new reference set NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::ReplaceReferenceSetInOwners	(	const NXString &	newReferenceSet,
		const std::vector< NXOpen::Assemblies::Component * > &	components
	)

Sets the reference set used to represent each component in an array.

This is the equivalent of calling:

Assemblies.Component.DirectOwner

Assemblies.ComponentAssembly.ReplaceReferenceSet

on each component in the array. However, this method will ensure that the reference set operations are carried out in the correct order, so that any effects caused by a parent's reference set change will be correctly reflected in the children. If changing reference set on components at various levels in the assembly, use this method.
Note that the names of the default reference sets Empty and Entire Part can be obtained from Assemblies::Component::EmptyPartRefsetName or Assemblies::Component::EntirePartRefsetName .

Returns

list of errors encountered during the edit
Created in NX3.0.0.

License requirements : None

Parameters

newReferenceSet	The name of the new reference set NOTE: The full Unicode character set is not supported for this parameter.
components	Components to be edited. Each component will have its reference set updated in its owning assembly.

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::ReplaceReferenceSetInOwners	(	const char *	newReferenceSet,
		const std::vector< NXOpen::Assemblies::Component * > &	components
	)

Sets the reference set used to represent each component in an array.

This is the equivalent of calling:

Assemblies.Component.DirectOwner

Assemblies.ComponentAssembly.ReplaceReferenceSet

on each component in the array. However, this method will ensure that the reference set operations are carried out in the correct order, so that any effects caused by a parent's reference set change will be correctly reflected in the children. If changing reference set on components at various levels in the assembly, use this method.
Note that the names of the default reference sets Empty and Entire Part can be obtained from Assemblies::Component::EmptyPartRefsetName or Assemblies::Component::EntirePartRefsetName .

Returns

list of errors encountered during the edit
Created in NX3.0.0.

License requirements : None

Parameters

newReferenceSet	The name of the new reference set NOTE: The full Unicode character set is not supported for this parameter.
components	Components to be edited. Each component will have its reference set updated in its owning assembly.

void NXOpen::Assemblies::ComponentAssembly::RestructureComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	origComponents,
		NXOpen::Assemblies::Component *	newParentComponent,
		bool	deleteFlag,
		std::vector< NXOpen::Assemblies::Component * > &	newComponents,
		NXOpen::ErrorList **	errorList
	)

Given an array of components and a specified parent this function will transfer the given components to the parent.

   The original components do not need to be under the same parent assembly as each other.
    <br> 
   The number of new components may be different from the original number of components if problems occurred during the transfer
    <br> 

Created in NX6.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

origComponents	Array of components to be restructured
newParentComponent	Destination for restructure
deleteFlag	Flag to delete original components
newComponents	Restructured components
errorList	Any errors that occurred during the restructure

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::RootComponent

(

)

Returns.

the top-level component, i.e. the component at the root of the component tree.

This component corresponds to the part that owns this Assemblies::ComponentAssembly . The components below this will correspond to parts added by calling Assemblies::ComponentAssembly::AddComponent .
Note that this will be NULL if there are no components in the tree. (I.e. if the part that owns this ComponentAssembly is a piece part.)

Created in NX3.0.0.

License requirements : None

void NXOpen::Assemblies::ComponentAssembly::SetActiveArrangement

(

NXOpen::Assemblies::Arrangement *

newArrangement

)

Sets the currently active Assemblies::Arrangement for this ComponentAssembly.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

newArrangement

The new active Assemblies::Arrangement . This Arrangement must be defined in this ComponentAssembly.

void NXOpen::Assemblies::ComponentAssembly::SetAsRequiredQuantity

(

NXOpen::Assemblies::Component *

component

)

Sets the as-required quantity on this component.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component

The component to edit. Must be directly owned by this assembly.

void NXOpen::Assemblies::ComponentAssembly::SetDefault

(

NXOpen::Assemblies::Arrangement *

arrangement

)

Set the default Arrangement for the given ComponentAssembly .

Created in NX7.5.2.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

arrangement

The new default Arrangement .

void NXOpen::Assemblies::ComponentAssembly::SetEmptyRefset

(

NXOpen::Assemblies::Component *

component

)

Convenience method for setting the reference set used to represent a component to be empty.

Created in NX3.0.0.

License requirements : None

Parameters

component

The component to edit. Must be directly owned by this assembly.

void NXOpen::Assemblies::ComponentAssembly::SetEntirePartRefset

(

NXOpen::Assemblies::Component *

component

)

Convenience method for setting the reference set used to represent a component to be the entire part.

Created in NX3.0.0.

License requirements : None

Parameters

component

The component to edit. Must be directly owned by this assembly.

void NXOpen::Assemblies::ComponentAssembly::SetIntegerQuantity	(	NXOpen::Assemblies::Component *	component,
		int	integerQuantity
	)

Sets the integer quantity on this component.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component	The component to edit. Must be directly owned by this assembly.
integerQuantity	Integer quantity value

void NXOpen::Assemblies::ComponentAssembly::SetNonGeometricState	(	NXOpen::Assemblies::Component *	component,
		bool	nonGeometricState
	)

Sets the component state to Geometric or Non-Geometric.

   Component which are made non-geometric are undrawn from graphics area.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component	The component to edit. Must be directly owned by this assembly.
nonGeometricState	True to make component non-geometric, false otherwise

void NXOpen::Assemblies::ComponentAssembly::SetRealQuantity	(	NXOpen::Assemblies::Component *	component,
		double	realQuantity,
		const NXString &	quantityUnits
	)

Sets the real quantity and corresponding units on this component.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component	The component to edit. Must be directly owned by this assembly.
realQuantity	Real quantity value
quantityUnits	Units NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ComponentAssembly::SetRealQuantity	(	NXOpen::Assemblies::Component *	component,
		double	realQuantity,
		const char *	quantityUnits
	)

Sets the real quantity and corresponding units on this component.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component	The component to edit. Must be directly owned by this assembly.
realQuantity	Real quantity value
quantityUnits	Units NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::Assemblies::SubsetCollection* NXOpen::Assemblies::ComponentAssembly::Subsets

(

)

The collection of Assemblies::Subset s defined in the ComponentAssembly
Created in NX8.5.0.

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::SubstituteComponent	(	NXOpen::Assemblies::Component *	component,
		NXOpen::BasePart *	part,
		const NXString &	newName,
		const NXString &	referenceSet,
		int	layer,
		NXOpen::Assemblies::ComponentAssembly::SubstitutionMode	mode
	)

Substitutes an old component with a new component.

The new component represents a new part, but will be placed in the same location as the original.

Returns

The new Component that replaces the old one.
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component	The old component to be substituted.
part	The new part
newName	The name for the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSet	The name of the reference set for the new component NOTE: The full Unicode character set is not supported for this parameter.
layer	The layer for the new component -1 means use the original layers defined in the component. 0 means use the work layer 1-256 means use the specified layer.
mode	Defines the substitution mode

NXOpen::Assemblies::Component* NXOpen::Assemblies::ComponentAssembly::SubstituteComponent	(	NXOpen::Assemblies::Component *	component,
		NXOpen::BasePart *	part,
		const char *	newName,
		const char *	referenceSet,
		int	layer,
		NXOpen::Assemblies::ComponentAssembly::SubstitutionMode	mode
	)

Substitutes an old component with a new component.

The new component represents a new part, but will be placed in the same location as the original.

Returns

The new Component that replaces the old one.
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

component	The old component to be substituted.
part	The new part
newName	The name for the new component NOTE: The full Unicode character set is not supported for this parameter.
referenceSet	The name of the reference set for the new component NOTE: The full Unicode character set is not supported for this parameter.
layer	The layer for the new component -1 means use the original layers defined in the component. 0 means use the work layer 1-256 means use the specified layer.
mode	Defines the substitution mode

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::SuppressComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		const std::vector< NXOpen::Assemblies::Arrangement * > &	arrangements
	)

Suppresses an array of components.

@return  list of errors encountered during the suppress 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	Assemblies::Component s to be suppressed
arrangements	Arrangements in which components should be suppressed. These arrangements must be defined in this ComponentAssembly

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::SuppressComponents

(

const std::vector< NXOpen::Assemblies::Component * > &

components

)

Suppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.

@return  list of errors encountered during the suppress 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components

Assemblies::Component s to be suppressed

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::SuppressComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		const std::vector< NXOpen::Assemblies::Arrangement * > &	arrangements,
		const NXString &	expression
	)

Suppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.

@return  list of errors encountered during the suppress 

Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	Assemblies::Component s to be suppressed
arrangements	Arrangements in which components should be unsuppressed
expression	Suppress components if expression evalutes zero else unsuppress components NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::SuppressComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		const std::vector< NXOpen::Assemblies::Arrangement * > &	arrangements,
		const char *	expression
	)

Suppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.

@return  list of errors encountered during the suppress 

Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	Assemblies::Component s to be suppressed
arrangements	Arrangements in which components should be unsuppressed
expression	Suppress components if expression evalutes zero else unsuppress components NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::UnsuppressComponents	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		const std::vector< NXOpen::Assemblies::Arrangement * > &	arrangements
	)

Unsuppresses an array of components in this ComponentAssembly.

@return  list of errors encountered during the unsuppress 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	Assemblies::Component s to be unsuppressed
arrangements	Arrangements in which components should be unsuppressed. These arrangements must be defined in this ComponentAssembly

NXOpen::ErrorList* NXOpen::Assemblies::ComponentAssembly::UnsuppressComponents

(

const std::vector< NXOpen::Assemblies::Component * > &

components

)

Unsuppresses an array of components in all Assemblies::Arrangement s in this ComponentAssembly.

@return  list of errors encountered during the unsuppress 

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components

Assemblies::Component s to be unsuppressed

---

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

• Assemblies_ComponentAssembly.hxx