NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Mechatronics::GearBuilder Class Reference

Represents a NXOpen::Mechatronics::Gear builder. More...

Inheritance diagram for NXOpen::Mechatronics::GearBuilder:
NXOpen::Mechatronics::CouplingBuilder NXOpen::Mechatronics::PhysicsConstraintBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AxisJointType { AxisJointTypeLinear, AxisJointTypeAngular }
 the axis joint types. More...
 

Public Member Functions

NXOpen::Mechatronics::GearBuilder::AxisJointType AxisType ()
 Returns the axis joint type. More...
 
NXOpen::ExpressionExpressionMasterMultiple ()
 Returns the master multiple expression. More...
 
NXOpen::ExpressionExpressionSlaveMultiple ()
 Returns the slave multiple expression. More...
 
double MasterMultiple ()
 Returns the master multiple. More...
 
void SetAxisType (NXOpen::Mechatronics::GearBuilder::AxisJointType axisType)
 Sets the axis joint type. More...
 
void SetMasterMultiple (double masterMultiple)
 Sets the master multiple. More...
 
void SetSlaveMultiple (double slaveMultiple)
 Sets the slave multiple. More...
 
double SlaveMultiple ()
 Returns the slave multiple. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::CouplingBuilder
bool AllowSlip ()
 Returns the coulping can slip or not. More...
 
NXOpen::Mechatronics::SelectPhysicsJointMasterAxisJoint ()
 Returns the master axis joint. More...
 
void SetAllowSlip (bool allowSlip)
 Sets the coulping can slip or not. More...
 
void SetMasterAxisJoint (NXOpen::Mechatronics::PhysicsJoint *master)
 Sets the master axis. More...
 
void SetSlaveAxisJoint (NXOpen::Mechatronics::PhysicsJoint *slave)
 Sets the slave axis. More...
 
NXOpen::Mechatronics::SelectPhysicsJointSlaveAxisJoint ()
 Returns the slave axis joint. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::PhysicsConstraintBuilder
NXString Name ()
 Returns the name. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 NXOpen::Mechatronics::Gear builder.


To create a new instance of this class, use NXOpen::Mechatronics::GearCollection::CreateGearBuilder

Created in NX7.5.1.

Member Enumeration Documentation

the axis joint types.

Enumerator
AxisJointTypeLinear 

Linear.

AxisJointTypeAngular 

Angular.

Member Function Documentation

NXOpen::Mechatronics::GearBuilder::AxisJointType NXOpen::Mechatronics::GearBuilder::AxisType ( )

Returns the axis joint type.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::GearBuilder::ExpressionMasterMultiple ( )

Returns the master multiple expression.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::GearBuilder::ExpressionSlaveMultiple ( )

Returns the slave multiple expression.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

double NXOpen::Mechatronics::GearBuilder::MasterMultiple ( )

Returns the master multiple.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::GearBuilder::SetAxisType ( NXOpen::Mechatronics::GearBuilder::AxisJointType  axisType)

Sets the axis joint type.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
axisTypeaxistype
void NXOpen::Mechatronics::GearBuilder::SetMasterMultiple ( double  masterMultiple)

Sets the master multiple.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
masterMultiplemastermultiple
void NXOpen::Mechatronics::GearBuilder::SetSlaveMultiple ( double  slaveMultiple)

Sets the slave multiple.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
slaveMultipleslavemultiple
double NXOpen::Mechatronics::GearBuilder::SlaveMultiple ( )

Returns the slave multiple.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.