NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Motion.BodyContactLms Class Reference

Represents a NXOpen.Motion.BodyContactLms More...

Inheritance diagram for NXOpen.Motion.BodyContactLms:
NXOpen.NXObject NXOpen.IExternalFileReferencer NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  CoulombFriction { Off, On }
 the enum for friction option of 3D contact More...
 
enum  ExternalFileReferenceId { BaseTessellation, ActionTessellation }
 the enum for external file reference object id of 3D contact More...
 
enum  ForceModelType { Auto, ProjectedVertex, Midplane }
 the enum for force model of 3D contact 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.ExternalFileReferenceAdapter 
EstablishReference (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter.Type referenceType, string externalFileSpec)
 Establish the external reference to the given file specification. More...
 
unsafe string GetExternalFileDefinitionKey (NXOpen.ExternalFileReferenceAdapter adapter)
 Gets the file definition to use for external file adapter. More...
 
unsafe
NXOpen.ExternalFileReferenceAdapter 
GetExternalFileReferenceAdapter (int referenceObjectId)
 Returns the external file reference object. More...
 
unsafe void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter adapter)
 Sets the external file reference object. 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.Expression ActionAngleTolerance [get]
 Returns the action angle tolerance More...
 
unsafe NXOpen.Expression ActionDistanceTolerance [get]
 Returns the action distance tolerance More...
 
unsafe bool ActionEnableMaxFacetSize [get, set]
 Returns or sets the action enable max facet size More...
 
unsafe NXOpen.Expression ActionMaxFacetSize [get]
 Returns the action max facet size More...
 
unsafe bool ActionUseTessellationFile [get, set]
 Returns or sets the action tessellation file option More...
 
unsafe NXOpen.Expression BaseAngleTolerance [get]
 Returns the base angle tolerance More...
 
unsafe NXOpen.Expression BaseDistanceTolerance [get]
 Returns the base distance tolerance More...
 
unsafe bool BaseEnableMaxFacetSize [get, set]
 Returns or sets the base enable max facet size More...
 
unsafe NXOpen.Expression BaseMaxFacetSize [get]
 Returns the base max facet size More...
 
unsafe bool BaseUseTessellationFile [get, set]
 Returns or sets the base tessellation file option More...
 
unsafe
NXOpen.Motion.BodyContactLms.CoulombFriction 
CoulombFrictionOption [get, set]
 Returns or sets the coulomb friction option More...
 
unsafe NXOpen.Expression DynamicCoefficient [get]
 Returns the dynamic coefficient More...
 
unsafe NXOpen.Expression ForceExponent [get]
 Returns the force exponent More...
 
unsafe
NXOpen.Motion.BodyContactLms.ForceModelType 
ForceModel [get, set]
 Returns or sets the force model More...
 
unsafe NXOpen.Expression ForceModelTolerance [get]
 Returns the force model tolerance More...
 
unsafe NXOpen.Expression FrictionVelocity [get]
 Returns the friction velocity More...
 
unsafe NXOpen.Expression MaterialDamping [get]
 Returns the material damping More...
 
unsafe NXOpen.Expression MaxPenetrationDepth [get]
 Returns the max penetration depth More...
 
unsafe NXOpen.Expression StaticCoefficient [get]
 Returns the static coefficient More...
 
unsafe NXOpen.Expression StictionVelocity [get]
 Returns the stiction velocity More...
 
unsafe NXOpen.Expression Stiffness [get]
 Returns the stiffness 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

Represents a NXOpen.Motion.BodyContactLms

Created in NX10.0.0

Member Enumeration Documentation

the enum for friction option of 3D contact

Enumerator
Off 
On 

the enum for external file reference object id of 3D contact

Enumerator
BaseTessellation 
ActionTessellation 

the enum for force model of 3D contact

Enumerator
Auto 
ProjectedVertex 
Midplane 

Member Function Documentation

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Motion.BodyContactLms.EstablishReference ( int  referenceObjectId,
NXOpen.ExternalFileReferenceAdapter.Type  referenceType,
string  externalFileSpec 
)
inline

Establish the external reference to the given file specification.

Created in NX1847.0.0

License requirements: None.

Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.
Returns
external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe string NXOpen.Motion.BodyContactLms.GetExternalFileDefinitionKey ( NXOpen.ExternalFileReferenceAdapter  adapter)
inline

Gets the file definition to use for external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters
adapterexternal file reference object
Returns

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Motion.BodyContactLms.GetExternalFileReferenceAdapter ( int  referenceObjectId)
inline

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
Returns
external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe void NXOpen.Motion.BodyContactLms.SetExternalFileReferenceAdapter ( int  referenceObjectId,
NXOpen.ExternalFileReferenceAdapter  adapter 
)
inline

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.

Created in NX1847.0.0

License requirements: None.

Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
adapterexternal file reference object

Implements NXOpen.IExternalFileReferencer.

Property Documentation

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.ActionAngleTolerance
get

Returns the action angle tolerance

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.ActionDistanceTolerance
get

Returns the action distance tolerance

Created in NX10.0.0

License requirements: None.

unsafe bool NXOpen.Motion.BodyContactLms.ActionEnableMaxFacetSize
getset

Returns or sets the action enable max facet size

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.ActionMaxFacetSize
get

Returns the action max facet size

Created in NX10.0.0

License requirements: None.

unsafe bool NXOpen.Motion.BodyContactLms.ActionUseTessellationFile
getset

Returns or sets the action tessellation file option

Created in NX12.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.BaseAngleTolerance
get

Returns the base angle tolerance

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.BaseDistanceTolerance
get

Returns the base distance tolerance

Created in NX10.0.0

License requirements: None.

unsafe bool NXOpen.Motion.BodyContactLms.BaseEnableMaxFacetSize
getset

Returns or sets the base enable max facet size

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.BaseMaxFacetSize
get

Returns the base max facet size

Created in NX10.0.0

License requirements: None.

unsafe bool NXOpen.Motion.BodyContactLms.BaseUseTessellationFile
getset

Returns or sets the base tessellation file option

Created in NX12.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.BodyContactLms.CoulombFriction NXOpen.Motion.BodyContactLms.CoulombFrictionOption
getset

Returns or sets the coulomb friction option

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.DynamicCoefficient
get

Returns the dynamic coefficient

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.ForceExponent
get

Returns the force exponent

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Motion.BodyContactLms.ForceModelType NXOpen.Motion.BodyContactLms.ForceModel
getset

Returns or sets the force model

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.ForceModelTolerance
get

Returns the force model tolerance

Created in NX11.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.FrictionVelocity
get

Returns the friction velocity

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.MaterialDamping
get

Returns the material damping

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.MaxPenetrationDepth
get

Returns the max penetration depth

Created in NX11.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.StaticCoefficient
get

Returns the static coefficient

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.StictionVelocity
get

Returns the stiction velocity

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Motion.BodyContactLms.Stiffness
get

Returns the stiffness

Created in NX10.0.0

License requirements: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.