NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.Positioning.ComponentPositioner Class Reference

An instance of this class can be used to create NXOpen.Positioning.Constraint s and associated objects. More...

Inheritance diagram for NXOpen.Positioning.ComponentPositioner:
NXOpen.Positioning.Positioner NXOpen.NXObject NXOpen.INXObject

Public Member Functions

unsafe void BeginMoveComponent ()
 Begins a mode of operation where (1) each new NXOpen.Positioning.Constraint is created as transient and (2) a component transform is applied at the level where position is controlled for the component, typically in the component's immediate parent. More...
 
unsafe void EndMoveComponent ()
 Ends the mode of operation started by NXOpen.Positioning.ComponentPositioner.BeginMoveComponent All constraints created while in that mode will be deleted. More...
 
unsafe void BeginAssemblyConstraints ()
 Begins a mode of operation where (1) each new NXOpen.Positioning.Constraint created by this NXOpen.Positioning.ComponentPositioner applies to components in the part of the positioner (or to components with variable component positioning defined in the part of the positioner) and (2) and component transforms derived from a NXOpen.Positioning.Network will apply to components in the part of the positioner. More...
 
unsafe void EndAssemblyConstraints ()
 Ends the mode of operation started by NXOpen.Positioning.ComponentPositioner.BeginAssemblyConstraints All non-persistent constraints in this NXOpen.Positioning.ComponentPositioner will be deleted. More...
 
unsafe void BeginMoveComponentInWorkset ()
 Begins a mode of operation where (1) each new NXOpen.Positioning.Constraint is created as transient and (2) a component transform is applied at the workset level. More...
 
unsafe void EndMoveComponentInWorkset ()
 Ends the mode of operation started by NXOpen.Positioning.ComponentPositioner.BeginMoveComponentInWorkset All constraints created while in that mode will be deleted. More...
 
unsafe void LoadConstraintGeometry (NXOpen.Positioning.ComponentConstraint[] constraints)
 Attempts to load all the parts that contain unloaded geometry that is referenced by the constraints or by any related constraints. More...
 
unsafe void SolvePostponedConstraints ()
 Solves constraints in all arrangements that are currently postponing their solve. More...
 
- Public Member Functions inherited from NXOpen.Positioning.Positioner
unsafe
NXOpen.Positioning.Constraint 
CreateConstraint (bool persistent)
 Creates a new NXOpen.Positioning.Constraint in the positioner. More...
 
unsafe
NXOpen.Positioning.Constraint 
CreateConstraint ()
 Creates a new NXOpen.Positioning.Constraint in the positioner. More...
 
unsafe NXOpen.Positioning.Network EstablishNetwork ()
 Establishes a NXOpen.Positioning.Network in the positioner. More...
 
unsafe void ClearNetwork ()
 Removes the NXOpen.Positioning.Network of the positioner. More...
 
unsafe void DeleteNonPersistentConstraints ()
 Deletes all the non-persistent NXOpen.Positioning.Constraint s of the positioner. More...
 
- Public Member Functions inherited from NXOpen.NXObject
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 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 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 NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator 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 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 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 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
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 bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time 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
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 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 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 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.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. 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
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. 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 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 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 int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. 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 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 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
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Properties

unsafe bool DisplayConstraints [get, set]
 Returns or sets the flag indicating whether constraints in the part of this positioner are to be displayed on the graphics window or not. More...
 
unsafe bool DisplaySuppressedConstraints [get, set]
 Returns or sets the flag indicating whether suppressed constraints in the part of this positioner are to be displayed on the graphics window or not. More...
 
unsafe bool MoveDumbGeometry [get, set]
 Returns or sets the flag that enables the positioner to reposition dumb geometry. More...
 
unsafe
NXOpen.Assemblies.Arrangement 
PrimaryArrangement [get, set]
 Returns or sets the NXOpen.Assemblies.Arrangement in which the primary NXOpen.Positioning.Network will solve. More...
 
- Properties inherited from NXOpen.Positioning.Positioner
NXOpen.Positioning.ConstraintCollection Constraints [get]
 The collection of NXOpen.Positioning.Constraint s defined in the positioner 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.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

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

Detailed Description

An instance of this class can be used to create NXOpen.Positioning.Constraint s and associated objects.

To obtain an instance of this class, use NXOpen.Assemblies.ComponentAssembly.Positioner

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.Positioning.ComponentPositioner.BeginAssemblyConstraints ( )

Begins a mode of operation where (1) each new NXOpen.Positioning.Constraint created by this NXOpen.Positioning.ComponentPositioner applies to components in the part of the positioner (or to components with variable component positioning defined in the part of the positioner) and (2) and component transforms derived from a NXOpen.Positioning.Network will apply to components in the part of the positioner.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.ComponentPositioner.BeginMoveComponent ( )

Begins a mode of operation where (1) each new NXOpen.Positioning.Constraint is created as transient and (2) a component transform is applied at the level where position is controlled for the component, typically in the component's immediate parent.

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.ComponentPositioner.BeginMoveComponentInWorkset ( )

Begins a mode of operation where (1) each new NXOpen.Positioning.Constraint is created as transient and (2) a component transform is applied at the workset level.

Created in NX12.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.ComponentPositioner.EndAssemblyConstraints ( )

Ends the mode of operation started by NXOpen.Positioning.ComponentPositioner.BeginAssemblyConstraints All non-persistent constraints in this NXOpen.Positioning.ComponentPositioner will be deleted.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.ComponentPositioner.EndMoveComponent ( )

Ends the mode of operation started by NXOpen.Positioning.ComponentPositioner.BeginMoveComponent All constraints created while in that mode will be deleted.

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.ComponentPositioner.EndMoveComponentInWorkset ( )

Ends the mode of operation started by NXOpen.Positioning.ComponentPositioner.BeginMoveComponentInWorkset All constraints created while in that mode will be deleted.

Created in NX12.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.ComponentPositioner.LoadConstraintGeometry ( NXOpen.Positioning.ComponentConstraint[]  constraints)

Attempts to load all the parts that contain unloaded geometry that is referenced by the constraints or by any related constraints.

The constraints must be within the positioner otherwise an error will be raised. Any constraints that are suppressed will be ignored.

If the number of constraints is zero then the function attempts to load the parts for every unsuppressed constraint in the positioner.

Calling this function can cause objects to be logged for update and therefore the caller of this function must call update.

Created in NX7.5.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
constraintsConstraints
unsafe void NXOpen.Positioning.ComponentPositioner.SolvePostponedConstraints ( )

Solves constraints in all arrangements that are currently postponing their solve.

This could lead to updating the model if required. This call will have no effect if assembly constraint update has been delayed.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Property Documentation

unsafe bool NXOpen.Positioning.ComponentPositioner.DisplayConstraints
getset

Returns or sets the flag indicating whether constraints in the part of this positioner are to be displayed on the graphics window or not.

(This is a separate system from hiding and showing individual constraints.) This flag controls the visibility of both suppressed and unsuppressed constraints.

Created in NX9.0.0

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

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

unsafe bool NXOpen.Positioning.ComponentPositioner.DisplaySuppressedConstraints
getset

Returns or sets the flag indicating whether suppressed constraints in the part of this positioner are to be displayed on the graphics window or not.

(This is a separate system from hiding and showing individual constraints.)

Created in NX9.0.0

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

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

unsafe bool NXOpen.Positioning.ComponentPositioner.MoveDumbGeometry
getset

Returns or sets the flag that enables the positioner to reposition dumb geometry.

Dumb geometry is any geometry that is not controlled by another object such as a NXOpen.Features.Feature object. This flag has no effect on Routing geometry (segments and control points) as they are always considered movable by the positioner.

Created in NX9.0.0

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

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

unsafe NXOpen.Assemblies.Arrangement NXOpen.Positioning.ComponentPositioner.PrimaryArrangement
getset

Returns or sets the NXOpen.Assemblies.Arrangement in which the primary NXOpen.Positioning.Network will solve.

Created in NX4.0.0

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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.