AnalyticalContactBuilder Class

class NXOpen.Motion.AnalyticalContactBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a Motion.AnalyticalContact builder

To create a new instance of this class, use NXOpen.Motion.AnalyticalContactCollection.CreateAnalyticalContactBuilder()

Default values.

Property Value
ContactType SphereToSphere
EffectiveContactDepth.Value 1000 (millimeters part), 39.3701 (inches part)
ExtrusionGeometryData 0
ExtrusionMaterialSide 1
FindAllRoots 0
FirstSuperElementIncrement 1
InfiniteExtrusion 0
InfiniteSweep 0
MaxTesselationLength.Value 5 (millimeters part), 0.19685 (inches part)
Profile None
RadiusOfExclusion.Value 0 (millimeters part), 0 (inches part)
RailGeometryData 0
RailMaterialSide 1
RevolutionGeometryData 0
RevolutionMaterialSide 1
SecondRevolutionGeometryData 0
SecondRevolutionMaterialSide 1
SecondSphereRadius.Value 1000 (millimeters part), 39.3701 (inches part)
SecondSuperElementIncrement 1
SphereRadius.Value 1000 (millimeters part), 39.3701 (inches part)
SuperElementReportInstance 1

New in version NX12.0.0.

Properties

Property Description
ContactProperty Returns the contact property
ContactType Returns or sets the type
DisplayScale Returns or sets the icon display scale
EffectiveContactDepth Returns the max penetration depth
ExtrusionBodies Returns the extrusion bodies
ExtrusionGeometryData Returns or sets the extrusion line-arc file option
ExtrusionGeometryDataFile Returns or sets the extrusion line-arc file.
ExtrusionLink Returns the extrusion link
ExtrusionMaterialSide Returns or sets the material side toggle for extrusion
FindAllRoots Returns or sets the find all roots
FirstSuperElementIncrement Returns or sets the first super element increment
FirstSuperElementLink Returns the first super element link
GroupName Returns or sets the group name
GroupType Returns or sets the group type
InfiniteExtrusion Returns or sets the infinite extrusion
InfiniteSweep Returns or sets the infinite sweep for rail
MaxTesselationLength Returns the max tesselation length
Name Returns or sets the string name
PartialSphereAngle Returns the partial sphere angle
PartialSphereOption Returns or sets the partial sphere option
PartialSphereVector Returns or sets the partial sphere vector
Profile Returns or sets the profile
RadiusOfExclusion Returns the radius of exclusion
RailBodies Returns the rail bodies
RailCurve Returns the rail curve
RailGeometryData Returns or sets the rail line-arc file option
RailGeometryDataFile Returns or sets the rail line-arc file.
RailLink Returns the rail link
RailMaterialSide Returns or sets the material side toggle for rail
RailRollAngleCurve Returns or sets the RailRollAngle function
RailSplineFunctions Returns or sets the spline function toggle for rail
RailXCurve Returns or sets the RailX function
RailYCurve Returns or sets the RailY function
RailZCurve Returns or sets the RailZ function
RevolutionBodies Returns the revolution bodies
RevolutionGeometryData Returns or sets the revolution line-arc file option
RevolutionGeometryDataFile Returns or sets the revolution line-arc file.
RevolutionLink Returns the revolution link
RevolutionMaterialSide Returns or sets the material side toggle for revolution
SecondRevolutionBodies Returns the second revolution bodies
SecondRevolutionGeometryData Returns or sets the second revolution line-arc file option
SecondRevolutionGeometryDataFile Returns or sets the second revolution line-arc file.
SecondRevolutionLink Returns the second revolution link
SecondRevolutionMaterialSide Returns or sets the material side toggle for second revolution
SecondSphereLink Returns the second sphere link
SecondSpherePoint Returns or sets the second sphere point
SecondSphereRadius Returns the second sphere radius
SecondSuperElementIncrement Returns or sets the second super element increment
SecondSuperElementLink Returns the second super element link
SphereLink Returns the sphere link
SpherePoint Returns or sets the sphere point
SphereRadius Returns the sphere radius
SuperElementReportInstance Returns or sets the super element report instance
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ContactProperty

AnalyticalContactBuilder.ContactProperty

Returns the contact property

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

Getter Method

Signature ContactProperty

Returns:
Return type:NXOpen.Motion.SelectAnalyticalContactProperty

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ContactType

AnalyticalContactBuilder.ContactType

Returns or sets the type

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

Getter Method

Signature ContactType

Returns:
Return type:NXOpen.Motion.AnalyticalContactBuilderContactTypeOption

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ContactType

Parameters:type (NXOpen.Motion.AnalyticalContactBuilderContactTypeOption) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

EffectiveContactDepth

AnalyticalContactBuilder.EffectiveContactDepth

Returns the max penetration depth

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

Getter Method

Signature EffectiveContactDepth

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExtrusionBodies

AnalyticalContactBuilder.ExtrusionBodies

Returns the extrusion bodies

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

Getter Method

Signature ExtrusionBodies

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExtrusionGeometryData

AnalyticalContactBuilder.ExtrusionGeometryData

Returns or sets the extrusion line-arc file option

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

Getter Method

Signature ExtrusionGeometryData

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ExtrusionGeometryData

Parameters:geometryDataOption (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExtrusionGeometryDataFile

AnalyticalContactBuilder.ExtrusionGeometryDataFile

Returns or sets the extrusion line-arc file.

This is a file containing information describing the extrusion profile.

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

Getter Method

Signature ExtrusionGeometryDataFile

Returns:
Return type:str

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ExtrusionGeometryDataFile

Parameters:fileName (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExtrusionMaterialSide

AnalyticalContactBuilder.ExtrusionMaterialSide

Returns or sets the material side toggle for extrusion

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

Getter Method

Signature ExtrusionMaterialSide

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ExtrusionMaterialSide

Parameters:matSide (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

FindAllRoots

AnalyticalContactBuilder.FindAllRoots

Returns or sets the find all roots

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

Getter Method

Signature FindAllRoots

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature FindAllRoots

Parameters:findAllRoots (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

FirstSuperElementIncrement

AnalyticalContactBuilder.FirstSuperElementIncrement

Returns or sets the first super element increment

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

Getter Method

Signature FirstSuperElementIncrement

Returns:
Return type:int

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature FirstSuperElementIncrement

Parameters:firstSuperElementIncrement (int) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

InfiniteExtrusion

AnalyticalContactBuilder.InfiniteExtrusion

Returns or sets the infinite extrusion

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

Getter Method

Signature InfiniteExtrusion

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature InfiniteExtrusion

Parameters:infiniteExtrusion (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

InfiniteSweep

AnalyticalContactBuilder.InfiniteSweep

Returns or sets the infinite sweep for rail

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

Getter Method

Signature InfiniteSweep

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature InfiniteSweep

Parameters:infiniteSweep (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

MaxTesselationLength

AnalyticalContactBuilder.MaxTesselationLength

Returns the max tesselation length

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

Getter Method

Signature MaxTesselationLength

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name

AnalyticalContactBuilder.Name

Returns or sets the string name

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

PartialSphereAngle

AnalyticalContactBuilder.PartialSphereAngle

Returns the partial sphere angle

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

Getter Method

Signature PartialSphereAngle

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

PartialSphereOption

AnalyticalContactBuilder.PartialSphereOption

Returns or sets the partial sphere option

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

Getter Method

Signature PartialSphereOption

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature PartialSphereOption

Parameters:partialSphereOption (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

PartialSphereVector

AnalyticalContactBuilder.PartialSphereVector

Returns or sets the partial sphere vector

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

Getter Method

Signature PartialSphereVector

Returns:
Return type:NXOpen.Direction

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature PartialSphereVector

Parameters:partialSphereVector (NXOpen.Direction) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

Profile

AnalyticalContactBuilder.Profile

Returns or sets the profile

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

Getter Method

Signature Profile

Returns:
Return type:NXOpen.Motion.AnalyticalContactBuilderProfileType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature Profile

Parameters:profileType (NXOpen.Motion.AnalyticalContactBuilderProfileType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RadiusOfExclusion

AnalyticalContactBuilder.RadiusOfExclusion

Returns the radius of exclusion

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

Getter Method

Signature RadiusOfExclusion

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailBodies

AnalyticalContactBuilder.RailBodies

Returns the rail bodies

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

Getter Method

Signature RailBodies

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailCurve

AnalyticalContactBuilder.RailCurve

Returns the rail curve

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

Getter Method

Signature RailCurve

Returns:
Return type:NXOpen.Section

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailGeometryData

AnalyticalContactBuilder.RailGeometryData

Returns or sets the rail line-arc file option

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

Getter Method

Signature RailGeometryData

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailGeometryData

Parameters:geometryDataOption (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailGeometryDataFile

AnalyticalContactBuilder.RailGeometryDataFile

Returns or sets the rail line-arc file.

This is a file containing information describing the rail profile.

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

Getter Method

Signature RailGeometryDataFile

Returns:
Return type:str

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailGeometryDataFile

Parameters:fileName (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailMaterialSide

AnalyticalContactBuilder.RailMaterialSide

Returns or sets the material side toggle for rail

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

Getter Method

Signature RailMaterialSide

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailMaterialSide

Parameters:matSide (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailRollAngleCurve

AnalyticalContactBuilder.RailRollAngleCurve

Returns or sets the RailRollAngle function

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

Getter Method

Signature RailRollAngleCurve

Returns:
Return type:NXOpen.Motion.MotionFunction

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailRollAngleCurve

Parameters:railCurve (NXOpen.Motion.MotionFunction) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailSplineFunctions

AnalyticalContactBuilder.RailSplineFunctions

Returns or sets the spline function toggle for rail

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

Getter Method

Signature RailSplineFunctions

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailSplineFunctions

Parameters:functionsToggle (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailXCurve

AnalyticalContactBuilder.RailXCurve

Returns or sets the RailX function

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

Getter Method

Signature RailXCurve

Returns:
Return type:NXOpen.Motion.MotionFunction

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailXCurve

Parameters:railCurve (NXOpen.Motion.MotionFunction) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailYCurve

AnalyticalContactBuilder.RailYCurve

Returns or sets the RailY function

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

Getter Method

Signature RailYCurve

Returns:
Return type:NXOpen.Motion.MotionFunction

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailYCurve

Parameters:railCurve (NXOpen.Motion.MotionFunction) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RailZCurve

AnalyticalContactBuilder.RailZCurve

Returns or sets the RailZ function

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

Getter Method

Signature RailZCurve

Returns:
Return type:NXOpen.Motion.MotionFunction

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RailZCurve

Parameters:railCurve (NXOpen.Motion.MotionFunction) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RevolutionBodies

AnalyticalContactBuilder.RevolutionBodies

Returns the revolution bodies

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

Getter Method

Signature RevolutionBodies

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RevolutionGeometryData

AnalyticalContactBuilder.RevolutionGeometryData

Returns or sets the revolution line-arc file option

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

Getter Method

Signature RevolutionGeometryData

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RevolutionGeometryData

Parameters:geometryDataOption (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RevolutionGeometryDataFile

AnalyticalContactBuilder.RevolutionGeometryDataFile

Returns or sets the revolution line-arc file.

This is a file containing information describing the revolution profile.

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

Getter Method

Signature RevolutionGeometryDataFile

Returns:
Return type:str

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RevolutionGeometryDataFile

Parameters:fileName (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RevolutionMaterialSide

AnalyticalContactBuilder.RevolutionMaterialSide

Returns or sets the material side toggle for revolution

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

Getter Method

Signature RevolutionMaterialSide

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature RevolutionMaterialSide

Parameters:matSide (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondRevolutionBodies

AnalyticalContactBuilder.SecondRevolutionBodies

Returns the second revolution bodies

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

Getter Method

Signature SecondRevolutionBodies

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondRevolutionGeometryData

AnalyticalContactBuilder.SecondRevolutionGeometryData

Returns or sets the second revolution line-arc file option

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

Getter Method

Signature SecondRevolutionGeometryData

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SecondRevolutionGeometryData

Parameters:geometryDataOption (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondRevolutionGeometryDataFile

AnalyticalContactBuilder.SecondRevolutionGeometryDataFile

Returns or sets the second revolution line-arc file.

This is a file containing information describing the second revolution profile.

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

Getter Method

Signature SecondRevolutionGeometryDataFile

Returns:
Return type:str

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SecondRevolutionGeometryDataFile

Parameters:fileName (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondRevolutionMaterialSide

AnalyticalContactBuilder.SecondRevolutionMaterialSide

Returns or sets the material side toggle for second revolution

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

Getter Method

Signature SecondRevolutionMaterialSide

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SecondRevolutionMaterialSide

Parameters:matSide (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondSpherePoint

AnalyticalContactBuilder.SecondSpherePoint

Returns or sets the second sphere point

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

Getter Method

Signature SecondSpherePoint

Returns:
Return type:NXOpen.Point

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SecondSpherePoint

Parameters:secondSpherePoint (NXOpen.Point) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondSphereRadius

AnalyticalContactBuilder.SecondSphereRadius

Returns the second sphere radius

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

Getter Method

Signature SecondSphereRadius

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondSuperElementIncrement

AnalyticalContactBuilder.SecondSuperElementIncrement

Returns or sets the second super element increment

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

Getter Method

Signature SecondSuperElementIncrement

Returns:
Return type:int

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SecondSuperElementIncrement

Parameters:sSecondSuperElementIncrement (int) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SpherePoint

AnalyticalContactBuilder.SpherePoint

Returns or sets the sphere point

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

Getter Method

Signature SpherePoint

Returns:
Return type:NXOpen.Point

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SpherePoint

Parameters:spherePoint (NXOpen.Point) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SphereRadius

AnalyticalContactBuilder.SphereRadius

Returns the sphere radius

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

Getter Method

Signature SphereRadius

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SuperElementReportInstance

AnalyticalContactBuilder.SuperElementReportInstance

Returns or sets the super element report instance

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

Getter Method

Signature SuperElementReportInstance

Returns:
Return type:int

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SuperElementReportInstance

Parameters:superElementReportInstance (int) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

Validate

AnalyticalContactBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.