ConstraintReference for use in positioning objects in NX. More...

Inheritance diagram for NXOpen.Positioning.ConstraintReference:

Public Types
enum	ConstraintOrder { Unknown, Inside, Outside }
	Specifies the order of the constraint reference used in a NXOpen.Positioning.Constraint . More...

enum	GeometryType { Unknown = -1, Point, Line, Circle, Plane, Cylinder, Sphere, SweepSurface, ParametricSurface, ParametricCurve, SplineCurve, Torus, Cone, Ellipse, SplineSurface, CoordinateSystem = 1001 }
	Specifies the type of the geometry used in a NXOpen.Positioning.ConstraintReference . More...

enum	HalfSpace { Infer, Positive, Negative }
	Specifies the half space value of one geometry used in a distance constraint. More...

Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
unsafe NXOpen.NXObject	GetGeometry ()
	Returns the geometry of the constraint reference. More...

unsafe bool	GetHasPerpendicularVector ()
	Get the flag indicating whether the constraint reference is one that maintains a direction perpendicular to the primary geometry. More...

unsafe NXOpen.NXObject	GetMovableObject ()
	Returns the movable object of the constraint reference. More...

unsafe NXOpen.NXObject	GetPrototypeGeometry ()
	Returns the prototype geometry of the constraint reference. More...

unsafe NXOpen.Vector3d	GetPrototypePerpendicularVector ()
	Get the value of the perpendicular vector, which will be (0,0,0) for most constraints apart from NXOpen.Positioning.Constraint.Type.AlignLock . More...

unsafe bool	GetUsePortRotate ()
	Get the flag forcing the use of the rotation vector of the referenced NXOpen.Routing.Port object instead of the alignment vector when solving the constraint system. More...

unsafe bool	GetUsesGeometryAxis ()
	Returns if the constraint reference should use the axis of the geometry (for example a cylindrical face) rather than the surface More...

unsafe void	SetFixHint (bool set)
	Set a hint to the solver to fix the movable object associated with this constraint reference. More...

unsafe void	SetFixHintForUpdate (bool set)
	Set a hint to the solver to fix the movable object associated with this constraint reference. More...

unsafe void	SetPrototypePerpendicularVector (NXOpen.Vector3d perpendicularVector)
	Set the value of the perpendicular vector. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

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

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

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

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

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

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

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

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string 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...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string 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...

unsafe string	GetUserAttributeAsString (string 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...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

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

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

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe int	GetUserAttributeSize (string 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...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string 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...

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

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

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

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

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

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

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

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

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

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

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

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

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

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

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

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Positioning.ConstraintReference.HalfSpace	ConstraintReferenceHalfSpace `[get, set]`
	Returns or sets the half_space value for the constraint reference. More...

unsafe bool	GeometryDirectionReversed `[get, set]`
	Returns or sets whether the direction is reversed with respect to the direction of the geometry. More...

unsafe NXOpen.Point3d	HelpPoint `[get, set]`
	Returns or sets the help point of the constraint reference. More...

unsafe NXOpen.Positioning.ConstraintReference.ConstraintOrder	Order `[get]`
	Returns the order of the constraint reference within its constraint. More...

unsafe NXOpen.Positioning.ConstraintReference.GeometryType	SolverGeometryType `[get]`
	Returns the geometry type of the constraint reference used during a solve. More...

unsafe bool	UsePortRotateFlag `[get, set]`
	Returns or sets the flag forcing the use of the rotation vector of the referenced NXOpen.Routing.Port object instead of the alignment vector when solving the constraint system. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

ConstraintReference for use in positioning objects in NX.

A ConstraintReference is used by a Constraint to determine the movable object to be positioned by the constraint and the geometry used to define the constraint.

To create an instance of this class, use NXOpen.Positioning.Constraint.CreateConstraintReference .

Created in NX4.0.0

Member Enumeration Documentation

enum NXOpen.Positioning.ConstraintReference.ConstraintOrder

Specifies the order of the constraint reference used in a NXOpen.Positioning.Constraint .

Typically the order is set during creation, where the first constraint reference added is "outside" and the second "outside". For Bond constraints, the order is set to be "unknown" at creation.

Enumerator
Unknown	No order specified
Inside	Inside
Outside	Outside

enum NXOpen.Positioning.ConstraintReference.GeometryType

Specifies the type of the geometry used in a NXOpen.Positioning.ConstraintReference .

The type reflects that used in a NXOpen.Positioning.Constraint while it is being solved and may be different from that inferred directly from NXOpen.Positioning.ConstraintReference.GetGeometry . For example we may use NXOpen.Positioning.ConstraintReference.GeometryType.Line as an axis when given a cylindrical face as the geometry.

Enumerator
Unknown	No geometry suitable for solving
Point	Point
Line	Straight line
Circle	Circle
Plane	Plane
Cylinder	Cylinder
Sphere	Sphere
SweepSurface	Swept surface
ParametricSurface	Parametric surface
ParametricCurve	Parametric curve
SplineCurve	Spline curve
Torus	Torus
Cone	Cone
Ellipse	Ellipse
SplineSurface	Spline surface
CoordinateSystem	Coordinate system

enum NXOpen.Positioning.ConstraintReference.HalfSpace

Specifies the half space value of one geometry used in a distance constraint.

This is only used for surface geometries, and it determines which side of the surface the distance constraint is measured from.

Enumerator
Infer	Allow the solver to decide the half space value, or the geometry is not a surface
Positive	Measure to the positive side of the surface
Negative	Measure to the negative side of the surface

Member Function Documentation

unsafe NXOpen.NXObject NXOpen.Positioning.ConstraintReference.GetGeometry ( )

inline

Returns the geometry of the constraint reference.

This is the geometry used in any NXOpen.Positioning.Constraint using this constraint reference.

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: The geometry referenced by the constraint

unsafe bool NXOpen.Positioning.ConstraintReference.GetHasPerpendicularVector ( )

inline

Get the flag indicating whether the constraint reference is one that maintains a direction perpendicular to the primary geometry.

This is only applicable to NXOpen.Positioning.Constraint.Type NXOpen.Positioning.Constraint.Type.AlignLock .

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: Whether the constraint has a perpendicular vector

unsafe NXOpen.NXObject NXOpen.Positioning.ConstraintReference.GetMovableObject ( )

inline

Returns the movable object of the constraint reference.

The movable object determines the object to be positioned by any NXOpen.Positioning.Constraint using this constraint reference.

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: The object positioned by the constraint

unsafe NXOpen.NXObject NXOpen.Positioning.ConstraintReference.GetPrototypeGeometry ( )

inline

Returns the prototype geometry of the constraint reference.

This is never an occurrence.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: The prototype geometry referenced by the constraint

unsafe NXOpen.Vector3d NXOpen.Positioning.ConstraintReference.GetPrototypePerpendicularVector ( )

inline

Get the value of the perpendicular vector, which will be (0,0,0) for most constraints apart from NXOpen.Positioning.Constraint.Type.AlignLock .

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: The value of the perpendicular vector

unsafe bool NXOpen.Positioning.ConstraintReference.GetUsePortRotate ( )

inline

Get the flag forcing the use of the rotation vector of the referenced NXOpen.Routing.Port object instead of the alignment vector when solving the constraint system.

Only effective when the referenced geometry is a NXOpen.Routing.Port object.

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns

unsafe bool NXOpen.Positioning.ConstraintReference.GetUsesGeometryAxis ( )

inline

Returns if the constraint reference should use the axis of the geometry (for example a cylindrical face) rather than the surface

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: If this reference is using the axis of the geometry

unsafe void NXOpen.Positioning.ConstraintReference.SetFixHint ( bool set )

inline

Set a hint to the solver to fix the movable object associated with this constraint reference.

The hint is unset when "set" is false.

The hint can only have an effect when the constraint owning this constraint reference has been explicitly added to a NXOpen.Positioning.Network .

The hint is forgotten after an update.

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

set	Set or unset the hint

unsafe void NXOpen.Positioning.ConstraintReference.SetFixHintForUpdate ( bool set )

inline

Set a hint to the solver to fix the movable object associated with this constraint reference.

The hint is unset when "set" is false.

The hint is forgotten after an update.

Ensures that the constraint that owns this reference will solve during the next call to NXOpen.Update.DoUpdate .

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

set	Set or unset the hint

unsafe void NXOpen.Positioning.ConstraintReference.SetPrototypePerpendicularVector ( NXOpen.Vector3d perpendicularVector )

inline

Set the value of the perpendicular vector.

The value must be a unit vector given in the coordinates of the part containing the referenced geometry.

The perpendicular vector must be set to (0,0,0) for most constraints apart from NXOpen.Positioning.Constraint.Type.AlignLock which must have a value. An error is raised if this is not the case.

Whenever the constraint is solved, the value of the perpendicular vector may be modified, to ensure that the vector is perpendicular to the referenced geometry.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

perpendicularVector The value of the perpendicular vector

Property Documentation

unsafe NXOpen.Positioning.ConstraintReference.HalfSpace NXOpen.Positioning.ConstraintReference.ConstraintReferenceHalfSpace

getset

Returns or sets the half_space value for the constraint reference.

This is only used for distance constraints.

Created in NX5.0.1

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.Positioning.ConstraintReference.GeometryDirectionReversed

getset

Returns or sets whether the direction is reversed with respect to the direction of the geometry.

This property is only used if the underlying geometry can have an associated direction.

Created in NX12.0.0

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Point3d NXOpen.Positioning.ConstraintReference.HelpPoint

getset

Returns or sets the help point of the constraint reference.

Created in NX4.0.0

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Positioning.ConstraintReference.ConstraintOrder NXOpen.Positioning.ConstraintReference.Order

get

Returns the order of the constraint reference within its constraint.

Note that this order is not associated with the geometry or with the alignment of the constraint. It is based on the idea that the constraint has a direction from "outside" to "inside". It does not affect the result of a solve.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Positioning.ConstraintReference.GeometryType NXOpen.Positioning.ConstraintReference.SolverGeometryType

get

Returns the geometry type of the constraint reference used during a solve.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.Positioning.ConstraintReference.UsePortRotateFlag

getset

Returns or sets the flag forcing the use of the rotation vector of the referenced NXOpen.Routing.Port object instead of the alignment vector when solving the constraint system.

Only effective when the referenced geometry is a NXOpen.Routing.Port object.

Created in NX5.0.1

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

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

Positioning_ConstraintReference.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation