TransportSurfaceBuilder Class

class NXOpen.Mechatronics.TransportSurfaceBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.TransportSurfaceBuilder.

To create a new instance of this class, use NXOpen.Mechatronics.TransportSurfaceCollection.CreateTransportSurfaceBuilder()

New in version NX7.5.1.

Properties

Property	Description
AxisVector	Returns or sets the specify axis vector.
CenterPoint	Returns or sets the center point
Faces	Returns the faces.
Material	Returns or sets the material.
MedianRadius	Returns the median radius.
MedianStartPosition	Returns the median start position.
MedianVelocity	Returns the median velocity.
MotionType	Returns or sets the motion type
Name	Returns or sets the name.
ParallelInitialPosition	Returns the initial position in parallel direction.
ParallelVelocity	Returns the parallel velocity.
PerpendicularInitialPosition	Returns the initial position in perpendicular direction.
PerpendicularVelocity	Returns the perpendicular velocity.
Tag	Returns the Tag for this object.
VelocityVector	Returns or sets the specify vector.

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.
SetFaces	Sets the faces.
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.

Enumerations

TransportSurfaceBuilderMoveType Enumeration

the motion types.

Property Detail

AxisVector

TransportSurfaceBuilder.AxisVector

Returns or sets the specify axis vector.

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

Getter Method

Signature AxisVector

Returns: Return type:NXOpen.Direction

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature AxisVector

Parameters:axisVector (NXOpen.Direction) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CenterPoint

TransportSurfaceBuilder.CenterPoint

Returns or sets the center point

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

Getter Method

Signature CenterPoint

Returns: Return type:NXOpen.Point

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature CenterPoint

Parameters:centerPoint (NXOpen.Point) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Faces

TransportSurfaceBuilder.Faces

Returns the faces.

This can be a NXOpen.Face.

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

Getter Method

Signature Faces

Returns: Return type:NXOpen.SelectFaceList

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Material

TransportSurfaceBuilder.Material

Returns or sets the material.

This can be a NXOpen.Mechatronics.CollisionMaterial.

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

Getter Method

Signature Material

Returns: Return type:NXOpen.Mechatronics.CollisionMaterial

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Material

Parameters:material (NXOpen.Mechatronics.CollisionMaterial) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MedianRadius

TransportSurfaceBuilder.MedianRadius

Returns the median radius.

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

Getter Method

Signature MedianRadius

Returns: Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MedianStartPosition

TransportSurfaceBuilder.MedianStartPosition

Returns the median start position.

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

Getter Method

Signature MedianStartPosition

Returns: Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MedianVelocity

TransportSurfaceBuilder.MedianVelocity

Returns the median velocity.

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

Getter Method

Signature MedianVelocity

Returns: Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MotionType

TransportSurfaceBuilder.MotionType

Returns or sets the motion type

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

Getter Method

Signature MotionType

Returns: Return type:NXOpen.Mechatronics.TransportSurfaceBuilderMoveType

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature MotionType

Parameters:motionType (NXOpen.Mechatronics.TransportSurfaceBuilderMoveType) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Name

TransportSurfaceBuilder.Name

Returns or sets the name.

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ParallelInitialPosition

TransportSurfaceBuilder.ParallelInitialPosition

Returns the initial position in parallel direction.

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

Getter Method

Signature ParallelInitialPosition

Returns: Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ParallelVelocity

TransportSurfaceBuilder.ParallelVelocity

Returns the parallel velocity.

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

Getter Method

Signature ParallelVelocity

Returns: Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PerpendicularInitialPosition

TransportSurfaceBuilder.PerpendicularInitialPosition

Returns the initial position in perpendicular direction.

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

Getter Method

Signature PerpendicularInitialPosition

Returns: Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PerpendicularVelocity

TransportSurfaceBuilder.PerpendicularVelocity

Returns the perpendicular velocity.

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

Getter Method

Signature PerpendicularVelocity

Returns: Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

VelocityVector

TransportSurfaceBuilder.VelocityVector

Returns or sets the specify vector.

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

Getter Method

Signature VelocityVector

Returns: Return type:NXOpen.Direction

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature VelocityVector

Parameters:velocityVector (NXOpen.Direction) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

SetFaces

TransportSurfaceBuilder.SetFaces

Sets the faces.

Signature SetFaces(faces)

Parameters:faces (list of NXOpen.NXObject) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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