NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::PressLineSimulation::UserMotionBuilder Class Reference

Represents a PressLineSimulation::UserMotionBuilder builder
To create a new instance of this class, use NXOpen::PressLineSimulation::ApplicationManager::CreateUserMotionBuilder
Default values. More...

Inheritance diagram for NXOpen::PressLineSimulation::UserMotionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CurveType { CurveTypeCalculate, CurveTypeFromFile }
 The method used to define the motion curve. More...
 
enum  MotionType { MotionTypeLinear, MotionTypeRotary }
 The type of motion to create. More...
 

Public Member Functions

NXString ComponentName ()
 Returns the simulation component name. More...
 
void DeleteCam ()
 To delete the motion. More...
 
NXString Description ()
 Returns the description of the motion. More...
 
bool Disable ()
 Returns the disabled status of the motion. More...
 
void GetMotionCurve (std::vector< double > &curveValues)
 Get the motion curve values if type is set to from file. More...
 
NXOpen::SelectBodyListMotionBodies ()
 Returns the motion bodies. More...
 
NXOpen::PointMotionOrigin ()
 Returns the motion vector origin
Created in NX12.0.0. More...
 
NXOpen::DirectionMotionVector ()
 Returns the motion vector. More...
 
double PressStart ()
 Returns the press start angle. More...
 
double PressStop ()
 Returns the press stop angle. More...
 
double ReturnStart ()
 Returns the return start angle. More...
 
double ReturnStop ()
 Returns the return stop angle. More...
 
void SetComponentName (const NXString &componentName)
 Sets the simulation component name. More...
 
void SetComponentName (const char *componentName)
 Sets the simulation component name. More...
 
void SetDescription (const NXString &description)
 Sets the description of the motion. More...
 
void SetDescription (const char *description)
 Sets the description of the motion. More...
 
void SetDisable (bool disable)
 Sets the disabled status of the motion. More...
 
void SetMotionCurve (const std::vector< double > &curveValues)
 Set the motion curve values if type is set to from file. More...
 
void SetMotionOrigin (NXOpen::Point *motionOrigin)
 Sets the motion vector origin
Created in NX12.0.0. More...
 
void SetMotionVector (NXOpen::Direction *motionVector)
 Sets the motion vector. More...
 
void SetOutOfDate ()
 To set the out of date status of the motion. More...
 
void SetPressStart (double pressStart)
 Sets the press start angle. More...
 
void SetPressStop (double pressStop)
 Sets the press stop angle. More...
 
void SetReturnStart (double returnStart)
 Sets the return start angle. More...
 
void SetReturnStop (double returnStop)
 Sets the return stop angle. More...
 
void SetTypeOfCurve (NXOpen::PressLineSimulation::UserMotionBuilder::CurveType typeOfCurve)
 Sets the method used to define the motion curve. More...
 
void SetTypeOfMotion (NXOpen::PressLineSimulation::UserMotionBuilder::MotionType typeOfMotion)
 Sets the type of motion. More...
 
void SetValuesInitial (double valuesInitial)
 Sets the initial value. More...
 
void SetValuesPeak (double valuesPeak)
 Sets the peak value. More...
 
NXOpen::PressLineSimulation::UserMotionBuilder::CurveType TypeOfCurve ()
 Returns the method used to define the motion curve. More...
 
NXOpen::PressLineSimulation::UserMotionBuilder::MotionType TypeOfMotion ()
 Returns the type of motion. More...
 
double ValuesInitial ()
 Returns the initial value. More...
 
double ValuesPeak ()
 Returns the peak value. 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 PressLineSimulation::UserMotionBuilder builder
To create a new instance of this class, use NXOpen::PressLineSimulation::ApplicationManager::CreateUserMotionBuilder
Default values.

Property Value

Disable

0

PressStart

0

PressStop

0

ReturnStart

0

ReturnStop

0

TypeOfCurve

Calculate

TypeOfMotion

Linear

ValuesInitial

0

ValuesPeak

0


Created in NX12.0.0.

Member Enumeration Documentation

The method used to define the motion curve.

Enumerator
CurveTypeCalculate 

calculate

CurveTypeFromFile 

from file

The type of motion to create.

Enumerator
MotionTypeLinear 

linear

MotionTypeRotary 

rotary

Member Function Documentation

NXString NXOpen::PressLineSimulation::UserMotionBuilder::ComponentName ( )

Returns the simulation component name.


Created in NX12.0.0.

License requirements : None

void NXOpen::PressLineSimulation::UserMotionBuilder::DeleteCam ( )

To delete the motion.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

NXString NXOpen::PressLineSimulation::UserMotionBuilder::Description ( )

Returns the description of the motion.


Created in NX12.0.0.

License requirements : None

bool NXOpen::PressLineSimulation::UserMotionBuilder::Disable ( )

Returns the disabled status of the motion.


Created in NX12.0.0.

License requirements : None

void NXOpen::PressLineSimulation::UserMotionBuilder::GetMotionCurve ( std::vector< double > &  curveValues)

Get the motion curve values if type is set to from file.


Created in NX12.0.0.

License requirements : None

Parameters
curveValuesThe array of motion curve values.
NXOpen::SelectBodyList* NXOpen::PressLineSimulation::UserMotionBuilder::MotionBodies ( )

Returns the motion bodies.


Created in NX12.0.0.

License requirements : None

NXOpen::Point* NXOpen::PressLineSimulation::UserMotionBuilder::MotionOrigin ( )

Returns the motion vector origin
Created in NX12.0.0.



License requirements : None

NXOpen::Direction* NXOpen::PressLineSimulation::UserMotionBuilder::MotionVector ( )

Returns the motion vector.

Defines the direction of motion for linear type and axis of rotation for rotary type.
Created in NX12.0.0.

License requirements : None

double NXOpen::PressLineSimulation::UserMotionBuilder::PressStart ( )

Returns the press start angle.


Created in NX12.0.0.

License requirements : None

double NXOpen::PressLineSimulation::UserMotionBuilder::PressStop ( )

Returns the press stop angle.


Created in NX12.0.0.

License requirements : None

double NXOpen::PressLineSimulation::UserMotionBuilder::ReturnStart ( )

Returns the return start angle.


Created in NX12.0.0.

License requirements : None

double NXOpen::PressLineSimulation::UserMotionBuilder::ReturnStop ( )

Returns the return stop angle.


Created in NX12.0.0.

License requirements : None

void NXOpen::PressLineSimulation::UserMotionBuilder::SetComponentName ( const NXString componentName)

Sets the simulation component name.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
componentNamecomponentname
void NXOpen::PressLineSimulation::UserMotionBuilder::SetComponentName ( const char *  componentName)

Sets the simulation component name.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
componentNamecomponentname
void NXOpen::PressLineSimulation::UserMotionBuilder::SetDescription ( const NXString description)

Sets the description of the motion.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
descriptiondescription
void NXOpen::PressLineSimulation::UserMotionBuilder::SetDescription ( const char *  description)

Sets the description of the motion.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
descriptiondescription
void NXOpen::PressLineSimulation::UserMotionBuilder::SetDisable ( bool  disable)

Sets the disabled status of the motion.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
disabledisable
void NXOpen::PressLineSimulation::UserMotionBuilder::SetMotionCurve ( const std::vector< double > &  curveValues)

Set the motion curve values if type is set to from file.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
curveValuesThe array of motion curve values.
void NXOpen::PressLineSimulation::UserMotionBuilder::SetMotionOrigin ( NXOpen::Point motionOrigin)

Sets the motion vector origin
Created in NX12.0.0.



License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
motionOriginmotionorigin
void NXOpen::PressLineSimulation::UserMotionBuilder::SetMotionVector ( NXOpen::Direction motionVector)

Sets the motion vector.

Defines the direction of motion for linear type and axis of rotation for rotary type.
Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
motionVectormotionvector
void NXOpen::PressLineSimulation::UserMotionBuilder::SetOutOfDate ( )

To set the out of date status of the motion.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

void NXOpen::PressLineSimulation::UserMotionBuilder::SetPressStart ( double  pressStart)

Sets the press start angle.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
pressStartpressstart
void NXOpen::PressLineSimulation::UserMotionBuilder::SetPressStop ( double  pressStop)

Sets the press stop angle.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
pressStoppressstop
void NXOpen::PressLineSimulation::UserMotionBuilder::SetReturnStart ( double  returnStart)

Sets the return start angle.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
returnStartreturnstart
void NXOpen::PressLineSimulation::UserMotionBuilder::SetReturnStop ( double  returnStop)

Sets the return stop angle.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
returnStopreturnstop
void NXOpen::PressLineSimulation::UserMotionBuilder::SetTypeOfCurve ( NXOpen::PressLineSimulation::UserMotionBuilder::CurveType  typeOfCurve)

Sets the method used to define the motion curve.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
typeOfCurvetypeofcurve
void NXOpen::PressLineSimulation::UserMotionBuilder::SetTypeOfMotion ( NXOpen::PressLineSimulation::UserMotionBuilder::MotionType  typeOfMotion)

Sets the type of motion.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
typeOfMotiontypeofmotion
void NXOpen::PressLineSimulation::UserMotionBuilder::SetValuesInitial ( double  valuesInitial)

Sets the initial value.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
valuesInitialvaluesinitial
void NXOpen::PressLineSimulation::UserMotionBuilder::SetValuesPeak ( double  valuesPeak)

Sets the peak value.


Created in NX12.0.0.

License requirements : nx_pls_die_checker (" NX Press Die Checker")

Parameters
valuesPeakvaluespeak
NXOpen::PressLineSimulation::UserMotionBuilder::CurveType NXOpen::PressLineSimulation::UserMotionBuilder::TypeOfCurve ( )

Returns the method used to define the motion curve.


Created in NX12.0.0.

License requirements : None

NXOpen::PressLineSimulation::UserMotionBuilder::MotionType NXOpen::PressLineSimulation::UserMotionBuilder::TypeOfMotion ( )

Returns the type of motion.


Created in NX12.0.0.

License requirements : None

double NXOpen::PressLineSimulation::UserMotionBuilder::ValuesInitial ( )

Returns the initial value.


Created in NX12.0.0.

License requirements : None

double NXOpen::PressLineSimulation::UserMotionBuilder::ValuesPeak ( )

Returns the peak value.


Created in NX12.0.0.

License requirements : None


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