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

Inheritance diagram for NXOpen::Assemblies::ComponentAssembly:

Public Types
enum	CheckinCheckoutOption { CheckinCheckoutOptionDesignElement, CheckinCheckoutOptionSourceItem, CheckinCheckoutOptionBoth, CheckinCheckoutOptionDefault }
	Check in and Check out options for components. More...

enum	CloseModified { CloseModifiedFalse, CloseModifiedTrue }
	Indicates how close component should handle component parts when they are modified. More...

enum	OpenComponentStatus { OpenComponentStatusSuccessfullyOpened, OpenComponentStatusDeletedByOpen, OpenComponentStatusCouldNotOpen }
	Open Component Status. More...

enum	OpenOption { OpenOptionComponentOnly, OpenOptionImmediateChildren, OpenOptionWholeAssembly, OpenOptionReapplyRevRule }
	Open options for open_components. More...

enum	OrderTargetLocation { OrderTargetLocationPlaceBefore, OrderTargetLocationPlaceAfter }
	Option controls whether reordered NXOpen::Assemblies::Component s are placed before or after the target NXOpen::Assemblies::Component. More...

enum	SubstitutionMode { SubstitutionModeNonAssociative, SubstitutionModeSingleComponent, SubstitutionModeAll }
	Defines how a component substitution operation is performed. More...

enum	SuppressedState { SuppressedStateInherit, SuppressedStateSuppressed, SuppressedStateUnsuppressed, SuppressedStateSuppressedByExp, SuppressedStateUnsuppressedByExp }
	Defines the component supression states. 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 ()
	Returns the currently active NXOpen::Assemblies::Arrangement for this ComponentAssembly. More...

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)
	Creates a new NXOpen::Assemblies::Component in this assembly, based on an existing part file. More...

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 NXOpen::Assemblies::Component in this assembly, based on an existing part file. More...

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 NXOpen::Assemblies::Component in this assembly, based on an existing part file. More...

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 NXOpen::Assemblies::Component in this assembly, based on an existing part file. More...

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 NXOpen::Assemblies::Component in this assembly, based on an existing part file. More...

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 NXOpen::Assemblies::Component in this assembly, based on an existing part file. More...

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)
	Creates a new NXOpen::Assemblies::Component in this assembly as master part. More...

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 NXOpen::Assemblies::Component in this assembly as master part. More...

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 NXOpen::Assemblies::Component in this assembly as master part. More...

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 NXOpen::Assemblies::Component in this assembly as master part. More...

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 NXOpen::Assemblies::Component in this assembly. More...

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 NXOpen::Assemblies::Component in this assembly. More...

NXOpen::Assemblies::ArrangementCollection *	Arrangements ()
	The collection of NXOpen::Assemblies::Arrangement s defined in the ComponentAssembly Created in NX3.0.0. More...

void	ChangeByName (const NXString &name, const std::vector< NXOpen::Assemblies::Component * > &partOccs)
	Changes the current NXOpen::Assemblies::Arrangement of the given NXOpen::Assemblies::Component s to the NXOpen::Assemblies::Arrangement with the given name. More...

void	ChangeByName (const char name, const std::vector< NXOpen::Assemblies::Component > &partOccs)
	Changes the current NXOpen::Assemblies::Arrangement of the given NXOpen::Assemblies::Component s to the NXOpen::Assemblies::Arrangement with the given name. More...

NXOpen::ErrorList *	CheckinComponents (const std::vector< NXOpen::Assemblies::Component * > &partOccs, NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkinInputOption)
	Checks in array of components as per the option NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption . More...

NXOpen::ErrorList *	CheckinWorkset ()
	Checks in workset. More...

NXOpen::ErrorList *	CheckoutAllModifiedObjects (std::vector< NXOpen::NXObject * > &checkedOutObjects)
	Checks out all modified objects in the current session. More...

NXOpen::ErrorList *	CheckoutComponents (const std::vector< NXOpen::Assemblies::Component * > &partOccs, NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkoutInputOption)
	Checks out array of components as per the option NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption . More...

NXOpen::ErrorList *	CheckoutWorkset ()
	Checks out workset. More...

NXOpen::Assemblies::ClearanceSetCollection *	ClearanceSets ()
	The collection of NXOpen::Assemblies::ClearanceSet s defined in the ComponentAssembly Created in NX9.0.0. More...

NXOpen::PartCloseStatus *	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. More...

NXOpen::Assemblies::ComponentPatternCollection *	ComponentPatterns ()
	The collection of NXOpen::Assemblies::ComponentPattern defined in the ComponentAssembly Created in NX9.0.0. More...

void	ConvertRememberedMcs ()
	Converts all remembered mating constraints in the part of this assembly to remembered assembly constraints. More...

std::vector < NXOpen::Assemblies::Component * >	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. More...

NXOpen::Assemblies::ComponentPatternBuilder *	CreateComponentPatternBuilder (NXOpen::Assemblies::ComponentPattern *compPattern)
	Creates a NXOpen::Assemblies::ComponentPatternBuilder object This can be used to create or edit a component pattern. More...

NXOpen::Positioning::ComponentConstraintGroupBuilder *	CreateConstraintGroupBuilder (NXOpen::Positioning::ComponentConstraintGroup group, NXOpen::Assemblies::Component contextComponent)
	Creates a NXOpen::Positioning::ComponentConstraintGroupBuilder object. More...

NXOpen::Positioning::MatingConverter *	CreateMatingConverter ()
	Creates a NXOpen::Positioning::MatingConverter object for this assembly. More...

void	DeleteMatingConditions ()
	Delete all the mating conditions in this assembly. More...

NXOpen::Assemblies::ExplosionCollection *	Explosions ()
	The collection of NXOpen::Assemblies::Explosion s defined in the ComponentAssembly Created in NX3.0.0. More...

NXString	GetAsRequiredQuantity (NXOpen::Assemblies::Component *component)
	Gets the as-required quantity on this component. More...

void	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. More...

void	GetComponentOrders (std::vector< NXOpen::Assemblies::ComponentOrder * > &orders)
	Returns all NXOpen::Assemblies::ComponentOrder s available in the part Created in NX9.0.0. More...

NXOpen::Assemblies::ComponentQuantity	GetComponentQuantityType (NXOpen::Assemblies::Component *component)
	Gets the quantity type of the components. More...

int	GetIntegerQuantity (NXOpen::Assemblies::Component *component)
	Gets the value of the integer quantity of component. More...

bool	GetNonGeometricState (NXOpen::Assemblies::Component *component)
	Gets the component state as Geometric or Non-Geometric. More...

double	GetRealQuantity (NXOpen::Assemblies::Component component, NXString units)
	Gets the value of real quantity and corresponding units on this component. More...

NXOpen::Assemblies::ComponentAssembly::SuppressedState	GetSuppressedState (NXOpen::Assemblies::Component component, bool controlled)
	Gets the suppression state of the component in its controlling arrangement. More...

NXOpen::Assemblies::ComponentAssembly::SuppressedState	GetSuppressedState (NXOpen::Assemblies::Component component, NXOpen::Assemblies::Arrangement arrangement, bool *controlled)
	Gets the suppression state of the component in the given arrangement. More...

NXOpen::Expression *	GetSuppressionExpression (NXOpen::Assemblies::Component *component)
	Gets the expression controlling the suppression of the component in its controlling arrangement. More...

NXOpen::Expression *	GetSuppressionExpression (NXOpen::Assemblies::Component component, NXOpen::Assemblies::Arrangement arrangement)
	Gets the expression controlling the suppression of the component in the given arrangment. More...

NXOpen::Assemblies::Component *	MapComponentFromParent (NXOpen::Assemblies::Component *component)
	Maps a component in a parent assembly onto a corresponding component in this assembly. More...

std::vector < NXOpen::Assemblies::Component * >	MapComponentsFromSubassembly (NXOpen::Assemblies::Component *component)
	Maps a component in a subassembly onto the corresponding components in this parent assembly. More...

void	MoveComponent (NXOpen::Assemblies::Component *component, const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation)
	Moves a component by specifying a translation and rotation. More...

NXOpen::PartLoadStatus *	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. More...

NXOpen::Assemblies::OrderCollection *	OrdersSet ()
	The collection of NXOpen::Assemblies::Order s defined in the ComponentAssembly Created in NX9.0.0. More...

NXOpen::Positioning::ComponentPositioner *	Positioner ()
	Returns the component positioner for this assembly. More...

NXOpen::ErrorList *	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. More...

NXOpen::ErrorList *	ReleaseSuppression (const std::vector< NXOpen::Assemblies::Component * > &components)
	Release control of the suppression state of an array of components. More...

void	RemoveComponent (NXOpen::Assemblies::Component *component)
	Removes a component from this assemebly. More...

void	ReorderChildrenOfParent (NXOpen::Assemblies::ComponentOrder order, NXOpen::Assemblies::Component parentComponent, const std::vector< NXOpen::Assemblies::Component * > &componentsToReorder)
	Assigns a new order to immediate children NXOpen::Assemblies::Component s of parent NXOpen::Assemblies::Component . More...

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 NXOpen::Assemblies::Component s before or after the target NXOpen::Assemblies::Component . More...

void	ReplaceReferenceSet (NXOpen::Assemblies::Component *component, const NXString &newReferenceSet)
	Replaces the reference set used by a component. More...

void	ReplaceReferenceSet (NXOpen::Assemblies::Component component, const char newReferenceSet)
	Replaces the reference set used by a component. More...

NXOpen::ErrorList *	ReplaceReferenceSetInOwners (const NXString &newReferenceSet, const std::vector< NXOpen::Assemblies::Component * > &components)
	Sets the reference set used to represent each component in an array. More...

NXOpen::ErrorList *	ReplaceReferenceSetInOwners (const char newReferenceSet, const std::vector< NXOpen::Assemblies::Component > &components)
	Sets the reference set used to represent each component in an array. More...

void	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. More...

NXOpen::Assemblies::Component *	RootComponent ()
	Returns. More...

void	SetActiveArrangement (NXOpen::Assemblies::Arrangement *newArrangement)
	Sets the currently active NXOpen::Assemblies::Arrangement for this ComponentAssembly. More...

void	SetAsRequiredQuantity (NXOpen::Assemblies::Component *component)
	Sets the as-required quantity on this component. More...

void	SetDefault (NXOpen::Assemblies::Arrangement *arrangement)
	Set the default NXOpen::Assemblies::Arrangement for the given NXOpen::Assemblies::ComponentAssembly . More...

void	SetEmptyRefset (NXOpen::Assemblies::Component *component)
	Convenience method for setting the reference set used to represent a component to be empty. More...

void	SetEntirePartRefset (NXOpen::Assemblies::Component *component)
	Convenience method for setting the reference set used to represent a component to be the entire part. More...

void	SetIntegerQuantity (NXOpen::Assemblies::Component *component, int integerQuantity)
	Sets the integer quantity on this component. More...

void	SetNonGeometricState (NXOpen::Assemblies::Component *component, bool nonGeometricState)
	Sets the component state to Geometric or Non-Geometric. More...

void	SetRealQuantity (NXOpen::Assemblies::Component *component, double realQuantity, const NXString &quantityUnits)
	Sets the real quantity and corresponding units on this component. More...

void	SetRealQuantity (NXOpen::Assemblies::Component component, double realQuantity, const char quantityUnits)
	Sets the real quantity and corresponding units on this component. More...

NXOpen::Assemblies::SubsetCollection *	Subsets ()
	The collection of NXOpen::Assemblies::Subset s defined in the ComponentAssembly Created in NX8.5.0. More...

NXOpen::Assemblies::Component *	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. More...

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

NXOpen::ErrorList *	SuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components, const std::vector< NXOpen::Assemblies::Arrangement * > &arrangements)
	Suppresses an array of components. More...

NXOpen::ErrorList *	SuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components)
	Suppresses an array of components in all NXOpen::Assemblies::Arrangement s in this ComponentAssembly. More...

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 NXOpen::Assemblies::Arrangement s in this ComponentAssembly. More...

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 NXOpen::Assemblies::Arrangement s in this ComponentAssembly. More...

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

NXOpen::ErrorList *	UnsuppressComponents (const std::vector< NXOpen::Assemblies::Component * > &components)
	Unsuppresses an array of components in all NXOpen::Assemblies::Arrangement s in this ComponentAssembly. More...

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title. More...

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

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

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

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

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type. More...

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index. More...

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title. More...

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title. More...

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index. More...

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

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title. More...

double	GetRealAttribute (const char *title)
	Gets a real attribute by title. More...

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index. More...

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

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

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title. More...

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title. More...

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

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

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title. More...

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title. More...

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

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

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

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

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

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

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

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...

virtual NXString	Name ()
	Returns the custom name of the object. More...

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...

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

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute. More...

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute. More...

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

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

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute. More...

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute. More...

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

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

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute. More...

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

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

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

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

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

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

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

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

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

virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...

virtual void	SetName (const char *name)
	Sets the custom name of the object. More...

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

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

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

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

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute. More...

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

Components are arranged in a tree structure, with a single component at the root. (See NXOpen::Assemblies::ComponentAssembly::RootComponent .) The components directly below the root are added to this assembly by calling NXOpen::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, NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::Assemblies::Component s are placed before or after the target NXOpen::Assemblies::Component.

Enumerator
OrderTargetLocationPlaceBefore	Move reordered NXOpen::Assemblies::Component s before the target NXOpen::Assemblies::Component.
OrderTargetLocationPlaceAfter	Move reordered NXOpen::Assemblies::Component s after the target NXOpen::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 NXOpen::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 NXOpen::Assemblies::Component in this assembly, based on an existing part file.

Returns: 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 NXOpen::Assemblies::Component in this assembly, based on an existing part file.

Returns: 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 NXOpen::Assemblies::Component in this assembly, based on an existing part file.

Returns: 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 NXOpen::Assemblies::Component in this assembly, based on an existing part file.

Returns: 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 NXOpen::Assemblies::Component in this assembly, based on an existing part file.

Returns: 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 NXOpen::Assemblies::Component in this assembly, based on an existing part file.

Returns: 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 NXOpen::Assemblies::Component in this assembly as master part.

Returns: 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 NXOpen::Assemblies::Component in this assembly as master part.

Returns: 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 NXOpen::Assemblies::Component in this assembly as master part.

Returns: 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 NXOpen::Assemblies::Component in this assembly as master part.

Returns: 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 NXOpen::Assemblies::Component in this assembly.

Returns: 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 NXOpen::Assemblies::Component in this assembly.

Returns: 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 NXOpen::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 NXOpen::Assemblies::Arrangement of the given NXOpen::Assemblies::Component s to the NXOpen::Assemblies::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 NXOpen::Assemblies::Component s to be modified

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

Changes the current NXOpen::Assemblies::Arrangement of the given NXOpen::Assemblies::Component s to the NXOpen::Assemblies::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 NXOpen::Assemblies::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 NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption .

Returns: 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.

Returns: 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 NXOpen::BasePart or NXOpen::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 NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption .

Returns: 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.

Returns: 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 NXOpen::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.

Returns: 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 NXOpen::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 NXOpen::Assemblies::ComponentPatternBuilder object This can be used to create or edit a component pattern.

Returns: 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 NXOpen::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.

Returns: 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 NXOpen::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.

Returns: 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 NXOpen::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.

Returns: 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 NXOpen::Assemblies::ComponentOrder s available in the part
Created in NX9.0.0.

License requirements : None

Parameters

orders Returns array of NXOpen::Assemblies::ComponentOrder s in part

NXOpen::Assemblies::ComponentQuantity NXOpen::Assemblies::ComponentAssembly::GetComponentQuantityType ( NXOpen::Assemblies::Component * component )

Gets the quantity type of the components.

Returns NXOpen::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.

Returns: 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.

Returns: 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.

Returns: 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.

Returns: 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.

Returns: 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.

Returns: 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.

Returns: 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 NXOpen::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 NXOpen::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 NXOpen::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	NXOpen::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 NXOpen::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 NXOpen::Assemblies::Component s of parent NXOpen::Assemblies::Component .

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

order	NXOpen::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 NXOpen::Assemblies::Component s before or after the target NXOpen::Assemblies::Component .

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

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

order	NXOpen::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 NXOpen::Assemblies::Component::EmptyPartRefsetName or NXOpen::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 NXOpen::Assemblies::Component::EmptyPartRefsetName or NXOpen::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:

NXOpen.Assemblies.Component.DirectOwner

NXOpen.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 NXOpen::Assemblies::Component::EmptyPartRefsetName or NXOpen::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:

NXOpen.Assemblies.Component.DirectOwner

NXOpen.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 NXOpen::Assemblies::Component::EmptyPartRefsetName or NXOpen::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.
The number of new components may be different from the original number of components if problems occurred during the transfer

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 NXOpen::Assemblies::ComponentAssembly . The components below this will correspond to parts added by calling NXOpen::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 NXOpen::Assemblies::Arrangement for this ComponentAssembly.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

newArrangement The new active NXOpen::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 NXOpen::Assemblies::Arrangement for the given NXOpen::Assemblies::ComponentAssembly .

Created in NX7.5.2.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

arrangement The new default NXOpen::Assemblies::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 NXOpen::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.

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	NXOpen::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 NXOpen::Assemblies::Arrangement s in this ComponentAssembly.

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components NXOpen::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 NXOpen::Assemblies::Arrangement s in this ComponentAssembly.

Returns: list of errors encountered during the suppress
Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	NXOpen::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 NXOpen::Assemblies::Arrangement s in this ComponentAssembly.

Returns: list of errors encountered during the suppress
Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	NXOpen::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.

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components	NXOpen::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 NXOpen::Assemblies::Arrangement s in this ComponentAssembly.

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

components NXOpen::Assemblies::Component s to be unsuppressed

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

Assemblies_ComponentAssembly.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation