ArticulationControl Class

class NXOpen.Motion.ArticulationControl

Bases: NXOpen.Motion.PostControl

Represents the NXOpen.Motion.ArticulationControl

An instance of this class can not be obtained

New in version NX9.0.0.

Properties

Property Description
ActiveView Returns or sets the active view
Delay Returns or sets the articulation delay
IsOccurrence Returns whether this object is an occurrence or not.
JointsLimits Returns or sets the articulation joint limits setting
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Name Returns the custom name of the object.
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.

Methods

Method Description
ArticulationSolve Articulation solve with joint driver step size and number of step as input This method adds event loop that solves step by step and return.
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
Finish Articulation finish
GetArticulationJoints Articulation joints
GetArticulationJointsDisplacement Get the articulation joints displacement
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
Print Prints a representation of this object to the system log file.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.
StepToAssemblyPosition Articulation to assembly position
StepToDesignPosition Articulation to design position
Stop Articulation stop

Property Detail

ActiveView

ArticulationControl.ActiveView

Returns or sets the active view

-------------------------------------

Getter Method

Signature ActiveView

Returns:The articulation active view
Return type:NXOpen.Motion.ActiveView

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ActiveView

Parameters:activeView (NXOpen.Motion.ActiveView) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Delay

ArticulationControl.Delay

Returns or sets the articulation delay

-------------------------------------

Getter Method

Signature Delay

Returns:The articulation delay
Return type:int

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Delay

Parameters:delay (int) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

IsOccurrence

ArticulationControl.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JointsLimits

ArticulationControl.JointsLimits

Returns or sets the articulation joint limits setting

-------------------------------------

Getter Method

Signature JointsLimits

Returns:The joint limits on/off flag setting
Return type:bool

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature JointsLimits

Parameters:jointLimits (bool) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

JournalIdentifier

ArticulationControl.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Name

ArticulationControl.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

ArticulationControl.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

ArticulationControl.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

ArticulationControl.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

ArticulationSolve

ArticulationControl.ArticulationSolve

Overloaded method ArticulationSolve

  • ArticulationSolve(numSteps, jointTags, stepSize, stepSizeUnit)
  • ArticulationSolve(jointTags, displacement, displacementUnit)

-------------------------------------

Articulation solve with joint driver step size and number of step as input This method adds event loop that solves step by step and return. It does not wait finishing the solving process. For the case there is no UI button to control the solve and stop action, call another Motion.ArticulationControl.ArticulationSolve() that has no numSteps input in a cycle to solve

Signature ArticulationSolve(numSteps, jointTags, stepSize, stepSizeUnit)

Parameters:
  • numSteps (int) – The number of step will take in one action
  • jointTags (list of NXOpen.Motion.Joint) – Articulation joint tags
  • stepSize (list of float) – Articulation joint step size
  • stepSizeUnit (list of NXOpen.Unit) – Articulation joint step size unit

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Articulation solve with joint driver displacement as input

Signature ArticulationSolve(jointTags, displacement, displacementUnit)

Parameters:
  • jointTags (list of NXOpen.Motion.Joint) – Articulation joint tags
  • displacement (list of float) – Articulation joint displacement
  • displacementUnit (list of NXOpen.Unit) – Articulation joint displacement units

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

FindObject

ArticulationControl.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Finish

ArticulationControl.Finish

Articulation finish

Signature Finish()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetArticulationJoints

ArticulationControl.GetArticulationJoints

Articulation joints

Signature GetArticulationJoints()

Returns:The articulation joint array
Return type:list of NXOpen.Motion.Joint

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetArticulationJointsDisplacement

ArticulationControl.GetArticulationJointsDisplacement

Get the articulation joints displacement

Signature GetArticulationJointsDisplacement(jointTag)

Parameters:jointTag (NXOpen.Motion.Joint) – The special articulation joint object
Returns:a tuple
Return type:A tuple consisting of (currentStep, displacement, displacementUnit). currentStep is a int. The current step index displacement is a float. The articulation joint displacement value within current step displacementUnit is a NXOpen.Unit. The articulation joint displacement unit

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Print

ArticulationControl.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

ArticulationControl.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

StepToAssemblyPosition

ArticulationControl.StepToAssemblyPosition

Articulation to assembly position

Signature StepToAssemblyPosition()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepToDesignPosition

ArticulationControl.StepToDesignPosition

Articulation to design position

Signature StepToDesignPosition()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Stop

ArticulationControl.Stop

Articulation stop

Signature Stop()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)