Represents a NXOpen::Motion::SegmentBuilder , only creation is supported
To create a new instance of this class, use NXOpen::Motion::RoadBuilder::CreateSegmentBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::Motion::SegmentBuilder:

Public Types
enum	SplineDatatypeChoices { SplineDatatypeChoicesFunction, SplineDatatypeChoicesProfile2D }
	data type attribute of the straight data More...

enum	StraightTransitionTypeChoices { StraightTransitionTypeChoicesLinear, StraightTransitionTypeChoicesCubic }
	data type attribute of the straight data More...

enum	TypeChoices { TypeChoicesStraight, TypeChoicesConstantRadius, TypeChoicesLaneChange, TypeChoicesSlalom, TypeChoicesUserDefined }
	type attribute of the segment More...

Public Member Functions
NXOpen::Expression *	Angle ()
	Returns the angle of a constant radius segment Created in NX11.0.0. More...

NXOpen::Motion::MotionFunction *	BankAngleCurve ()
	Returns the bank angle spline curve of a user defined segment Created in NX11.0.0. More...

NXOpen::Motion::SelectFieldData *	BankAngleCurveProfile ()
	Returns the bank angle spline curve defined by a profile for the user defined road segment object Created in NX12.0.0. More...

NXOpen::Expression *	ConstantRadiusBankAngle ()
	Returns the bank angle of a constant radius segment Created in NX11.0.0. More...

NXOpen::Expression *	ConstantRadiusElevationChange ()
	Returns the elevation change of a constant radius segment Created in NX11.0.0. More...

NXOpen::Expression *	LaneChangeElevationChange ()
	Returns the elevation change of a lane change segment Created in NX11.0.0. More...

NXOpen::Expression *	LaneChangeForwardLength ()
	Returns the forward length of a lane change segment Created in NX11.0.0. More...

NXOpen::Expression *	LateralAmplitude ()
	Returns the lateral amplitude of a slalom segment Created in NX11.0.0. More...

NXOpen::Expression *	LateralShiftLength ()
	Returns the lateral shift length of a lane change segment Created in NX11.0.0. More...

NXOpen::Expression *	Length ()
	Returns the length of a straight segment Created in NX11.0.0. More...

NXString	Name ()
	Returns the name Created in NX11.0.0. More...

NXOpen::Expression *	NumberOfPylons ()
	Returns the number of pylons of a slalom segment Created in NX11.0.0. More...

NXOpen::Expression *	Radius ()
	Returns the radius of a constant radius segment Created in NX11.0.0. More...

NXOpen::Motion::SegmentBuilder::TypeChoices	SegmentType ()
	Returns the segment type of a road segment Created in NX11.0.0. More...

void	SetBankAngleCurve (NXOpen::Motion::MotionFunction *spline)
	Sets the bank angle spline curve of a user defined segment Created in NX11.0.0. More...

void	SetName (const NXString &name)
	Sets the name Created in NX11.0.0. More...

void	SetName (const char *name)
	Sets the name Created in NX11.0.0. More...

void	SetSegmentType (NXOpen::Motion::SegmentBuilder::TypeChoices segmentType)
	Sets the segment type of a road segment Created in NX11.0.0. More...

void	SetSplineType (NXOpen::Motion::SegmentBuilder::SplineDatatypeChoices splineType)
	Sets the spline type Created in NX12.0.0. More...

void	SetTransitionType (NXOpen::Motion::SegmentBuilder::StraightTransitionTypeChoices segmentType)
	Sets the transition type of a straight segment Created in NX11.0.0. More...

void	SetYCurve (NXOpen::Motion::MotionFunction *spline)
	Sets the y spline curve of a user defined segment Created in NX11.0.0. More...

void	SetZCurve (NXOpen::Motion::MotionFunction *spline)
	Sets the z spline curve of a user defined segment Created in NX11.0.0. More...

NXOpen::Expression *	SlalomElevationChange ()
	Returns the elevation change of a slalom segment Created in NX11.0.0. More...

NXOpen::Expression *	SlalomForwardLength ()
	Returns the forward length of a slalom segment Created in NX11.0.0. More...

NXOpen::Motion::SegmentBuilder::SplineDatatypeChoices	SplineType ()
	Returns the spline type Created in NX12.0.0. More...

NXOpen::Expression *	StraightElevationChange ()
	Returns the elevation change of a straight segment Created in NX11.0.0. More...

NXOpen::Motion::SegmentBuilder::StraightTransitionTypeChoices	TransitionType ()
	Returns the transition type of a straight segment Created in NX11.0.0. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

NXOpen::Motion::MotionFunction *	YCurve ()
	Returns the y spline curve of a user defined segment Created in NX11.0.0. More...

NXOpen::Motion::SelectFieldData *	YCurveProfile ()
	Returns the y spline curve defined by a profile for the user defined road segment object Created in NX12.0.0. More...

NXOpen::Motion::MotionFunction *	ZCurve ()
	Returns the z spline curve of a user defined segment Created in NX11.0.0. More...

NXOpen::Motion::SelectFieldData *	ZCurveProfile ()
	Returns the z spline curve defined by a profile for the user defined road segment object Created in NX12.0.0. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Motion::SegmentBuilder , only creation is supported
To create a new instance of this class, use NXOpen::Motion::RoadBuilder::CreateSegmentBuilder

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::SegmentBuilder::SplineDatatypeChoices

data type attribute of the straight data

Enumerator
SplineDatatypeChoicesFunction	Function.
SplineDatatypeChoicesProfile2D	Profile 2D.

enum NXOpen::Motion::SegmentBuilder::StraightTransitionTypeChoices

data type attribute of the straight data

Enumerator
StraightTransitionTypeChoicesLinear	Linear.
StraightTransitionTypeChoicesCubic	Cubic.

enum NXOpen::Motion::SegmentBuilder::TypeChoices

type attribute of the segment

Enumerator
TypeChoicesStraight	Straight.
TypeChoicesConstantRadius	Constant Radius.
TypeChoicesLaneChange	Lane Change.
TypeChoicesSlalom	Slalom.
TypeChoicesUserDefined	User Defined.

Member Function Documentation

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::Angle ( )

Returns the angle of a constant radius segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MotionFunction* NXOpen::Motion::SegmentBuilder::BankAngleCurve ( )

Returns the bank angle spline curve of a user defined segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::SegmentBuilder::BankAngleCurveProfile ( )

Returns the bank angle spline curve defined by a profile for the user defined road segment object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::ConstantRadiusBankAngle ( )

Returns the bank angle of a constant radius segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::ConstantRadiusElevationChange ( )

Returns the elevation change of a constant radius segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::LaneChangeElevationChange ( )

Returns the elevation change of a lane change segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::LaneChangeForwardLength ( )

Returns the forward length of a lane change segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::LateralAmplitude ( )

Returns the lateral amplitude of a slalom segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::LateralShiftLength ( )

Returns the lateral shift length of a lane change segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::Length ( )

Returns the length of a straight segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::SegmentBuilder::Name ( )

Returns the name
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::NumberOfPylons ( )

Returns the number of pylons of a slalom segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::Radius ( )

Returns the radius of a constant radius segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SegmentBuilder::TypeChoices NXOpen::Motion::SegmentBuilder::SegmentType ( )

Returns the segment type of a road segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::SegmentBuilder::SetBankAngleCurve ( NXOpen::Motion::MotionFunction * spline )

Sets the bank angle spline curve of a user defined segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

spline spline

void NXOpen::Motion::SegmentBuilder::SetName ( const NXString & name )

Sets the name
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::SegmentBuilder::SetName ( const char * name )

Sets the name
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::SegmentBuilder::SetSegmentType ( NXOpen::Motion::SegmentBuilder::TypeChoices segmentType )

Sets the segment type of a road segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

segmentType segmenttype

void NXOpen::Motion::SegmentBuilder::SetSplineType ( NXOpen::Motion::SegmentBuilder::SplineDatatypeChoices splineType )

Sets the spline type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

splineType splinetype

void NXOpen::Motion::SegmentBuilder::SetTransitionType ( NXOpen::Motion::SegmentBuilder::StraightTransitionTypeChoices segmentType )

Sets the transition type of a straight segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

segmentType segmenttype

void NXOpen::Motion::SegmentBuilder::SetYCurve ( NXOpen::Motion::MotionFunction * spline )

Sets the y spline curve of a user defined segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

spline spline

void NXOpen::Motion::SegmentBuilder::SetZCurve ( NXOpen::Motion::MotionFunction * spline )

Sets the z spline curve of a user defined segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

spline spline

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::SlalomElevationChange ( )

Returns the elevation change of a slalom segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::SlalomForwardLength ( )

Returns the forward length of a slalom segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SegmentBuilder::SplineDatatypeChoices NXOpen::Motion::SegmentBuilder::SplineType ( )

Returns the spline type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SegmentBuilder::StraightElevationChange ( )

Returns the elevation change of a straight segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SegmentBuilder::StraightTransitionTypeChoices NXOpen::Motion::SegmentBuilder::TransitionType ( )

Returns the transition type of a straight segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

virtual bool NXOpen::Motion::SegmentBuilder::Validate ( )

virtual

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.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

NXOpen::Motion::MotionFunction* NXOpen::Motion::SegmentBuilder::YCurve ( )

Returns the y spline curve of a user defined segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::SegmentBuilder::YCurveProfile ( )

Returns the y spline curve defined by a profile for the user defined road segment object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MotionFunction* NXOpen::Motion::SegmentBuilder::ZCurve ( )

Returns the z spline curve of a user defined segment
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::SegmentBuilder::ZCurveProfile ( )

Returns the z spline curve defined by a profile for the user defined road segment object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

The documentation for this class was generated from the following file:

Motion_SegmentBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation