NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Assemblies::Component Class Reference

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

Inheritance diagram for NXOpen::Assemblies::Component:
NXOpen::DisplayableObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::IFitTo NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Types

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

Public Member Functions

virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
 Removes the input list of characteristics from this object.
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.
void DeleteInstanceUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not.
NXOpen::Assemblies::ComponentAssemblyDirectOwner ()
 Returns the Assemblies::ComponentAssembly which owns this component as a "Top Level" component.
NXOpen::ErrorListDisplayComponentsExact (const std::vector< NXOpen::Assemblies::Component * > &components)
 Sets an array of components to display using the exact representation.
NXOpen::ErrorListDisplayComponentsLightweight (const std::vector< NXOpen::Assemblies::Component * > &components)
 Sets an array of components to display using the lightweight representation.
NXString DisplayName ()
 Returns the displayable name of the prototype part.
NXString EmptyPartRefsetName ()
 Returns the name of the reference set which represents the empty set.
NXString EntirePartRefsetName ()
 Returns the name of the reference set which represents the entire part.
void EstablishPositionOverride (NXOpen::Assemblies::Component *parent)
 Ensures there is a positioning override on component in the given part of the given parent.
NXOpen::NXObjectFindOccurrence (NXOpen::NXObject *proto)
 Given a prototype object, returns the corresponding occurrence in this component.
NXOpen::Positioning::ComponentConstraintFixConstraint ()
 Returns a fix Positioning::ComponentConstraint of this component.
NXString GetAsRequiredQuantity ()
 Gets the as-required quantity on this component.
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()
 Get all of the characteristics values on the this object.
std::vector
< NXOpen::Assemblies::Component * > 
GetChildren ()
 Returns the child components of this component.
NXOpen::Assemblies::ComponentQuantity GetComponentQuantityType ()
 Gets the quantity type of the components.
NXOpen::Assemblies::Component::RepresentationMode GetComponentRepresentationMode ()
 Returns the representation mode for the component's bodies.
std::vector
< NXOpen::Positioning::ComponentConstraint * > 
GetConstraints ()
 Returns the Positioning::ComponentConstraint s directly connected to this component.
NXOpen::Assemblies::DegreesOfFreedom GetDegreesOfFreedom ()
 Returns the DegreesOfFreedom for this component.
NXOpen::Assemblies::DegreesOfFreedom GetDegreesOfFreedom (const std::vector< NXOpen::Assemblies::Component * > &components)
 Returns the DegreesOfFreedom for this component.
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()
 Returns the destination characteristics from the input object.
bool GetInstanceBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index.
int GetInstanceIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index.
double GetInstanceRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index.
NXString GetInstanceStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index.
NXString GetInstanceTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index.
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.
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.
bool GetInstanceUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute.
std::vector
< NXOpen::NXObject::AttributeInformation
GetInstanceUserAttributes ()
 Gets all the attributes that have been set on the given object.
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').
std::vector< NXStringGetInstanceUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object.
virtual int GetIntegerCharacteristic (const NXString &name)
 Get the value of an integer characteristic associated with the input name.
int GetIntegerQuantity ()
 Gets the value of the integer quantity of component.
int GetLayerOption ()
 Gets the layer option.
bool GetNonGeometricState ()
 Gets the component state as Geometric or Non-Geometric.
void GetPosition (NXOpen::Point3d *position, NXOpen::Matrix3x3 *orientation)
 Gets the position of a component.
NXOpen::Assemblies::ComponentGetPositionOverrideParent ()
 Find the highest level parent in which the position of component is overridden.
NXOpen::Assemblies::PositionOverrideType GetPositionOverrideType ()
 Gets the type of the highest level positioning override on the component.
virtual double GetRealCharacteristic (const NXString &name)
 Get the value of a real characteristic associated with the input name.
double GetRealQuantity (NXString *quantityUnits)
 Gets the value of real quantity and corresponding units on this component.
virtual NXString GetStringCharacteristic (const NXString &name)
 Get the value of a string characteristic associated with the input name.
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).
bool IsFixed ()
 Returns the fixed state of this component.
bool IsSuppressed ()
 Returns the suppressed state of the component in its controlling arrangement.
NXOpen::Assemblies::ComponentParent ()
 Returns the parent of the component.
std::vector
< NXOpen::Positioning::ComponentConstraint * > 
RecallAndListConstraints ()
 Recalls the Positioning::ComponentConstraint s previously remembered on the part of this component, creating new constraints from them.
void RecallConstraints ()
 Recalls the Positioning::ComponentConstraint s previously remembered on the part of this component, creating new constraints from them.
NXString ReferenceSet ()
 Returns the name of the reference set used for this component.
void RemovePositionOverride (NXOpen::Assemblies::Component *parent)
 Removes the highest level positioning override on component in or below the given parent.
void RemoveRememberedConstraints ()
 Remove all the remembered constraints stored on the part of this component.
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.
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.
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.
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
 Set all of the characteristics values on this object.
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.
void SetInstanceTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not.
void SetInstanceUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not.
void SetInstanceUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not.
void SetInstanceUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not.
void SetInstanceUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not.
void SetInstanceUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not.
void SetInstanceUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute.
void SetLayerOption (int layer)
 Sets the layer option.
void SetPositioningVaried (const std::vector< NXOpen::Assemblies::Component * > &components, bool setAsVaried)
 Set positioning for the selected Assemblies::Component s across all possible Assemblies::Arrangement s.
void SetUsedArrangement (NXOpen::Assemblies::Arrangement *newArrangement)
 Changes the Arrangement used for this component.
void Suppress ()
 Suppresses the component in the ComponentAssembly that contains its controlling Arrangement.
NXOpen::ErrorListSuppress (const std::vector< NXOpen::Assemblies::Component * > &components)
 Suppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.
NXOpen::Assemblies::ArrangementSuppressingArrangement ()
 Returns the Assemblies::Arrangement that controls this component's suppression state.
void Unsuppress ()
 Unsuppresses the component in the ComponentAssembly that contains its controlling Arrangement.
NXOpen::ErrorListUnsuppress (const std::vector< NXOpen::Assemblies::Component * > &components)
 Unsuppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.
void UpdateStructure (const std::vector< NXOpen::Assemblies::Component * > &components, int nLevels)
 Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels, ignoring components already processed by previous calls.
void UpdateStructure (const std::vector< NXOpen::Assemblies::Component * > &components, int nLevels, bool checkComponentsVisited)
 Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels.
NXOpen::Assemblies::ArrangementUsedArrangement ()
 Returns the Arrangement used for this component.

Detailed Description

Represents a component in a Assemblies::ComponentAssembly .

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


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



Created in NX3.0.0.


Member Enumeration Documentation

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

Removes the input list of characteristics from this object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
valuesvalues

Implements NXOpen::Routing::ICharacteristic.

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 NXObject::AttributeTypeReference .
Created in NX8.0.0.

License requirements : None

Parameters:
typetype
titletitle
deleteEntireArraydelete entire array
optionoption

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

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

License requirements : None

Parameters:
typetype
optionoption

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

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

                     NXObject.OwningPart()
                    BasePart.ComponentAssembly()


Created in NX3.0.0.

License requirements : None

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:
componentsArray of componets to be set to exact

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:
componentsArray of components to be set to lightweight

Returns the displayable name of the prototype part.


Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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


Created in NX7.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
parentThe parent of the component in which the override is to be created

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:
protothe prototype

Returns a fix Positioning::ComponentConstraint of this component.

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


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Gets the as-required quantity on this component.

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Get all of the characteristics values on the this object.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ICharacteristic.

Returns the child components of this component.

Returns:

Created in NX3.0.0.

License requirements : None

Gets the quantity type of the components.

Returns Assemblies::ComponentQuantity .

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

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the DegreesOfFreedom for this component.

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the DegreesOfFreedom for this component.

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

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters:
componentsComponents relative to which the degrees of freedom will be found.

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ICharacteristic.

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 NXObject::GetUserAttributes .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

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 NXObject::GetUserAttributes .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex
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 NXObject::GetUserAttributes .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

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 NXObject::GetUserAttributes . Gets a string attribute value by title.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

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 NXObject::GetUserAttributes . Gets a time attribute by title.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

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 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 NXObject::AttributeTypeReference . Instead, use 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:
titletitle
typetype
indexindex

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 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 NXObject::AttributeTypeReference . Instead, use NXObject::AttributeTypeString . For reference type string attributes, the calculated StringValue is returned.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
typetype
indexindex

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:
titletitle
typetype

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 NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.

Returns:

Created in NX8.0.0.

License requirements : None

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 NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
includeUnsetincludeunset

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 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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Gets the value of the integer quantity of component.

Returns:
Integer quantity value
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

Gets the position of a component.


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
positionThe origin of this component
orientationThe orientation of this component

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

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

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:
quantityUnitsUnits

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

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 NXObject::AttributeTypeReference . Instead, use NXObject::AttributeTypeString .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
typetype
indexindex

Returns the fixed state of this component.

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


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

(See Assemblies::Component::SuppressingArrangement .)


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the parent of the component.

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


Created in NX3.0.0.

License requirements : None

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

The new constraints are incomplete and refer to the component.

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

License requirements : assemblies ("ASSEMBLIES MODULE")

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

The new constraints are incomplete and refer to the component.


Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

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


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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:
parentThe parent of the component in or below which the override is to be removed

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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.

Set all of the characteristics values on this object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
valuesvalues

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:
titletitle
indexindex
valuevalue
optionoption
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:
titletitle
indexindex
valueThe current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats.
NOTE: The full Unicode character set is not supported for this parameter.
optionoption

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

NOTE: This method does not support the use of NXObject::AttributeTypeReference . Instead, set the type to 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:
infoinfo
optionoption
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:
titletitle
indexindex
valuevalue
optionoption
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:
titletitle
indexindex
valuevalue
optionoption
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:
titletitle
indexindex
valuevalue
optionoption

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


Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
indexindex
optionoption

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:
titletitle
typetype
locklock

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:
layerThe 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::SetPositioningVaried ( const std::vector< NXOpen::Assemblies::Component * > &  components,
bool  setAsVaried 
)

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
componentsThe components whose positioning will be altered.
setAsVariedIf FALSE components will have same position in all Assemblies::Arrangement s, TRUE allows the position to be varied.

Changes the Arrangement used for this component.

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


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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:


Assemblies::Component::SuppressingArrangement

Assemblies::Arrangement::Owner

Assemblies::ComponentAssembly::SuppressComponents


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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


Assemblies::Component::SuppressingArrangement

Assemblies::Arrangement::Owner


And then calling


Assemblies::ComponentAssembly::SuppressComponents

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters:
componentsComponents to be suppressed. Each component will be suppressed in its controlling arrangement. Note that the components must all be underneath the same assembly

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

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


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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:


Assemblies::Component::SuppressingArrangement

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


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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


Assemblies::Component::SuppressingArrangement

Assemblies::Arrangement::Owner


Assemblies::ComponentAssembly::UnsuppressComponents

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

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

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters:
componentsComponents 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:
componentsComponent tags to start update structure from
nLevelsThe 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:
componentsComponent tags to start update structure from
nLevelsThe number of levels to update. If -1 then all levels are updated.
checkComponentsVisitedIf true, only perform update structure on each component once this session.

Returns the Arrangement used for this component.

See Assemblies::Component::SetUsedArrangement


Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.