BodyContactAdams Class

class NXOpen.Motion.BodyContactAdams

Bases: NXOpen.NXObject

Represents a NXOpen.Motion.BodyContactAdams

New in version NX5.0.0.

Properties

Property Description
CoulombFrictionOption Returns or sets the coulomb friction option
DynamicCoefficientExpression Returns the dynamic coefficient
ForceExponentExpression Returns the force exponent expression
ForceModelType Returns or sets the force model type
FrictionVelocityExpression Returns the friction velocity expression
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
MaterialDampingExpression Returns the material damping expression
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
PenetrationDepthExpression Returns the penetration depth expression
Prototype Returns the prototype of this object if it is an occurrence.
RestitutionCoefficentExpression Returns the restitution coefficent expression
StaticCoefficientExpression Returns the static coefficient expression
StictionVelocityExpression Returns the stiction velocity expression
StiffnessExpression Returns the stiffness expression
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

BodyContactAdamsCoulombFriction Enumeration the enum for friction option of 3D contact
BodyContactAdamsForceModel Enumeration the enum for forec model of 3D contact

Property Detail

CoulombFrictionOption

BodyContactAdams.CoulombFrictionOption

Returns or sets the coulomb friction option

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

Getter Method

Signature CoulombFrictionOption

Returns:
Return type:NXOpen.Motion.BodyContactAdamsCoulombFriction

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature CoulombFrictionOption

Parameters:coulombFriction (NXOpen.Motion.BodyContactAdamsCoulombFriction) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

DynamicCoefficientExpression

BodyContactAdams.DynamicCoefficientExpression

Returns the dynamic coefficient

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

Getter Method

Signature DynamicCoefficientExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ForceExponentExpression

BodyContactAdams.ForceExponentExpression

Returns the force exponent expression

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

Getter Method

Signature ForceExponentExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ForceModelType

BodyContactAdams.ForceModelType

Returns or sets the force model type

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

Getter Method

Signature ForceModelType

Returns:
Return type:NXOpen.Motion.BodyContactAdamsForceModel

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ForceModelType

Parameters:forceModel (NXOpen.Motion.BodyContactAdamsForceModel) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

FrictionVelocityExpression

BodyContactAdams.FrictionVelocityExpression

Returns the friction velocity expression

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

Getter Method

Signature FrictionVelocityExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

IsOccurrence

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

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

MaterialDampingExpression

BodyContactAdams.MaterialDampingExpression

Returns the material damping expression

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

Getter Method

Signature MaterialDampingExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Name

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

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

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

PenetrationDepthExpression

BodyContactAdams.PenetrationDepthExpression

Returns the penetration depth expression

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

Getter Method

Signature PenetrationDepthExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Prototype

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

RestitutionCoefficentExpression

BodyContactAdams.RestitutionCoefficentExpression

Returns the restitution coefficent expression

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

Getter Method

Signature RestitutionCoefficentExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

StaticCoefficientExpression

BodyContactAdams.StaticCoefficientExpression

Returns the static coefficient expression

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

Getter Method

Signature StaticCoefficientExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

StictionVelocityExpression

BodyContactAdams.StictionVelocityExpression

Returns the stiction velocity expression

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

Getter Method

Signature StictionVelocityExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

StiffnessExpression

BodyContactAdams.StiffnessExpression

Returns the stiffness expression

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

Getter Method

Signature StiffnessExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Method Detail

FindObject

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

BodyContactAdams.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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