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

Inheritance diagram for NXOpen::Assemblies::Component:

Public Types
enum	RepresentationMode { RepresentationModeLightweight, RepresentationModePartial, RepresentationModeExact, RepresentationModeNone }
	Representation status of a component. More...

Public Types inherited from NXOpen::DisplayableObject
enum	ObjectFont { ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline, ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed }
	specifies the object font for objects such as lines Created in NX3.0.0. More...

enum	ObjectWidth { ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5, ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive, ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine }
	specifies object width for objects such as lines and text Created in NX3.0.0. More...

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::CollaborativeContentType	CollaborativeContentType ()
	Returns the collaborative content type of this component. More...

NXOpen::PartFamily::InstanceSelectionCriteria *	CreateEmptyPartFamilyInstanceSelectionCriteria (NXOpen::PartFamily::Template *family)
	Creates an empty NXOpen::PartFamily::InstanceSelectionCriteria. More...

virtual void	DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
	Removes the input list of characteristics from this object. More...

void	DeleteInstanceUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index. More...

void	DeleteInstanceUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index. More...

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

void	DeletePartFamilyInstanceSelectionCriteria ()
	Deletes NXOpen::PartFamily::InstanceSelectionCriteria associated with this component Created in NX9.0.0. More...

NXOpen::PDM::DesignElementRevision *	DesignElementRevision ()
	Returns the NXOpen::PDM::DesignElementRevision that corresponds to this component. More...

NXOpen::PDM::DesignSubordinateRevision *	DesignSubordinateRevision ()
	Returns the NXOpen::PDM::DesignSubordinateRevision that corresponds to this component. More...

NXOpen::Assemblies::ComponentAssembly *	DirectOwner ()
	Returns the NXOpen::Assemblies::ComponentAssembly which owns this component as a "Top Level" component. More...

NXOpen::ErrorList *	DisplayComponentsExact (const std::vector< NXOpen::Assemblies::Component * > &components)
	Sets an array of components to display using the exact representation. More...

NXOpen::ErrorList *	DisplayComponentsLightweight (const std::vector< NXOpen::Assemblies::Component * > &components)
	Sets an array of components to display using the lightweight representation. More...

NXString	DisplayName ()
	Returns the displayable name of the prototype part. More...

NXString	EmptyPartRefsetName ()
	Returns the name of the reference set which represents the empty set. More...

NXString	EntirePartRefsetName ()
	Returns the name of the reference set which represents the entire part. More...

void	EstablishIsolatedPositionOverride (NXOpen::Assemblies::Component parent, NXOpen::Assemblies::Arrangement arrangement)
	Ensures there is an isolated positioning override for the NXOpen::Assemblies::Component in the given part of the given parent. More...

void	EstablishPositionOverride (NXOpen::Assemblies::Component *parent)
	Ensures there is a positioning override on component in the given part of the given parent. More...

NXOpen::NXObject *	FindOccurrence (NXOpen::NXObject *proto)
	Given a prototype object, returns the corresponding occurrence in this component. More...

NXOpen::Positioning::ComponentConstraint *	FixConstraint ()
	Returns a fix NXOpen::Positioning::ComponentConstraint of this component. More...

NXString	GetAsRequiredQuantity ()
	Gets the as-required quantity on this component. More...

virtual NXOpen::Routing::CharacteristicList *	GetCharacteristics ()
	Get all of the characteristics values on the this object. More...

std::vector < NXOpen::Assemblies::Component * >	GetChildren ()
	Returns the child components of this component However, it does not return non-geometric components (NGCs) To enable this method to also return NGCs, set the following environment variable: UGII_ALLOW_NGC_IN_UGOPEN=YES. More...

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

NXOpen::Assemblies::Component::RepresentationMode	GetComponentRepresentationMode ()
	Returns the representation mode for the component's bodies. More...

std::vector < NXOpen::Positioning::ComponentConstraint * >	GetConstraints ()
	Returns the NXOpen::Positioning::ComponentConstraint s directly connected to this component. More...

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

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

virtual NXOpen::Routing::CharacteristicList *	GetDestinationCharacteristics ()
	Returns the destination characteristics from the input object. More...

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

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

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

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

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

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

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

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

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

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

NXOpen::NXObject::AttributeInformation	GetInstanceUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

NXOpen::NXObject::AttributeInformation	GetInstanceUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

NXString	GetInstanceUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

NXString	GetInstanceUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

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

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

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

std::vector < NXOpen::NXObject::AttributeInformation >	GetInstanceUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object, as well as information from attribute templates that have not been set (if 'IncludeUnset' is 'true'). More...

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

virtual int	GetIntegerCharacteristic (const NXString &name)
	Get the value of an integer characteristic associated with the input name. More...

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

int	GetIntegerQuantity ()
	Gets the value of the integer quantity of component. More...

int	GetLayerOption ()
	Gets the layer option. More...

bool	GetNonGeometricState ()
	Gets the component state as Geometric or Non-Geometric. More...

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

void	GetPosition (NXOpen::Point3d position, NXOpen::Matrix3x3 orientation)
	Gets the position of a component. More...

NXOpen::Assemblies::Component *	GetPositionOverrideParent ()
	Find the highest level parent in which the position of component is overridden. More...

NXOpen::Assemblies::PositionOverrideType	GetPositionOverrideType ()
	Gets the type of the highest level positioning override on the component. More...

virtual double	GetRealCharacteristic (const NXString &name)
	Get the value of a real characteristic associated with the input name. More...

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

double	GetRealQuantity (NXString *quantityUnits)
	Gets the value of real quantity and corresponding units on this component. More...

virtual NXString	GetStringCharacteristic (const NXString &name)
	Get the value of a string characteristic associated with the input name. More...

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

bool	HasInstanceUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if and attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). More...

bool	HasInstanceUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if and attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). More...

bool	IsFixed ()
	Returns the fixed state of this component. More...

bool	IsPositioningIsolated (NXOpen::Assemblies::Arrangement *arrangement)
	Get whether positioning for the selected NXOpen::Assemblies::Component is isolated in the specified NXOpen::Assemblies::Arrangement . More...

bool	IsSuppressed ()
	Returns the suppressed state of the component in its controlling arrangement. More...

NXOpen::Assemblies::Component *	Parent ()
	Returns the parent of the component. More...

std::vector < NXOpen::Positioning::ComponentConstraint * >	RecallAndListConstraints ()
	Recalls the NXOpen::Positioning::ComponentConstraint s previously remembered on the part of this component, creating new constraints from them. More...

void	RecallConstraints ()
	Recalls the NXOpen::Positioning::ComponentConstraint s previously remembered on the part of this component, creating new constraints from them. More...

NXString	ReferenceSet ()
	Returns the name of the reference set used for this component. More...

void	RemovePositionOverride (NXOpen::Assemblies::Component *parent)
	Removes the highest level positioning override on component in or below the given parent. More...

void	RemoveRememberedConstraints ()
	Remove all the remembered constraints stored on the part of this component. More...

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

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

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

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

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

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

virtual void	SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
	Set all of the characteristics values on this object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	SetLayerOption (int layer)
	Sets the layer option. More...

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

void	SetPositioningIsolated (NXOpen::Assemblies::Arrangement *arrangement)
	Set positioning for the selected NXOpen::Assemblies::Component as isolated in the specified NXOpen::Assemblies::Arrangement . More...

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

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

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

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

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

NXOpen::Assemblies::Arrangement *	SuppressingArrangement ()
	Returns the NXOpen::Assemblies::Arrangement that controls this component's suppression state. More...

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

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

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

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

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

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

int	Color ()
	Returns the color of the object. More...

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

bool	IsBlanked ()
	Returns the blank status of this object. More...

int	Layer ()
	Returns the layer that the object is in. More...

NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object. More...

NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object. More...

NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name. More...

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

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

void	SetColor (int color)
	Sets the color of the object. More...

void	SetLayer (int layer)
	Sets the layer that the object is in. More...

void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object. More...

void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object. More...

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

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

void	Unhighlight ()
	Unhighlights the object. 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 a component in a NXOpen::Assemblies::ComponentAssembly .

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

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

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Assemblies::Component::RepresentationMode

Representation status of a component.

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

Member Function Documentation

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

Returns the collaborative content type of this component.

Created in NX8.5.0.

License requirements : None

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

Creates an empty NXOpen::PartFamily::InstanceSelectionCriteria.

Returns: Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

family family

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

virtual

Removes the input list of characteristics from this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Assemblies::Component::DeleteInstanceUserAttribute	(	NXOpen::NXObject::AttributeType	type,
		const NXString &	title,
		bool	deleteEntireArray,
		NXOpen::Update::Option	option
	)

Deletes the first attribute encountered with the given Type, Title and Index.

If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored, otherwise the last element of the array is deleted. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference .
Created in NX8.0.0.

License requirements : None

Parameters

type	type
title	title
deleteEntireArray	delete entire array
option	option

void NXOpen::Assemblies::Component::DeleteInstanceUserAttribute	(	NXOpen::NXObject::AttributeType	type,
		const char *	title,
		bool	deleteEntireArray,
		NXOpen::Update::Option	option
	)

Deletes the first attribute encountered with the given Type, Title and Index.

If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored, otherwise the last element of the array is deleted. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference .
Created in NX8.0.0.

License requirements : None

Parameters

type	type
title	title
deleteEntireArray	delete entire array
option	option

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

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

NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference .
Created in NX8.0.0.

License requirements : None

Parameters

type	type
option	option

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

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

License requirements : solid_modeling ("SOLIDS MODELING")

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

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

This can be NULL if the component is not a design element. This will return parent reuse design element revision if this component represent a NXOpen::PDM::DesignSubordinateRevision .

Created in NX8.5.0.

License requirements : None

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

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

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

Created in NX8.5.0.

License requirements : None

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

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

For components in a multi-level assembly, this is NOT the same the part that owns this component object. I.e. it is not the same as calling:

NXOpen.NXObject.OwningPart()

NXOpen.BasePart.ComponentAssembly()

Created in NX3.0.0.

License requirements : None

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

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

Returns: list of errors encountered during the display as exact
Created in NX7.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters

components Array of componets to be set to exact

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

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

Returns: list of errors encountered during the display as lightweight
Created in NX7.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters

components Array of components to be set to lightweight

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

Returns the displayable name of the prototype part.

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::Component::EstablishIsolatedPositionOverride	(	NXOpen::Assemblies::Component *	parent,
		NXOpen::Assemblies::Arrangement *	arrangement
	)

Ensures there is an isolated positioning override for the NXOpen::Assemblies::Component in the given part of the given parent.

This method does nothing if the NXOpen::Assemblies::Component already has an isolated positioning override in the parent, or if any necessary data is unloaded.

If parent is NULL, the isolated positioning override will be created in the same part as the NXOpen::Assemblies::Component .

Created in NX9.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

parent	The parent of the NXOpen::Assemblies::Component in which the override is to be created
arrangement	The NXOpen::Assemblies::Arrangement in which to create the isolated position override. This NXOpen::Assemblies::Arrangement must be an isolated NXOpen::Assemblies::Arrangement .

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

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

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

If parent is NULL, the positioning override will be created in the same part as the NXOpen::Assemblies::Component .

Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

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

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

License requirements : None

Parameters

proto the prototype

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

Returns a fix NXOpen::Positioning::ComponentConstraint of this component.

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

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Gets the as-required quantity on this component.

Returns: As-Required string "A/R"
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

virtual

Get all of the characteristics values on the this object.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

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

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

Returns: Created in NX3.0.0.

License requirements : None

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

Gets the quantity type of the components.

Returns NXOpen::Assemblies::ComponentQuantity .

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

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Returns the representation mode for the component's bodies.

This mode is dependent on the currently used reference set for the component.

Returns: The mode for the components display. An enumeration value.
Created in NX7.5.0.

License requirements : None

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

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

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Returns the NXOpen::Assemblies::DegreesOfFreedom for this component.

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

Returns: The degrees of freedom of this component.
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Returns the NXOpen::Assemblies::DegreesOfFreedom for this component.

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

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

Returns: The degrees of freedom of this component.
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

virtual

Returns the destination characteristics from the input object.

Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object

Ports: Reads characteristics from the port.
RCPs: Attempts to find a port at the RCP, reads characteristics from the port if it exists, otherwise reads from the stock associated with the rcp.
Segments: Reads characteristics from the stock associated with the segment.
Components: Reads characteristics directly from the component.
Stock: Reads characteristics from the stock or from the stock's data.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

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

Gets a boolean attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets a boolean attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets an integer attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets an integer attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets a real attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets a real attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets a string attribute by Title and array Index.

For reference type string attributes, the calculated StringValue is returned. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . Gets a string attribute value by title.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets a string attribute by Title and array Index.

For reference type string attributes, the calculated StringValue is returned. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . Gets a string attribute value by title.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets a time attribute by Title and array Index.

The date format set by the Customer Defaults is used. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . Gets a time attribute by title.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets a time attribute by Title and array Index.

The date format set by the Customer Defaults is used. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . Gets a time attribute by title.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

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

Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

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

Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

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

Gets the first attribute encountered on the object, if any, with a given title, type and array index.

The value of the attribute is converted to and returned as a string. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributesAsStrings . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, the calculated StringValue is returned.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

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

Gets the first attribute encountered on the object, if any, with a given title, type and array index.

The value of the attribute is converted to and returned as a string. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributesAsStrings . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, the calculated StringValue is returned.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

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

Determine the lock of the given attribute.

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

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

Determine the lock of the given attribute.

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

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

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

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

Returns: Created in NX8.0.0.

License requirements : None

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

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

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

includeUnset includeunset

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

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

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

Returns: Created in NX8.0.0.

License requirements : None

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

virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

Gets the value of the integer quantity of component.

Returns: Integer quantity value
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Gets the layer option.

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

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

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Gets the component state as Geometric or Non-Geometric.

Returns: True if the component is non-geometric, false otherwise
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Obtains theNXOpen::PartFamily::InstanceSelectionCriteria , if it exists.

Returns: Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

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

Gets the position of a component.

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

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

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

Returns: Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

Returns: Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

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

quantityUnits Units

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

virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

Determines if and attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

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

Determines if and attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

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

Returns the fixed state of this component.

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

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

bool NXOpen::Assemblies::Component::IsPositioningIsolated ( NXOpen::Assemblies::Arrangement * arrangement )

Get whether positioning for the selected NXOpen::Assemblies::Component is isolated in the specified NXOpen::Assemblies::Arrangement .

Returns: Whether positioning for the selected NXOpen::Assemblies::Component is isolated in the specified NXOpen::Assemblies::Arrangement .
Created in NX9.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

arrangement The specified NXOpen::Assemblies::Arrangement .

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

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

(See NXOpen::Assemblies::Component::SuppressingArrangement .)

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Returns the parent of the component.

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

Created in NX3.0.0.

License requirements : None

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

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

The new constraints are incomplete and refer to the component.

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

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

The new constraints are incomplete and refer to the component.

Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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

Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

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

Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

virtual

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

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

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

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

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

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

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

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

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

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

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

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

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

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

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

virtual

Set all of the characteristics values on this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

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

License requirements : None

Parameters

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

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

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

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

License requirements : None

Parameters

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

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

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

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

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

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

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

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

License requirements : None

Parameters

info	info
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
option	option

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

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

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
option	option

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

Lock or unlock the given attribute.

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

License requirements : None

Parameters

title	title
type	type
lock	lock

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

Lock or unlock the given attribute.

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

License requirements : None

Parameters

title	title
type	type
lock	lock

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

Sets the layer option.

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

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

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

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

selectionCriteria selectioncriteria

void NXOpen::Assemblies::Component::SetPositioningIsolated ( NXOpen::Assemblies::Arrangement * arrangement )

Set positioning for the selected NXOpen::Assemblies::Component as isolated in the specified NXOpen::Assemblies::Arrangement .

The arrangement must be an isolated arrangement defined in the same part as the component.

Created in NX9.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

arrangement The NXOpen::Assemblies::Arrangement in which to set positioning as isolated. This NXOpen::Assemblies::Arrangement must be an isolated NXOpen::Assemblies::Arrangement .

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

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

Changes the Arrangement used for this component.

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

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

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

This can be NULL if the component is not a subset.
Created in NX8.5.0.

License requirements : None

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

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

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

NXOpen::Assemblies::Component::SuppressingArrangement

NXOpen::Assemblies::Arrangement::Owner

NXOpen::Assemblies::ComponentAssembly::SuppressComponents

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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

NXOpen::Assemblies::Component::SuppressingArrangement

NXOpen::Assemblies::Arrangement::Owner

And then calling

NXOpen::Assemblies::ComponentAssembly::SuppressComponents

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

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

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

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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

NXOpen::Assemblies::Component::SuppressingArrangement

NXOpen::Assemblies::Arrangement::Owner
NXOpen::Assemblies::ComponentAssembly::UnsuppressComponents

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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

NXOpen::Assemblies::Component::SuppressingArrangement

NXOpen::Assemblies::Arrangement::Owner

NXOpen::Assemblies::ComponentAssembly::UnsuppressComponents

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

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

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

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

Created in NX4.0.0.

License requirements : gateway ("UG GATEWAY")

Parameters

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

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

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

Created in NX4.0.1.

License requirements : gateway ("UG GATEWAY")

Parameters

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

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

Returns the Arrangement used for this component.

See NXOpen::Assemblies::Component::SetUsedArrangement

Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

Assemblies_Component.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation