NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Positioning::ComponentConstraint Class Reference

Constraint for use in positioning assembly objects in NX. More...

Inheritance diagram for NXOpen::Positioning::ComponentConstraint:
NXOpen::Positioning::Constraint NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

Public Types

enum  DirectionToFixed {
  DirectionToFixedUnknown = -1, DirectionToFixedToward, DirectionToFixedAwayFrom, DirectionToFixedNothingFixed,
  DirectionToFixedFix, DirectionToFixedSuppressed, DirectionToFixedIgnoredInArrangement
}
 Specifies how a constraint affects the positioning of a component. More...
 
- Public Types inherited from NXOpen::Positioning::Constraint
enum  Alignment { AlignmentInferAlign, AlignmentCoAlign, AlignmentContraAlign }
 Specifies alignment of directed geometries used in a constraint. More...
 
enum  SolverStatus {
  SolverStatusNewlyCreated, SolverStatusSuppressed, SolverStatusOutOfDate, SolverStatusOverConstrained,
  SolverStatusNotConsistentDims, SolverStatusNotConsistentOther, SolverStatusNotConsistentUnknown, SolverStatusBetweenFixed,
  SolverStatusNotSolved, SolverStatusSolved, SolverStatusCannotSolve, SolverStatusDelayed,
  SolverStatusIgnoredInArrangement, SolverStatusInternallyInconsistent, SolverStatusUnloadedGeometry, SolverStatusPendingConvertedMc,
  SolverStatusConflictingWithWave
}
 Specifies the status of a constraint. More...
 
enum  SplineType { SplineTypeByPoles, SplineTypeByPoints, SplineTypeInvalid }
 Specifies how the spline points define the shape of the spline. More...
 
enum  Type {
  TypeUndefined, TypeTouch, TypeConcentric, TypeFix,
  TypeDistance, TypeParallel, TypePerpendicular, TypeCenter12,
  TypeCenter22, TypeAngle, TypeFit, TypeBond,
  TypeOrientAngle, TypeSplineData, TypeSplineLength, TypeLinearPattern,
  TypeCircularPattern, TypeLinear2dPattern, TypeRadiantPattern, TypeAlignLock
}
 Specifies the type of a constraint. 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

bool ArrangementSpecific ()
 Returns the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the NXOpen::Positioning::ComponentPositioner::PrimaryArrangement and NXOpen::Positioning::ComponentPositioner::SetPrimaryArrangement . More...
 
NXOpen::Positioning::ComponentConstraint::DirectionToFixed GetDirectionToFixed (NXOpen::Assemblies::Component *component, NXOpen::Assemblies::Arrangement *arrangement)
 Get the NXOpen::Positioning::ComponentConstraint::DirectionToFixed value of the NXOpen::Positioning::ComponentConstraint given a component and an arrangement. More...
 
bool GetInherited ()
 Get whether this NXOpen::Positioning::ComponentConstraint is an inherited constraint. More...
 
bool GetSharedSuppressed ()
 Get the shared suppression state of this NXOpen::Positioning::ComponentConstraint used across all arrangements where the constraint is not arrangement specific. More...
 
bool GetSpecificInArrangement (NXOpen::Assemblies::Arrangement *arrangement)
 Get the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the specified NXOpen::Assemblies::Arrangement . More...
 
bool GetSuppressedInArrangement (NXOpen::Assemblies::Arrangement *arrangement)
 Get the suppression state of this NXOpen::Positioning::ComponentConstraint in the specified NXOpen::Assemblies::Arrangement . More...
 
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. More...
 
void SetArrangementSpecific (bool arrangementSpecific)
 Sets the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the NXOpen::Positioning::ComponentPositioner::PrimaryArrangement and NXOpen::Positioning::ComponentPositioner::SetPrimaryArrangement . More...
 
void SetSharedSuppressed (bool suppressed)
 Set the shared suppression state of this NXOpen::Positioning::ComponentConstraint used across all arrangements where the constraint is not arrangement specific. More...
 
void SetSpecificInArrangement (NXOpen::Assemblies::Arrangement *arrangement, bool arrangementSpecific)
 Set the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the specified NXOpen::Assemblies::Arrangement . More...
 
void SetSuppressedInArrangement (NXOpen::Assemblies::Arrangement *arrangement, bool suppressed)
 Set the suppression state of this NXOpen::Positioning::ComponentConstraint in the specified NXOpen::Assemblies::Arrangement . More...
 
- Public Member Functions inherited from NXOpen::Positioning::Constraint
bool Automatic ()
 Returns the flag marking the constraint as an "automatic" constraint. More...
 
NXOpen::Positioning::Constraint::Alignment ConstraintAlignment ()
 Returns the alignment behavior for the constraint. More...
 
NXOpen::Positioning::Constraint::Type ConstraintType ()
 Returns the constraint type. More...
 
NXOpen::Positioning::ConstraintReferenceCreateConstraintReference (NXOpen::NXObject *movableObject, NXOpen::NXObject *geometry, bool usesAxis, bool isIndirect)
 Adds geometry to a constraint and sets the movable object to be constrained. More...
 
NXOpen::Positioning::ConstraintReferenceCreateConstraintReference (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. More...
 
void DeleteConstraintReference (NXOpen::Positioning::ConstraintReference *constraintReference)
 Removes a NXOpen::Positioning::ConstraintReference from the constraint. More...
 
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. More...
 
NXOpen::ExpressionExpression ()
 Returns the expression used for constraint. More...
 
void FlipAlignment ()
 Reverses the constraint alignment if this is possible. More...
 
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. More...
 
NXOpen::Positioning::Constraint::SolverStatus GetConstraintStatus ()
 Returns the solver status of a constraint. More...
 
NXOpen::Positioning::DisplayedConstraintGetDisplayedConstraint ()
 Gets the NXOpen::Positioning::DisplayedConstraint that is in the same part as that of the constraint. More...
 
std::vector
< NXOpen::Positioning::ConstraintReference * > 
GetReferences ()
 Gets all the NXOpen::Positioning::ConstraintReference s for the constraint. More...
 
bool Persistent ()
 Returns the persistent state of the constraint. More...
 
void ReverseDirection ()
 Reverses the constraint direction. More...
 
void SetAlignmentHint (NXOpen::Positioning::Constraint::Alignment alignment)
 Set a hint as to which alignment should be used by the solver for this constraint. More...
 
void SetAutomatic (bool isauto)
 Sets the flag marking the constraint as an "automatic" constraint. More...
 
void SetConstraintAlignment (NXOpen::Positioning::Constraint::Alignment alignment)
 Sets the alignment behavior for the constraint. More...
 
void SetConstraintType (NXOpen::Positioning::Constraint::Type constraintType)
 Sets the constraint type. More...
 
void SetExpression (const NXString &expression)
 The expression used for constraint - only for distance or angle
Created in NX4.0.0. More...
 
void SetExpression (const char *expression)
 The expression used for constraint - only for distance or angle
Created in NX4.0.0. More...
 
void SetPersistent (bool persistent)
 Sets the persistent state of the constraint. More...
 
void SetSplinePointsType (NXOpen::Positioning::Constraint::SplineType splineType)
 Sets the type of the spline. More...
 
void SetSuppressed (bool suppressed)
 Sets the suppression state for the constraint. More...
 
NXOpen::Positioning::Constraint::SplineType SplinePointsType ()
 Returns the type of the spline. More...
 
bool Suppressed ()
 Returns the suppression state for the constraint. 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::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (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< NXStringGetUserAttributesAsStrings ()
 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::BasePartOwningPart ()
 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::INXObjectPrototype ()
 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

Constraint for use in positioning assembly objects in NX.


Created in NX5.0.1.

Member Enumeration Documentation

Specifies how a constraint affects the positioning of a component.

Enumerator
DirectionToFixedToward 

Toward fixed geometry.

DirectionToFixedAwayFrom 

Away from fixed geometry.

DirectionToFixedNothingFixed 

The network does not contain any fixed geometry.

DirectionToFixedFix 

The constraint is a NXOpen::Positioning::Constraint::TypeFix.

DirectionToFixedSuppressed 

The constraint is suppressed.

DirectionToFixedIgnoredInArrangement 

The current arrangement ignores all constraints.

Member Function Documentation

bool NXOpen::Positioning::ComponentConstraint::ArrangementSpecific ( )

Returns the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the NXOpen::Positioning::ComponentPositioner::PrimaryArrangement and NXOpen::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 NXOpen::Positioning::ComponentConstraint::DirectionToFixed value of the NXOpen::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.

Returns
The NXOpen::Positioning::ComponentConstraint::DirectionToFixed value.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
componentThe component constrained to the specified constraint.
arrangementThe NXOpen::Assemblies::Arrangement in which the constraint state is being evaluated.
bool NXOpen::Positioning::ComponentConstraint::GetInherited ( )

Get whether this NXOpen::Positioning::ComponentConstraint is an inherited constraint.

An inherited constraint is created by the system to support Positioning Overrides.

Returns
The inherited state of this NXOpen::Positioning::ComponentConstraint
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
bool NXOpen::Positioning::ComponentConstraint::GetSharedSuppressed ( )

Get the shared suppression state of this NXOpen::Positioning::ComponentConstraint used across all arrangements where the constraint is not arrangement specific.

Returns
The suppression state.
Created in NX10.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
bool NXOpen::Positioning::ComponentConstraint::GetSpecificInArrangement ( NXOpen::Assemblies::Arrangement arrangement)

Get the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the specified NXOpen::Assemblies::Arrangement .

Returns
The arrangement specific state.
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
arrangementThe NXOpen::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 NXOpen::Positioning::ComponentConstraint in the specified NXOpen::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.

Returns
The suppression state.
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
arrangementThe NXOpen::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")

Parameters
componentThe NXOpen::Assemblies::Component on which the constraint is remembered
void NXOpen::Positioning::ComponentConstraint::SetArrangementSpecific ( bool  arrangementSpecific)

Sets the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the NXOpen::Positioning::ComponentPositioner::PrimaryArrangement and NXOpen::Positioning::ComponentPositioner::SetPrimaryArrangement .

Constraints can never be arrangement specific in piece parts.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
arrangementSpecificThe arrangement specific state
void NXOpen::Positioning::ComponentConstraint::SetSharedSuppressed ( bool  suppressed)

Set the shared suppression state of this NXOpen::Positioning::ComponentConstraint used across all arrangements where the constraint is not arrangement specific.


Created in NX10.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
suppressedThe suppression state.
void NXOpen::Positioning::ComponentConstraint::SetSpecificInArrangement ( NXOpen::Assemblies::Arrangement arrangement,
bool  arrangementSpecific 
)

Set the arrangement specific state of this NXOpen::Positioning::ComponentConstraint in the specified NXOpen::Assemblies::Arrangement .


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
arrangementThe NXOpen::Assemblies::Arrangement in which the arrangement specific state is being set.
arrangementSpecificThe arrangement specific state.
void NXOpen::Positioning::ComponentConstraint::SetSuppressedInArrangement ( NXOpen::Assemblies::Arrangement arrangement,
bool  suppressed 
)

Set the suppression state of this NXOpen::Positioning::ComponentConstraint in the specified NXOpen::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")

Parameters
arrangementThe NXOpen::Assemblies::Arrangement in which the suppression state is being set.
suppressedThe suppression state.

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