NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::Motion::GraphBuilder Class Reference

Represents a Motion::GraphBuilder , only creation is supported
To create a new instance of this class, use Motion::GraphManager::CreateGraphBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::Motion::GraphBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Classes

struct  CurveData
 Contains the structure of curve associated with curve data. More...

Public Types

enum  ComponentChoices {
  ComponentChoicesMag, ComponentChoicesX, ComponentChoicesY, ComponentChoicesZ,
  ComponentChoicesAmag, ComponentChoicesXy, ComponentChoicesYz, ComponentChoicesZx,
  ComponentChoicesInputVoltage, ComponentChoicesElectricCurrent, ComponentChoicesElectricTorque, ComponentChoicesSignalChart
}
 Component attribute of the curve data. More...
enum  CsysChoices { CsysChoicesRelative, CsysChoicesAbsolute }
 Csys attribute of the curve data. More...
enum  PlotStyleChoices { PlotStyleChoicesFtk, PlotStyleChoicesSpreadsheet }
 Plot output type. More...
enum  RequestChoices {
  RequestChoicesDisplacement, RequestChoicesVelocity, RequestChoicesAcceleration, RequestChoicesForce,
  RequestChoicesMotorDriver
}
 Request attribute of the curve data. More...
enum  XAxisTypeChoices { XAxisTypeChoicesDefaultTime, XAxisTypeChoicesUserDefined }
 X axis type choice. More...

Public Member Functions

void AddYCurves (const std::vector< NXOpen::Motion::GraphBuilder::CurveData > &curves)
 Add curves to the end of y curve list
Created in NX5.0.0.
NXString AfuFile ()
 Returns the afu file name
Created in NX5.0.0.
NXOpen::Motion::GraphBuilder::ComponentChoices Component ()
 Returns the component
Created in NX5.0.0.
NXOpen::Motion::GraphBuilder::CsysChoices CoordinateSystemType ()
 Returns the csystype
Created in NX5.0.0.
std::vector< NXOpen::NXObject * > GetMotionObjects ()
 Get the motion objects.
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
std::vector
< NXOpen::Motion::GraphBuilder::CurveData
GetYCurves ()
 Get the defined y curves.
NXString GraphTitle ()
 Returns the graph title
Created in NX5.0.0.
int Mode ()
 Returns the mode id
Created in NX8.0.0.
NXOpen::Motion::GraphBuilder::RequestChoices ModeRequest ()
 Returns the mode request
Created in NX8.0.0.
void MoveDownYCurves (const std::vector< int > &selectedIndices)
 Move down the curves in the y curve list by one step
Created in NX5.0.0.
void MoveUpYCurves (const std::vector< int > &selectedIndices)
 Move up the curves in the y curve list by one step
Created in NX5.0.0.
NXOpen::NXObjectObject ()
 Returns the object selected from motion objects
Created in NX5.0.0.
bool PlotEnable ()
 Returns the plot enable flag
Created in NX5.0.0.
NXOpen::Motion::GraphBuilder::PlotStyleChoices PlotStyle ()
 Returns the plot style choice
Created in NX5.0.0.
void RemoveYCurve (const NXOpen::Motion::GraphBuilder::CurveData &yCurve)
 Remove the curve from the y curve list
Created in NX5.0.0.
NXOpen::Motion::GraphBuilder::RequestChoices Request ()
 Returns the request
Created in NX5.0.0.
void SetAfuFile (const NXString &fileName)
 Sets the afu file name
Created in NX5.0.0.
void SetComponent (NXOpen::Motion::GraphBuilder::ComponentChoices component)
 Sets the component
Created in NX5.0.0.
void SetCoordinateSystemType (NXOpen::Motion::GraphBuilder::CsysChoices coordinateSystemType)
 Sets the csystype
Created in NX5.0.0.
void SetGraphTitle (const NXString &graphTitle)
 Sets the graph title
Created in NX5.0.0.
void SetMode (int modeID)
 Sets the mode id
Created in NX8.0.0.
void SetModeRequest (NXOpen::Motion::GraphBuilder::RequestChoices modeRequest)
 Sets the mode request
Created in NX8.0.0.
void SetMotionObjects (const std::vector< NXOpen::NXObject * > &motionObjects)
 Set the motion objects
Created in NX5.0.0.
void SetObject (NXOpen::NXObject *object)
 Sets the object selected from motion objects
Created in NX5.0.0.
void SetPlotEnable (bool plotEnable)
 Sets the plot enable flag
Created in NX5.0.0.
void SetPlotStyle (NXOpen::Motion::GraphBuilder::PlotStyleChoices plotStyle)
 Sets the plot style choice
Created in NX5.0.0.
void SetRequest (NXOpen::Motion::GraphBuilder::RequestChoices request)
 Sets the request
Created in NX5.0.0.
void SetStoreEnable (bool storeEnable)
 Sets the store enable flag
Created in NX5.0.0.
void SetXAxisType (NXOpen::Motion::GraphBuilder::XAxisTypeChoices xAxisType)
 Sets the x axis type
Created in NX5.0.0.
void SetXCurve (const NXOpen::Motion::GraphBuilder::CurveData &newCurve)
 Set x curve
Created in NX5.0.0.
bool StoreEnable ()
 Returns the store enable flag
Created in NX5.0.0.
NXOpen::Motion::GraphBuilder::XAxisTypeChoices XAxisType ()
 Returns the x axis type
Created in NX5.0.0.
NXOpen::Motion::GraphBuilder::CurveData XCurve ()
 Returns the x curve
Created in NX5.0.0.

Detailed Description

Represents a Motion::GraphBuilder , only creation is supported
To create a new instance of this class, use Motion::GraphManager::CreateGraphBuilder

Created in NX5.0.0.



Member Enumeration Documentation

Component attribute of the curve data.

Enumerator:
ComponentChoicesMag 

Magnitude.

ComponentChoicesX 

X.

ComponentChoicesY 

Y.

ComponentChoicesZ 

Z.

ComponentChoicesAmag 

Angular Magnitude.

ComponentChoicesXy 

XY.

ComponentChoicesYz 

YZ.

ComponentChoicesZx 

ZX.

ComponentChoicesInputVoltage 

Input Voltage.

ComponentChoicesElectricCurrent 

Electric Current.

ComponentChoicesElectricTorque 

Electric Torque.

ComponentChoicesSignalChart 

Signal Chart.

Csys attribute of the curve data.

Enumerator:
CsysChoicesRelative 

Relative.

CsysChoicesAbsolute 

Absolute.

Plot output type.

Enumerator:
PlotStyleChoicesFtk 

To FTK.

PlotStyleChoicesSpreadsheet 

To Spreadsheet.

Request attribute of the curve data.

Enumerator:
RequestChoicesDisplacement 

Displacement.

RequestChoicesVelocity 

Velocity.

RequestChoicesAcceleration 

Acceleration.

RequestChoicesForce 

Force.

RequestChoicesMotorDriver 

Motor Driver.

X axis type choice.

Enumerator:
XAxisTypeChoicesDefaultTime 

Time.

XAxisTypeChoicesUserDefined 

User defined.


Member Function Documentation

Add curves to the end of y curve list
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
curvescurves

Returns the afu file name
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the component
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the csystype
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Get the motion objects.

Returns:

Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Returns the object currently being edited by this builder.

If a new object is being created, and the builder has not yet been commited, returns NULL.

Returns:

Created in NX4.0.0.

License requirements : None

Reimplemented from NXOpen::Builder.

Get the defined y curves.

Returns:

Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Returns the graph title
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the mode id
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the mode request
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::GraphBuilder::MoveDownYCurves ( const std::vector< int > &  selectedIndices)

Move down the curves in the y curve list by one step
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
selectedIndicesa list of y curve indeces
void NXOpen::Motion::GraphBuilder::MoveUpYCurves ( const std::vector< int > &  selectedIndices)

Move up the curves in the y curve list by one step
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
selectedIndicesa list of y curve indeces

Returns the object selected from motion objects
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the plot enable flag
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the plot style choice
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Remove the curve from the y curve list
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
yCurvey curve

Returns the request
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Sets the afu file name
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
fileNamefile name

Sets the component
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
componentcomponent

Sets the csystype
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
coordinateSystemTypecoordinate system type

Sets the graph title
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
graphTitlegraph title

Sets the mode id
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
modeIDmodeid

Sets the mode request
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
modeRequestmode request
void NXOpen::Motion::GraphBuilder::SetMotionObjects ( const std::vector< NXOpen::NXObject * > &  motionObjects)

Set the motion objects
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
motionObjectsmotion objects

Sets the object selected from motion objects
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
objectobject

Sets the plot enable flag
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
plotEnableplot enable

Sets the plot style choice
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
plotStyleplot style

Sets the request
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
requestrequest

Sets the store enable flag
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
storeEnablestore enable

Sets the x axis type
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
xAxisTypex axis type

Set x curve
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
newCurvenew curve

Returns the store enable flag
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the x axis type
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the x curve
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")


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