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

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

Inheritance diagram for NXOpen::Mechatronics::MotionProfileBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MasterValueUnit { MasterValueUnitLinear, MasterValueUnitRotary, MasterValueUnitTime }
 the Master Unit types More...
 
enum  ProfileCyclicType { ProfileCyclicTypeRelativeCyclic, ProfileCyclicTypeCyclic, ProfileCyclicTypeNonCyclic }
 Indicates which cyclic type should be take.The type of Cam Profile can be switched between non-cyclic, cyclic and relative cyclic. More...
 
enum  SlaveValueUnit { SlaveValueUnitLinearPosition, SlaveValueUnitRotaryPosition, SlaveValueUnitLinearSpeed, SlaveValueUnitRotarySpeed }
 the Slave Unit types More...
 

Public Member Functions

void AddElement (NXOpen::NXObject *part, const NXString &name, double masterPos, double slavePos, double vin, double vout, double ain, double aout, bool vinEqVout, bool ainEqAout, bool constantSpeed)
 Add element to builder. More...
 
void AddElement (NXOpen::NXObject *part, const char *name, double masterPos, double slavePos, double vin, double vout, double ain, double aout, bool vinEqVout, bool ainEqAout, bool constantSpeed)
 Add element to builder. More...
 
NXOpen::Mechatronics::MotionProfileBuilder::ProfileCyclicType CyclicType ()
 Returns the cyclic type of a cam profile
Created in NX9.0.0. More...
 
bool IsForElecCam ()
 Returns the indicator that a motion profile is designed for a electronic cam
Created in NX9.0.0. More...
 
NXOpen::ExpressionMasterMaximum ()
 Returns the masterMax. More...
 
NXOpen::ExpressionMasterMinimum ()
 Returns the masterMin. More...
 
NXOpen::Mechatronics::MotionProfileBuilder::MasterValueUnit MasterUnit ()
 Returns the masterUnit. More...
 
NXString Name ()
 Returns the name
Created in NX7.5.1. More...
 
void SetCyclicType (NXOpen::Mechatronics::MotionProfileBuilder::ProfileCyclicType cyclicType)
 Sets the cyclic type of a cam profile
Created in NX9.0.0. More...
 
void SetForElecCam (bool isForElecCam)
 Sets the indicator that a motion profile is designed for a electronic cam
Created in NX9.0.0. More...
 
void SetMasterUnit (NXOpen::Mechatronics::MotionProfileBuilder::MasterValueUnit masterUnit)
 Sets the masterUnit. More...
 
void SetName (const NXString &name)
 Sets the name
Created in NX7.5.1. More...
 
void SetName (const char *name)
 Sets the name
Created in NX7.5.1. More...
 
void SetSlaveUnit (NXOpen::Mechatronics::MotionProfileBuilder::SlaveValueUnit slaveUnit)
 Sets the slaveUnit. More...
 
NXOpen::ExpressionSlaveMaximum ()
 Returns the slaveMax. More...
 
NXOpen::ExpressionSlaveMinimum ()
 Returns the slaveMin. More...
 
NXOpen::Mechatronics::MotionProfileBuilder::SlaveValueUnit SlaveUnit ()
 Returns the slaveUnit. 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::MotionProfile builder.


To create a new instance of this class, use NXOpen::Mechatronics::MotionProfileCollection::CreateMotionProfileBuilder

Created in NX7.5.1.

Member Enumeration Documentation

the Master Unit types

Enumerator
MasterValueUnitLinear 

Linear.

MasterValueUnitRotary 

Rotary.

MasterValueUnitTime 

Time.

Indicates which cyclic type should be take.The type of Cam Profile can be switched between non-cyclic, cyclic and relative cyclic.

Enumerator
ProfileCyclicTypeRelativeCyclic 

Relative Cyclic.

ProfileCyclicTypeCyclic 

Cyclic.

ProfileCyclicTypeNonCyclic 

Non-cyclic.

the Slave Unit types

Enumerator
SlaveValueUnitLinearPosition 

Linear Position.

SlaveValueUnitRotaryPosition 

Rotary Position.

SlaveValueUnitLinearSpeed 

Linear Speed.

SlaveValueUnitRotarySpeed 

Rotary Speed.

Member Function Documentation

void NXOpen::Mechatronics::MotionProfileBuilder::AddElement ( NXOpen::NXObject part,
const NXString name,
double  masterPos,
double  slavePos,
double  vin,
double  vout,
double  ain,
double  aout,
bool  vinEqVout,
bool  ainEqAout,
bool  constantSpeed 
)

Add element to builder.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
partpart
namename
masterPosmasterpos
slavePosslavepos
vinvin
voutvout
ainain
aoutaout
vinEqVoutvineqvout
ainEqAoutaineqaout
constantSpeedconstantspeed
void NXOpen::Mechatronics::MotionProfileBuilder::AddElement ( NXOpen::NXObject part,
const char *  name,
double  masterPos,
double  slavePos,
double  vin,
double  vout,
double  ain,
double  aout,
bool  vinEqVout,
bool  ainEqAout,
bool  constantSpeed 
)

Add element to builder.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
partpart
namename
masterPosmasterpos
slavePosslavepos
vinvin
voutvout
ainain
aoutaout
vinEqVoutvineqvout
ainEqAoutaineqaout
constantSpeedconstantspeed
NXOpen::Mechatronics::MotionProfileBuilder::ProfileCyclicType NXOpen::Mechatronics::MotionProfileBuilder::CyclicType ( )

Returns the cyclic type of a cam profile
Created in NX9.0.0.



License requirements : None

bool NXOpen::Mechatronics::MotionProfileBuilder::IsForElecCam ( )

Returns the indicator that a motion profile is designed for a electronic cam
Created in NX9.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Mechatronics::MotionProfileBuilder::MasterMaximum ( )

Returns the masterMax.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::MotionProfileBuilder::MasterMinimum ( )

Returns the masterMin.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::MotionProfileBuilder::MasterValueUnit NXOpen::Mechatronics::MotionProfileBuilder::MasterUnit ( )

Returns the masterUnit.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::MotionProfileBuilder::Name ( )

Returns the name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::MotionProfileBuilder::SetCyclicType ( NXOpen::Mechatronics::MotionProfileBuilder::ProfileCyclicType  cyclicType)

Sets the cyclic type of a cam profile
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
cyclicTypecyclictype
void NXOpen::Mechatronics::MotionProfileBuilder::SetForElecCam ( bool  isForElecCam)

Sets the indicator that a motion profile is designed for a electronic cam
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
isForElecCamisforeleccam
void NXOpen::Mechatronics::MotionProfileBuilder::SetMasterUnit ( NXOpen::Mechatronics::MotionProfileBuilder::MasterValueUnit  masterUnit)

Sets the masterUnit.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
masterUnitmasterunit
void NXOpen::Mechatronics::MotionProfileBuilder::SetName ( const NXString name)

Sets the name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::MotionProfileBuilder::SetName ( const char *  name)

Sets the name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::MotionProfileBuilder::SetSlaveUnit ( NXOpen::Mechatronics::MotionProfileBuilder::SlaveValueUnit  slaveUnit)

Sets the slaveUnit.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
slaveUnitslaveunit
NXOpen::Expression* NXOpen::Mechatronics::MotionProfileBuilder::SlaveMaximum ( )

Returns the slaveMax.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::MotionProfileBuilder::SlaveMinimum ( )

Returns the slaveMin.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::MotionProfileBuilder::SlaveValueUnit NXOpen::Mechatronics::MotionProfileBuilder::SlaveUnit ( )

Returns the slaveUnit.


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.