Represents a Motion::DiscreteDrivetrainLayout builder. More...

Inheritance diagram for NXOpen::Motion::DiscreteDrivetrainLayoutBuilder:

Public Types
enum	LayoutTypeOption { LayoutTypeOptionSprocket, LayoutTypeOptionWheel, LayoutTypeOptionGuide, LayoutTypeOptionVibrationDamper }
	Discrete drivetrain layout type. More...

enum	PathSideOption { PathSideOptionInside, PathSideOptionOutside }
	Discrete drivetrain path side option. More...

enum	TensionerTypeOption { TensionerTypeOptionPivot, TensionerTypeOptionSlider }
	Discrete drivetrain tensioner type. More...

Public Member Functions
bool	AddTensioner ()
	Returns the add tensioner flag. More...

NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::LayoutTypeOption	LayoutType ()
	Returns the type of discrete drivetrain layout element. More...

NXOpen::Motion::SelectLink *	MotionBody ()
	Returns the discrete drivetrain layout motion body. More...

NXString	Name ()
	Returns the discrete drivetrain layout name. More...

NXOpen::Expression *	NumTeeth ()
	Returns the number of teeth there are on the discrete drivetrain sprocket. More...

NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::PathSideOption	PathSide ()
	Returns the side of discrete drivetrain layout element is located on. More...

NXOpen::Point *	PivotPoint ()
	Returns the selection of pivot point. More...

void	SetAddTensioner (bool addTensioner)
	Sets the add tensioner flag. More...

void	SetLayoutType (NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::LayoutTypeOption layoutType)
	Sets the type of discrete drivetrain layout element. More...

void	SetName (const NXString &name)
	Sets the discrete drivetrain layout name. More...

void	SetName (const char *name)
	Sets the discrete drivetrain layout name. More...

void	SetPathSide (NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::PathSideOption pathSide)
	Sets the side of discrete drivetrain layout element is located on. More...

void	SetPivotPoint (NXOpen::Point *pivotPoint)
	Sets the selection of pivot point. More...

void	SetSliderDirection (NXOpen::Direction *sliderDirection)
	Sets the selection of slider direction. More...

void	SetTensionerType (NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::TensionerTypeOption tensionerType)
	Sets the type of tensioner. More...

NXOpen::SelectNXObject *	Sketch ()
	Returns the discrete drivetrain layout sketch. More...

NXOpen::Direction *	SliderDirection ()
	Returns the selection of slider direction. More...

NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::TensionerTypeOption	TensionerType ()
	Returns the type of tensioner. More...

Public Member Functions inherited from NXOpen::Motion::MotionBuilder
double	DisplayScale ()
	Returns the icon display scale Created in NX5.0.0. More...

NXString	GroupName ()
	Returns the group name Created in NX5.0.0. More...

NXOpen::Motion::MotionObject::GroupType	GroupType ()
	Returns the group type Created in NX5.0.0. More...

void	SetDisplayScale (double displayScale)
	Sets the icon display scale Created in NX5.0.0. More...

void	SetGroupName (const NXString &groupName)
	Sets the group name Created in NX5.0.0. More...

void	SetGroupName (const char *groupName)
	Sets the group name Created in NX5.0.0. More...

void	SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType)
	Sets the group type Created in NX5.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

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

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

Detailed Description

Represents a Motion::DiscreteDrivetrainLayout builder.

To create a new instance of this class, use NXOpen::Motion::DiscreteDrivetrainBuilder::CreateDiscreteDrivetrainLayoutBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::LayoutTypeOption

Discrete drivetrain layout type.

Enumerator
LayoutTypeOptionSprocket	sprocket
LayoutTypeOptionWheel	wheel
LayoutTypeOptionGuide	guide
LayoutTypeOptionVibrationDamper	vibration damper

enum NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::PathSideOption

Discrete drivetrain path side option.

Enumerator
PathSideOptionInside	inside
PathSideOptionOutside	outside

enum NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::TensionerTypeOption

Discrete drivetrain tensioner type.

Enumerator
TensionerTypeOptionPivot	pivot
TensionerTypeOptionSlider	slider

Member Function Documentation

bool NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::AddTensioner ( )

Returns the add tensioner flag.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::LayoutTypeOption NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::LayoutType ( )

Returns the type of discrete drivetrain layout element.

Sprocket is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectLink* NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::MotionBody ( )

Returns the discrete drivetrain layout motion body.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::Name ( )

Returns the discrete drivetrain layout name.

Must be unique across all motion elements.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::NumTeeth ( )

Returns the number of teeth there are on the discrete drivetrain sprocket.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::PathSideOption NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::PathSide ( )

Returns the side of discrete drivetrain layout element is located on.

Inside is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Point* NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::PivotPoint ( )

Returns the selection of pivot point.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::SetAddTensioner ( bool addTensioner )

Sets the add tensioner flag.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

addTensioner addtensioner

void NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::SetLayoutType ( NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::LayoutTypeOption layoutType )

Sets the type of discrete drivetrain layout element.

Sprocket is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

layoutType layouttype

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

Sets the discrete drivetrain layout name.

Must be unique across all motion elements.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

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

Sets the discrete drivetrain layout name.

Must be unique across all motion elements.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::SetPathSide ( NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::PathSideOption pathSide )

Sets the side of discrete drivetrain layout element is located on.

Inside is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

pathSide pathside

void NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::SetPivotPoint ( NXOpen::Point * pivotPoint )

Sets the selection of pivot point.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

pivotPoint pivotpoint

void NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::SetSliderDirection ( NXOpen::Direction * sliderDirection )

Sets the selection of slider direction.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

sliderDirection sliderdirection

void NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::SetTensionerType ( NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::TensionerTypeOption tensionerType )

Sets the type of tensioner.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

tensionerType tensionertype

NXOpen::SelectNXObject* NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::Sketch ( )

Returns the discrete drivetrain layout sketch.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Direction* NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::SliderDirection ( )

Returns the selection of slider direction.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::TensionerTypeOption NXOpen::Motion::DiscreteDrivetrainLayoutBuilder::TensionerType ( )

Returns the type of tensioner.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Motion_DiscreteDrivetrainLayoutBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation