NX Open C++ Reference Guide
|
Constraint for use in positioning assembly objects in NX. More...
Public Member Functions | |
bool | ArrangementSpecific () |
Returns the arrangement specific state of this Positioning::ComponentConstraint in the Positioning::ComponentPositioner::PrimaryArrangement and Positioning::ComponentPositioner::SetPrimaryArrangement . | |
NXOpen::Positioning::ComponentConstraint::DirectionToFixed | GetDirectionToFixed (NXOpen::Assemblies::Component *component, NXOpen::Assemblies::Arrangement *arrangement) |
Get the Positioning::ComponentConstraint::DirectionToFixed value of the Positioning::ComponentConstraint given a component and an arrangement. | |
bool | GetInherited () |
Get whether this Positioning::ComponentConstraint is an inherited constraint. | |
bool | GetSpecificInArrangement (NXOpen::Assemblies::Arrangement *arrangement) |
Get the arrangement specific state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement . | |
bool | GetSuppressedInArrangement (NXOpen::Assemblies::Arrangement *arrangement) |
Get the suppression state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement . | |
void | RememberOnComponent (NXOpen::Assemblies::Component *component) |
Remembers the constraint in the prototype part of a referenced component for reuse in other occurrences of the part. | |
void | SetArrangementSpecific (bool arrangementSpecific) |
Sets the arrangement specific state of this Positioning::ComponentConstraint in the Positioning::ComponentPositioner::PrimaryArrangement and Positioning::ComponentPositioner::SetPrimaryArrangement . | |
void | SetSpecificInArrangement (NXOpen::Assemblies::Arrangement *arrangement, bool arrangementSpecific) |
Set the arrangement specific state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement . | |
void | SetSuppressedInArrangement (NXOpen::Assemblies::Arrangement *arrangement, bool suppressed) |
Set the suppression state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement . | |
![]() | |
bool | Automatic () |
Returns the flag marking the constraint as an "automatic" constraint. | |
NXOpen::Positioning::Constraint::Alignment | ConstraintAlignment () |
Returns the alignment behavior for the constraint. | |
NXOpen::Positioning::Constraint::Type | ConstraintType () |
Returns the constraint type. | |
NXOpen::Positioning::ConstraintReference * | CreateConstraintReference (NXOpen::NXObject *movableObject, NXOpen::NXObject *geometry, bool usesAxis, bool isIndirect) |
Adds geometry to a constraint and sets the movable object to be constrained. | |
NXOpen::Positioning::ConstraintReference * | CreateConstraintReference (NXOpen::NXObject *movableObject, NXOpen::NXObject *geometry, bool usesAxis, bool isIndirect, bool usePortRotate) |
Adds geometry to a constraint and sets the movable object to be constrained. | |
void | DeleteConstraintReference (NXOpen::Positioning::ConstraintReference *constraintReference) |
Removes a Positioning::ConstraintReference from the constraint. | |
void | EditConstraintReference (NXOpen::Positioning::ConstraintReference *constraintReference, NXOpen::NXObject *movableObject, NXOpen::NXObject *geometry, bool usesAxis, bool isIndirect, bool usePortRotate) |
Adds geometry to a constraint and sets the movable object to be constrained, replacing the properties of an existing reference of the constraint. | |
NXOpen::Expression * | Expression () |
Returns the expression used for constraint. | |
void | FlipAlignment () |
Reverses the constraint alignment if this is possible. | |
void | GenerateConversionReport (std::vector< NXString > &lines) |
Returns a textual conversion report this constraint from when it was converted from a Mating Constraint to an Assembly Constraint. | |
NXOpen::Positioning::Constraint::SolverStatus | GetConstraintStatus () |
Returns the solver status of a constraint. | |
NXOpen::Positioning::DisplayedConstraint * | GetDisplayedConstraint () |
Gets the Positioning::DisplayedConstraint that is in the same part as that of the constraint. | |
std::vector < NXOpen::Positioning::ConstraintReference * > | GetReferences () |
Gets all the Positioning::ConstraintReference s for the constraint. | |
bool | Persistent () |
Returns the persistent state of the constraint. | |
void | ReverseDirection () |
Reverses the constraint direction. | |
void | SetAlignmentHint (NXOpen::Positioning::Constraint::Alignment alignment) |
Set a hint as to which alignment should be used by the solver for this constraint. | |
void | SetAutomatic (bool isauto) |
Sets the flag marking the constraint as an "automatic" constraint. | |
void | SetConstraintAlignment (NXOpen::Positioning::Constraint::Alignment alignment) |
Sets the alignment behavior for the constraint. | |
void | SetConstraintType (NXOpen::Positioning::Constraint::Type constraintType) |
Sets the constraint type. | |
void | SetExpression (const NXString &expression) |
The expression used for constraint - only for distance or angle Created in NX4.0.0. | |
void | SetExpression (const char *expression) |
The expression used for constraint - only for distance or angle Created in NX4.0.0. | |
void | SetPersistent (bool persistent) |
Sets the persistent state of the constraint. | |
void | SetSplinePointsType (NXOpen::Positioning::Constraint::SplineType splineType) |
Sets the type of the spline. | |
void | SetSuppressed (bool suppressed) |
Sets the suppression state for the constraint. | |
NXOpen::Positioning::Constraint::SplineType | SplinePointsType () |
Returns the type of the spline. | |
bool | Suppressed () |
Returns the suppression state for the constraint. | |
![]() | |
void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type) |
Deletes all attributes of a specific type. | |
void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes all attributes of a specific type with the option to update or not. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title) |
Deletes an attribute by type and title. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title) |
Deletes an attribute by type and title. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option) |
Deletes an attribute by type and title with the option to update or not. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option) |
Deletes an attribute by type and title with the option to update or not. | |
void | DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option) |
Deletes the first attribute encountered with the given Type, Title and Index. | |
void | DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option) |
Deletes the first attribute encountered with the given Type, Title and Index. | |
void | DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes the attributes encountered with the given Type with option to update or not. | |
virtual NXOpen::INXObject * | FindObject (const NXString &journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type) |
Gets all the attribute titles of a specific type. | |
bool | GetBooleanUserAttribute (const NXString &title, int index) |
Gets a boolean attribute by Title and array Index. | |
bool | GetBooleanUserAttribute (const char *title, int index) |
Gets a boolean attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. | |
int | GetIntegerAttribute (const NXString &title) |
Gets an integer attribute by title. | |
int | GetIntegerAttribute (const char *title) |
Gets an integer attribute by title. | |
int | GetIntegerUserAttribute (const NXString &title, int index) |
Gets an integer attribute by Title and array Index. | |
int | GetIntegerUserAttribute (const char *title, int index) |
Gets an integer attribute by Title and array Index. | |
double | GetRealAttribute (const NXString &title) |
Gets a real attribute by title. | |
double | GetRealAttribute (const char *title) |
Gets a real attribute by title. | |
double | GetRealUserAttribute (const NXString &title, int index) |
Gets a real attribute by Title and array Index. | |
double | GetRealUserAttribute (const char *title, int index) |
Gets a real attribute by Title and array Index. | |
NXString | GetReferenceAttribute (const NXString &title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. | |
NXString | GetReferenceAttribute (const char *title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. | |
NXString | GetStringAttribute (const NXString &title) |
Gets a string attribute value by title. | |
NXString | GetStringAttribute (const char *title) |
Gets a string attribute value by title. | |
NXString | GetStringUserAttribute (const NXString &title, int index) |
Gets a string attribute by Title and array Index. | |
NXString | GetStringUserAttribute (const char *title, int index) |
Gets a string attribute by Title and array Index. | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title) |
Gets a time attribute by title. | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title) |
Gets a time attribute by title. | |
NXString | GetTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXString | GetTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. | |
NXOpen::NXObject::AttributeInformation | GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. | |
NXOpen::NXObject::AttributeInformation | GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. | |
NXString | GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given title, type and array index. | |
NXString | GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given title, type and array index. | |
bool | GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. | |
bool | GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes () |
Gets all the attributes that have been set on the given object. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset) |
Gets all the attributes that have been set on the given object. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes that have been set on the given object. | |
std::vector< NXString > | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. | |
std::vector< NXOpen::NXObject * > | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. | |
bool | HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). | |
bool | HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index) |
Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). | |
virtual bool | IsOccurrence () |
Returns whether this object is an occurrence or not. | |
virtual NXString | JournalIdentifier () |
Returns the identifier that would be recorded in a journal for this object. | |
virtual NXString | Name () |
Returns the custom name of the object. | |
virtual NXOpen::Assemblies::Component * | OwningComponent () |
Returns the owning component, if this object is an occurrence. | |
virtual NXOpen::BasePart * | OwningPart () |
Returns the owning part of this object Created in NX3.0.0. | |
virtual void | Print () |
Prints a representation of this object to the system log file. | |
virtual NXOpen::INXObject * | Prototype () |
Returns the prototype of this object if it is an occurrence. | |
void | SetAttribute (const NXString &title, int value) |
Creates or modifies an integer attribute. | |
void | SetAttribute (const char *title, int value) |
Creates or modifies an integer attribute. | |
void | SetAttribute (const NXString &title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetAttribute (const char *title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetAttribute (const NXString &title, double value) |
Creates or modifies a real attribute. | |
void | SetAttribute (const char *title, double value) |
Creates or modifies a real attribute. | |
void | SetAttribute (const NXString &title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetAttribute (const char *title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute. | |
void | SetAttribute (const char *title, const char *value) |
Creates or modifies a string attribute. | |
void | SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. | |
void | SetAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. | |
void | SetAttribute (const NXString &title) |
Creates or modifies a null attribute which is an attribute with a title and no value. | |
void | SetAttribute (const char *title) |
Creates or modifies a null attribute which is an attribute with a title and no value. | |
void | SetAttribute (const NXString &title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetAttribute (const char *title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option) |
Creates or modifies a boolean attribute with the option to update or not. | |
void | SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option) |
Creates or modifies a boolean attribute with the option to update or not. | |
virtual void | SetName (const NXString &name) |
Sets the custom name of the object. | |
void | SetName (const char *name) |
Sets the custom name of the object. | |
void | SetReferenceAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute which uses a reference string. | |
void | SetReferenceAttribute (const char *title, const char *value) |
Creates or modifies a string attribute which uses a reference string. | |
void | SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a string attribute which uses a reference string, with the option to update or not. | |
void | SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
Creates or modifies a string attribute which uses a reference string, with the option to update or not. | |
void | SetTimeAttribute (const NXString &title, const NXString &value) |
Creates or modifies a time attribute. | |
void | SetTimeAttribute (const char *title, const char *value) |
Creates or modifies a time attribute. | |
void | SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. | |
void | SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. | |
void | SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. | |
void | SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. | |
void | SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. | |
void | SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. | |
void | SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option) |
Creates or modifies an attribute with the option to update or not. | |
void | SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. | |
void | SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. | |
void | SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetUserAttribute (const char *title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. | |
void | SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
![]() | |
NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
void | SetName (const char *name) |
Sets the custom name of the object. | |
Constraint for use in positioning assembly objects in NX.
Created in NX5.0.1.
Specifies how a constraint affects the positioning of a component.
DirectionToFixedToward |
Toward fixed geometry. |
DirectionToFixedAwayFrom |
Away from fixed geometry. |
DirectionToFixedNothingFixed |
The network does not contain any fixed geometry. |
DirectionToFixedFix |
The constraint is a Positioning::Constraint::TypeFix. |
DirectionToFixedSuppressed |
The constraint is suppressed. |
DirectionToFixedIgnoredInArrangement |
The current arrangement ignores all constraints. |
bool NXOpen::Positioning::ComponentConstraint::ArrangementSpecific | ( | ) |
Returns the arrangement specific state of this Positioning::ComponentConstraint in the Positioning::ComponentPositioner::PrimaryArrangement and Positioning::ComponentPositioner::SetPrimaryArrangement .
Constraints can never be arrangement specific in piece parts.
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
NXOpen::Positioning::ComponentConstraint::DirectionToFixed NXOpen::Positioning::ComponentConstraint::GetDirectionToFixed | ( | NXOpen::Assemblies::Component * | component, |
NXOpen::Assemblies::Arrangement * | arrangement | ||
) |
Get the Positioning::ComponentConstraint::DirectionToFixed value of the Positioning::ComponentConstraint given a component and an arrangement.
This value specifies how a constraint affects the positioning of a component. If the arrangement is null, the "direction to fixed" value will be evaluated based on the default arrangement. @return The @link Positioning::ComponentConstraint::DirectionToFixed Positioning::ComponentConstraint::DirectionToFixed@endlink value.
Created in NX9.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
component | The component constrained to the specified constraint. |
arrangement | The Assemblies::Arrangement in which the constraint state is being evaluated. |
bool NXOpen::Positioning::ComponentConstraint::GetInherited | ( | ) |
Get whether this Positioning::ComponentConstraint is an inherited constraint.
An inherited constraint is created by the system to support Positioning Overrides.
bool NXOpen::Positioning::ComponentConstraint::GetSpecificInArrangement | ( | NXOpen::Assemblies::Arrangement * | arrangement | ) |
Get the arrangement specific state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement .
@return The arrangement specific state.
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
arrangement | The Assemblies::Arrangement in which the arrangement specific state is being enquired. |
bool NXOpen::Positioning::ComponentConstraint::GetSuppressedInArrangement | ( | NXOpen::Assemblies::Arrangement * | arrangement | ) |
Get the suppression state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement .
If the constraint is not arrangement specific in this arrangement then the shared suppression state, used across all arrangements where the constraint is not arrangement specific, is used.
arrangement | The Assemblies::Arrangement in which the suppression state is being enquired. |
void NXOpen::Positioning::ComponentConstraint::RememberOnComponent | ( | NXOpen::Assemblies::Component * | component | ) |
Remembers the constraint in the prototype part of a referenced component for reuse in other occurrences of the part.
Fix and Bond constraints are never remembered. If the constraint does not reference geometry in the component, it is not remembered.
Created in NX5.0.1.
License requirements : assemblies ("ASSEMBLIES MODULE")
component | The Assemblies::Component on which the constraint is remembered |
void NXOpen::Positioning::ComponentConstraint::SetArrangementSpecific | ( | bool | arrangementSpecific | ) |
Sets the arrangement specific state of this Positioning::ComponentConstraint in the Positioning::ComponentPositioner::PrimaryArrangement and Positioning::ComponentPositioner::SetPrimaryArrangement .
Constraints can never be arrangement specific in piece parts.
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
arrangementSpecific | The arrangement specific state |
void NXOpen::Positioning::ComponentConstraint::SetSpecificInArrangement | ( | NXOpen::Assemblies::Arrangement * | arrangement, |
bool | arrangementSpecific | ||
) |
Set the arrangement specific state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement .
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
arrangement | The Assemblies::Arrangement in which the arrangement specific state is being set. |
arrangementSpecific | The arrangement specific state. |
void NXOpen::Positioning::ComponentConstraint::SetSuppressedInArrangement | ( | NXOpen::Assemblies::Arrangement * | arrangement, |
bool | suppressed | ||
) |
Set the suppression state of this Positioning::ComponentConstraint in the specified Assemblies::Arrangement .
If the constraint is not arrangement specific in this arrangement then the shared suppression state, used across all arrangements where the constraint is not arrangement specific, is set.
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
arrangement | The Assemblies::Arrangement in which the suppression state is being set. |
suppressed | The suppression state. |