SplineBeamBuilder Class

class NXOpen.Motion.SplineBeamBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a Motion.SplineBeamBuilder builder

To create a new instance of this class, use NXOpen.Motion.SplineBeamCollection.CreateSplineBeamBuilder()

Default values.

Property Value
DefinitionMethod Manual
NumberOfSections.Value 1

New in version NX12.0.0.

Properties

Property Description
Curves Returns the optional curves object
DefinitionMethod Returns or sets the definition method
DisplayScale Returns or sets the icon display scale
GroupName Returns or sets the group name
GroupType Returns or sets the group type
Link Returns the link object
Name Returns or sets the name of the spline beam object
NumberOfSections Returns the number of sections
PointList Returns the list of points
SectionAxis Returns or sets the section orientation axis type
SectionShape Returns the section shape
SectionVector Returns or sets the section orientation vector
StructuralProperty Returns the structural property
Tag Returns the Tag for this object.
Tolerance Returns the tolerance

Methods

Method Description
AssignPoint Assigns a point
Commit Commits any edits that have been applied to the builder.
CreateMarkerToNode Creates a new list item
Destroy Deletes the builder, and cleans up any objects created by the builder.
ExportPointsToFile Exports the points to an external file.
GeneratePoints Generates the points
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetMarkerItems Gets marker to node list Items
GetObject Returns the object currently being edited by this builder.
ImportPointsFromFile Imports the points from an external file.
InsertEmptyPoint Inserts an empty point to a location
RemoveAllMarkers Removes all markers
RemovePoint Removes a point
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
SwapPoints Swaps two points
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

SplineBeamBuilderDefinitionMethodType Enumeration the definition method type
SplineBeamBuilderSectionAxisType Enumeration the definition of the section axis type

Property Detail

Curves

SplineBeamBuilder.Curves

Returns the optional curves object

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

Getter Method

Signature Curves

Returns:
Return type:NXOpen.SelectCurveList

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

DefinitionMethod

SplineBeamBuilder.DefinitionMethod

Returns or sets the definition method

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

Getter Method

Signature DefinitionMethod

Returns:
Return type:NXOpen.Motion.SplineBeamBuilderDefinitionMethodType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature DefinitionMethod

Parameters:type (NXOpen.Motion.SplineBeamBuilderDefinitionMethodType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name

SplineBeamBuilder.Name

Returns or sets the name of the spline beam object

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

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”)

NumberOfSections

SplineBeamBuilder.NumberOfSections

Returns the number of sections

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

Getter Method

Signature NumberOfSections

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

PointList

SplineBeamBuilder.PointList

Returns the list of points

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

Getter Method

Signature PointList

Returns:
Return type:NXOpen.PointList

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SectionAxis

SplineBeamBuilder.SectionAxis

Returns or sets the section orientation axis type

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

Getter Method

Signature SectionAxis

Returns:
Return type:NXOpen.Motion.SplineBeamBuilderSectionAxisType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SectionAxis

Parameters:type (NXOpen.Motion.SplineBeamBuilderSectionAxisType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SectionShape

SplineBeamBuilder.SectionShape

Returns the section shape

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

Getter Method

Signature SectionShape

Returns:
Return type:NXOpen.Motion.SelectBaseSection

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SectionVector

SplineBeamBuilder.SectionVector

Returns or sets the section orientation vector

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

Getter Method

Signature SectionVector

Returns:
Return type:NXOpen.Direction

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SectionVector

Parameters:vector (NXOpen.Direction) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

StructuralProperty

SplineBeamBuilder.StructuralProperty

Returns the structural property

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

Getter Method

Signature StructuralProperty

Returns:
Return type:NXOpen.Motion.SelectSplineBeamProperty

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Tolerance

SplineBeamBuilder.Tolerance

Returns the tolerance

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

Getter Method

Signature Tolerance

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

AssignPoint

SplineBeamBuilder.AssignPoint

Assigns a point

Signature AssignPoint(index, point)

Parameters:

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

CreateMarkerToNode

SplineBeamBuilder.CreateMarkerToNode

Creates a new list item

Signature CreateMarkerToNode(marker, markerPosition, pointID, useClosestNode)

Parameters:
  • marker (NXOpen.NXObject) – The marker tag
  • markerPosition (int) – The i or j marker identity
  • pointID (int) – The point ID
  • useClosestNode (bool) – Whether to move the node
Returns:
Return type:

NXOpen.Motion.MarkerToNodeData

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExportPointsToFile

SplineBeamBuilder.ExportPointsToFile

Exports the points to an external file.

Allowed file types are .txt and Excel files

Signature ExportPointsToFile(filePath)

Parameters:filePath (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

GeneratePoints

SplineBeamBuilder.GeneratePoints

Generates the points

Signature GeneratePoints()

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetMarkerItems

SplineBeamBuilder.GetMarkerItems

Gets marker to node list Items

Signature GetMarkerItems()

Returns:
Return type:list of NXOpen.Motion.MarkerToNodeData

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ImportPointsFromFile

SplineBeamBuilder.ImportPointsFromFile

Imports the points from an external file.

Allowed file types are .txt and Excel files

Signature ImportPointsFromFile(filePath)

Parameters:filePath (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

InsertEmptyPoint

SplineBeamBuilder.InsertEmptyPoint

Inserts an empty point to a location

Signature InsertEmptyPoint(index)

Parameters:index (int) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RemoveAllMarkers

SplineBeamBuilder.RemoveAllMarkers

Removes all markers

Signature RemoveAllMarkers()

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

RemovePoint

SplineBeamBuilder.RemovePoint

Removes a point

Signature RemovePoint(index)

Parameters:index (int) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SwapPoints

SplineBeamBuilder.SwapPoints

Swaps two points

Signature SwapPoints(index1, index2)

Parameters:
  • index1 (int) –
  • index2 (int) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Validate

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