SegmentBuilder Class¶

class NXOpen.Motion.SegmentBuilder¶

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Motion.SegmentBuilder, only creation is supported

To create a new instance of this class, use NXOpen.Motion.RoadBuilder.CreateSegmentBuilder()

New in version NX11.0.0.

Properties¶

Property	Description
Angle	Returns the angle of a constant radius segment
BankAngleCurve	Returns or sets the bank angle spline curve of a user defined segment
ConstantRadiusBankAngle	Returns the bank angle of a constant radius segment
ConstantRadiusElevationChange	Returns the elevation change of a constant radius segment
LaneChangeElevationChange	Returns the elevation change of a lane change segment
LaneChangeForwardLength	Returns the forward length of a lane change segment
LateralAmplitude	Returns the lateral amplitude of a slalom segment
LateralShiftLength	Returns the lateral shift length of a lane change segment
Length	Returns the length of a straight segment
Name	Returns or sets the name
NumberOfPylons	Returns the number of pylons of a slalom segment
Radius	Returns the radius of a constant radius segment
SegmentType	Returns or sets the segment type of a road segment
SlalomElevationChange	Returns the elevation change of a slalom segment
SlalomForwardLength	Returns the forward length of a slalom segment
StraightElevationChange	Returns the elevation change of a straight segment
Tag	Returns the Tag for this object.
TransitionType	Returns or sets the transition type of a straight segment
YCurve	Returns or sets the y spline curve of a user defined segment
ZCurve	Returns or sets the z spline curve of a user defined segment

Methods¶

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

Enumerations¶

SegmentBuilderStraightTransitionTypeChoices Enumeration	data type attribute of the straight data
SegmentBuilderTypeChoices Enumeration	type attribute of the segment

Property Detail¶

Angle¶

SegmentBuilder.Angle¶

Returns the angle of a constant radius segment

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

Getter Method

Signature Angle()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

BankAngleCurve¶

SegmentBuilder.BankAngleCurve¶

Returns or sets the bank angle spline curve of a user defined segment

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

Getter Method

Signature BankAngleCurve()

Returns:
Return type:	`NXOpen.Motion.MotionFunction`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature BankAngleCurve(spline)

Parameters:	spline (`NXOpen.Motion.MotionFunction`) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ConstantRadiusBankAngle¶

SegmentBuilder.ConstantRadiusBankAngle¶

Returns the bank angle of a constant radius segment

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

Getter Method

Signature ConstantRadiusBankAngle()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ConstantRadiusElevationChange¶

SegmentBuilder.ConstantRadiusElevationChange¶

Returns the elevation change of a constant radius segment

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

Getter Method

Signature ConstantRadiusElevationChange()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

LaneChangeElevationChange¶

SegmentBuilder.LaneChangeElevationChange¶

Returns the elevation change of a lane change segment

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

Getter Method

Signature LaneChangeElevationChange()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

LaneChangeForwardLength¶

SegmentBuilder.LaneChangeForwardLength¶

Returns the forward length of a lane change segment

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

Getter Method

Signature LaneChangeForwardLength()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

LateralAmplitude¶

SegmentBuilder.LateralAmplitude¶

Returns the lateral amplitude of a slalom segment

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

Getter Method

Signature LateralAmplitude()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

LateralShiftLength¶

SegmentBuilder.LateralShiftLength¶

Returns the lateral shift length of a lane change segment

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

Getter Method

Signature LateralShiftLength()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Length¶

SegmentBuilder.Length¶

Returns the length of a straight segment

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

Getter Method

Signature Length()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name¶

SegmentBuilder.Name¶

Returns or sets the name

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

Getter Method

Signature Name()

Returns:
Return type:	str

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature Name(name)

Parameters:	name (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

NumberOfPylons¶

SegmentBuilder.NumberOfPylons¶

Returns the number of pylons of a slalom segment

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

Getter Method

Signature NumberOfPylons()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Radius¶

SegmentBuilder.Radius¶

Returns the radius of a constant radius segment

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

Getter Method

Signature Radius()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

SegmentType¶

SegmentBuilder.SegmentType¶

Returns or sets the segment type of a road segment

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

Getter Method

Signature SegmentType()

Returns:
Return type:	`NXOpen.Motion.SegmentBuilderTypeChoices`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature SegmentType(segmentType)

Parameters:	segmentType (`NXOpen.Motion.SegmentBuilderTypeChoices`) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

SlalomElevationChange¶

SegmentBuilder.SlalomElevationChange¶

Returns the elevation change of a slalom segment

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

Getter Method

Signature SlalomElevationChange()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

SlalomForwardLength¶

SegmentBuilder.SlalomForwardLength¶

Returns the forward length of a slalom segment

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

Getter Method

Signature SlalomForwardLength()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

StraightElevationChange¶

SegmentBuilder.StraightElevationChange¶

Returns the elevation change of a straight segment

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

Getter Method

Signature StraightElevationChange()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

TransitionType¶

SegmentBuilder.TransitionType¶

Returns or sets the transition type of a straight segment

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

Getter Method

Signature TransitionType()

Returns:
Return type:	`NXOpen.Motion.SegmentBuilderStraightTransitionTypeChoices`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature TransitionType(segmentType)

Parameters:	segmentType (`NXOpen.Motion.SegmentBuilderStraightTransitionTypeChoices`) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

YCurve¶

SegmentBuilder.YCurve¶

Returns or sets the y spline curve of a user defined segment

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

Getter Method

Signature YCurve()

Returns:
Return type:	`NXOpen.Motion.MotionFunction`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature YCurve(spline)

Parameters:	spline (`NXOpen.Motion.MotionFunction`) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ZCurve¶

SegmentBuilder.ZCurve¶

Returns or sets the z spline curve of a user defined segment

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

Getter Method

Signature ZCurve()

Returns:
Return type:	`NXOpen.Motion.MotionFunction`

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ZCurve(spline)

Parameters:	spline (`NXOpen.Motion.MotionFunction`) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail¶

Validate¶

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