BodyContactLms Class¶

class NXOpen.Motion.BodyContactLms¶

Bases: NXOpen.NXObject

Represents a NXOpen.Motion.BodyContactLms

New in version NX10.0.0.

Properties¶

Property	Description
ActionAngleTolerance	Returns the action angle tolerance
ActionDistanceTolerance	Returns the action distance tolerance
ActionEnableMaxFacetSize	Returns or sets the action enable max facet size
ActionMaxFacetSize	Returns the action max facet size
ActionTessellationFile	Returns or sets the action tessellation file
ActionUseTessellationFile	Returns or sets the action tessellation file option
BaseAngleTolerance	Returns the base angle tolerance
BaseDistanceTolerance	Returns the base distance tolerance
BaseEnableMaxFacetSize	Returns or sets the base enable max facet size
BaseMaxFacetSize	Returns the base max facet size
BaseTessellationFile	Returns or sets the base tessellation file
BaseUseTessellationFile	Returns or sets the base tessellation file option
CoulombFrictionOption	Returns or sets the coulomb friction option
DynamicCoefficient	Returns the dynamic coefficient
ForceExponent	Returns the force exponent
ForceModel	Returns or sets the force model
ForceModelTolerance	Returns the force model tolerance
FrictionVelocity	Returns the friction velocity
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
MaterialDamping	Returns the material damping
MaxPenetrationDepth	Returns the max penetration depth
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.
StaticCoefficient	Returns the static coefficient
StictionVelocity	Returns the stiction velocity
Stiffness	Returns the stiffness
Tag	Returns the Tag for this object.

Methods¶

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

Enumerations¶

BodyContactLmsCoulombFriction Enumeration	the enum for friction option of 3D contact
BodyContactLmsForceModelType Enumeration	the enum for force model of 3D contact

Property Detail¶

ActionAngleTolerance¶

BodyContactLms.ActionAngleTolerance¶

Returns the action angle tolerance

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

Getter Method

Signature ActionAngleTolerance

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

ActionDistanceTolerance¶

BodyContactLms.ActionDistanceTolerance¶

Returns the action distance tolerance

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

Getter Method

Signature ActionDistanceTolerance

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

ActionEnableMaxFacetSize¶

BodyContactLms.ActionEnableMaxFacetSize¶

Returns or sets the action enable max facet size

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

Getter Method

Signature ActionEnableMaxFacetSize

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ActionEnableMaxFacetSize

Parameters:	actionEnableMaxFacetSize (bool) –

New in version NX10.0.0.

License requirements: mechanisms (“MECHANISMS”)

ActionMaxFacetSize¶

BodyContactLms.ActionMaxFacetSize¶

Returns the action max facet size

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

Getter Method

Signature ActionMaxFacetSize

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

ActionTessellationFile¶

BodyContactLms.ActionTessellationFile¶

Returns or sets the action tessellation file

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

Getter Method

Signature ActionTessellationFile

Returns:
Return type:	str

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ActionTessellationFile

Parameters:	fileName (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ActionUseTessellationFile¶

BodyContactLms.ActionUseTessellationFile¶

Returns or sets the action tessellation file option

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

Getter Method

Signature ActionUseTessellationFile

Returns:
Return type:	bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ActionUseTessellationFile

Parameters:	fileOption (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

BaseAngleTolerance¶

BodyContactLms.BaseAngleTolerance¶

Returns the base angle tolerance

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

Getter Method

Signature BaseAngleTolerance

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

BaseDistanceTolerance¶

BodyContactLms.BaseDistanceTolerance¶

Returns the base distance tolerance

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

Getter Method

Signature BaseDistanceTolerance

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

BaseEnableMaxFacetSize¶

BodyContactLms.BaseEnableMaxFacetSize¶

Returns or sets the base enable max facet size

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

Getter Method

Signature BaseEnableMaxFacetSize

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature BaseEnableMaxFacetSize

Parameters:	baseEnableMaxFacetSize (bool) –

New in version NX10.0.0.

License requirements: mechanisms (“MECHANISMS”)

BaseMaxFacetSize¶

BodyContactLms.BaseMaxFacetSize¶

Returns the base max facet size

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

Getter Method

Signature BaseMaxFacetSize

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

BaseTessellationFile¶

BodyContactLms.BaseTessellationFile¶

Returns or sets the base tessellation file

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

Getter Method

Signature BaseTessellationFile

Returns:
Return type:	str

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature BaseTessellationFile

Parameters:	fileName (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

BaseUseTessellationFile¶

BodyContactLms.BaseUseTessellationFile¶

Returns or sets the base tessellation file option

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

Getter Method

Signature BaseUseTessellationFile

Returns:
Return type:	bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature BaseUseTessellationFile

Parameters:	fileOption (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

CoulombFrictionOption¶

BodyContactLms.CoulombFrictionOption¶

Returns or sets the coulomb friction option

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

Getter Method

Signature CoulombFrictionOption

Returns:
Return type:	`NXOpen.Motion.BodyContactLmsCoulombFriction`

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature CoulombFrictionOption

Parameters:	coulombFrictionOption (`NXOpen.Motion.BodyContactLmsCoulombFriction`) –

New in version NX10.0.0.

License requirements: mechanisms (“MECHANISMS”)

DynamicCoefficient¶

BodyContactLms.DynamicCoefficient¶

Returns the dynamic coefficient

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

Getter Method

Signature DynamicCoefficient

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

ForceExponent¶

BodyContactLms.ForceExponent¶

Returns the force exponent

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

Getter Method

Signature ForceExponent

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

ForceModel¶

BodyContactLms.ForceModel¶

Returns or sets the force model

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

Getter Method

Signature ForceModel

Returns:
Return type:	`NXOpen.Motion.BodyContactLmsForceModelType`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ForceModel

Parameters:	model (`NXOpen.Motion.BodyContactLmsForceModelType`) –

New in version NX11.0.0.

License requirements: None.

ForceModelTolerance¶

BodyContactLms.ForceModelTolerance¶

Returns the force model tolerance

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

Getter Method

Signature ForceModelTolerance

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: None.

FrictionVelocity¶

BodyContactLms.FrictionVelocity¶

Returns the friction velocity

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

Getter Method

Signature FrictionVelocity

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

IsOccurrence¶

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

JournalIdentifier¶

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

MaterialDamping¶

BodyContactLms.MaterialDamping¶

Returns the material damping

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

Getter Method

Signature MaterialDamping

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

MaxPenetrationDepth¶

BodyContactLms.MaxPenetrationDepth¶

Returns the max penetration depth

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

Getter Method

Signature MaxPenetrationDepth

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: None.

Name¶

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

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

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

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

StaticCoefficient¶

BodyContactLms.StaticCoefficient¶

Returns the static coefficient

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

Getter Method

Signature StaticCoefficient

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

StictionVelocity¶

BodyContactLms.StictionVelocity¶

Returns the stiction velocity

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

Getter Method

Signature StictionVelocity

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

Stiffness¶

BodyContactLms.Stiffness¶

Returns the stiffness

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

Getter Method

Signature Stiffness

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

Method Detail¶

FindObject¶

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

Print¶

BodyContactLms.Print¶

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName¶

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