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:

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::NXObject *	GetObject ()
	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::NXObject *	Object ()
	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	SetAfuFile (const char *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	SetGraphTitle (const char *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.

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::Motion::GraphBuilder::ComponentChoices

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.

enum NXOpen::Motion::GraphBuilder::CsysChoices

Csys attribute of the curve data.

Enumerator:

CsysChoicesRelative	Relative.
CsysChoicesAbsolute	Absolute.

enum NXOpen::Motion::GraphBuilder::PlotStyleChoices

Plot output type.

Enumerator:

PlotStyleChoicesFtk	To FTK.
PlotStyleChoicesSpreadsheet	To Spreadsheet.

enum NXOpen::Motion::GraphBuilder::RequestChoices

Request attribute of the curve data.

Enumerator:

RequestChoicesDisplacement	Displacement.
RequestChoicesVelocity	Velocity.
RequestChoicesAcceleration	Acceleration.
RequestChoicesForce	Force.
RequestChoicesMotorDriver	Motor Driver.

enum NXOpen::Motion::GraphBuilder::XAxisTypeChoices

X axis type choice.

Enumerator:

XAxisTypeChoicesDefaultTime	Time.
XAxisTypeChoicesUserDefined	User defined.

Member Function Documentation

void NXOpen::Motion::GraphBuilder::AddYCurves ( const std::vector< NXOpen::Motion::GraphBuilder::CurveData > & curves )

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

License requirements : mechanisms ("MECHANISMS")

Parameters

curves curves

NXString NXOpen::Motion::GraphBuilder::AfuFile ( )

Returns the afu file name
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::GraphBuilder::ComponentChoices NXOpen::Motion::GraphBuilder::Component ( )

Returns the component
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::GraphBuilder::CsysChoices NXOpen::Motion::GraphBuilder::CoordinateSystemType ( )

Returns the csystype
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

std::vector<NXOpen::NXObject *> NXOpen::Motion::GraphBuilder::GetMotionObjects ( )

Get the motion objects.

Returns: Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::NXObject* NXOpen::Motion::GraphBuilder::GetObject ( )

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

std::vector<NXOpen::Motion::GraphBuilder::CurveData> NXOpen::Motion::GraphBuilder::GetYCurves ( )

Get the defined y curves.

Returns: Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::GraphBuilder::GraphTitle ( )

Returns the graph title
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

int NXOpen::Motion::GraphBuilder::Mode ( )

Returns the mode id
Created in NX8.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::GraphBuilder::RequestChoices NXOpen::Motion::GraphBuilder::ModeRequest ( )

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

selectedIndices a 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

selectedIndices a list of y curve indeces

NXOpen::NXObject* NXOpen::Motion::GraphBuilder::Object ( )

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

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::GraphBuilder::PlotEnable ( )

Returns the plot enable flag
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::GraphBuilder::PlotStyleChoices NXOpen::Motion::GraphBuilder::PlotStyle ( )

Returns the plot style choice
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::GraphBuilder::RemoveYCurve ( const NXOpen::Motion::GraphBuilder::CurveData & yCurve )

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

License requirements : mechanisms ("MECHANISMS")

Parameters

yCurve y curve

NXOpen::Motion::GraphBuilder::RequestChoices NXOpen::Motion::GraphBuilder::Request ( )

Returns the request
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::GraphBuilder::SetAfuFile ( const NXString & fileName )

Sets the afu file name
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

fileName file name

void NXOpen::Motion::GraphBuilder::SetAfuFile ( const char * fileName )

Sets the afu file name
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

fileName file name

void NXOpen::Motion::GraphBuilder::SetComponent ( NXOpen::Motion::GraphBuilder::ComponentChoices component )

Sets the component
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

component component

void NXOpen::Motion::GraphBuilder::SetCoordinateSystemType ( NXOpen::Motion::GraphBuilder::CsysChoices coordinateSystemType )

Sets the csystype
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

coordinateSystemType coordinate system type

void NXOpen::Motion::GraphBuilder::SetGraphTitle ( const NXString & graphTitle )

Sets the graph title
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

graphTitle graph title

void NXOpen::Motion::GraphBuilder::SetGraphTitle ( const char * graphTitle )

Sets the graph title
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

graphTitle graph title

void NXOpen::Motion::GraphBuilder::SetMode ( int modeID )

Sets the mode id
Created in NX8.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

modeID modeid

void NXOpen::Motion::GraphBuilder::SetModeRequest ( NXOpen::Motion::GraphBuilder::RequestChoices modeRequest )

Sets the mode request
Created in NX8.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

modeRequest mode 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

motionObjects motion objects

void NXOpen::Motion::GraphBuilder::SetObject ( NXOpen::NXObject * object )

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

License requirements : mechanisms ("MECHANISMS")

Parameters

object object

void NXOpen::Motion::GraphBuilder::SetPlotEnable ( bool plotEnable )

Sets the plot enable flag
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

plotEnable plot enable

void NXOpen::Motion::GraphBuilder::SetPlotStyle ( NXOpen::Motion::GraphBuilder::PlotStyleChoices plotStyle )

Sets the plot style choice
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

plotStyle plot style

void NXOpen::Motion::GraphBuilder::SetRequest ( NXOpen::Motion::GraphBuilder::RequestChoices request )

Sets the request
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

request request

void NXOpen::Motion::GraphBuilder::SetStoreEnable ( bool storeEnable )

Sets the store enable flag
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

storeEnable store enable

void NXOpen::Motion::GraphBuilder::SetXAxisType ( NXOpen::Motion::GraphBuilder::XAxisTypeChoices xAxisType )

Sets the x axis type
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

xAxisType x axis type

void NXOpen::Motion::GraphBuilder::SetXCurve ( const NXOpen::Motion::GraphBuilder::CurveData & newCurve )

Set x curve
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

newCurve new curve

bool NXOpen::Motion::GraphBuilder::StoreEnable ( )

Returns the store enable flag
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::GraphBuilder::XAxisTypeChoices NXOpen::Motion::GraphBuilder::XAxisType ( )

Returns the x axis type
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::GraphBuilder::CurveData NXOpen::Motion::GraphBuilder::XCurve ( )

Returns the x curve
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Motion_GraphBuilder.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation