NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Types | Public Member Functions | Properties | List of all members
NXOpen.Motion.GraphBuilder Class Reference

Represents a NXOpen.Motion.GraphBuilder , only creation is supported More...

Inheritance diagram for NXOpen.Motion.GraphBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

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

Public Types

enum  ComponentChoices {
  Mag, X, Y, Z,
  Amag, Xy, Yz, Zx,
  InputVoltage, ElectricCurrent, ElectricTorque, SignalChart
}
 Component attribute of the curve data. More...
 
enum  CsysChoices { Relative, Absolute }
 Csys attribute of the curve data. More...
 
enum  PlotStyleChoices { Ftk, Spreadsheet }
 Plot output type More...
 
enum  RequestChoices {
  Displacement, Velocity, Acceleration, Force,
  MotorDriver
}
 Request attribute of the curve data. More...
 
enum  XAxisTypeChoices { DefaultTime, UserDefined }
 X axis type choice. More...
 

Public Member Functions

unsafe void AddYCurves (NXOpen.Motion.GraphBuilder.CurveData[] curves)
 Add curves to the end of y curve list More...
 
unsafe NXOpen.NXObject[] GetMotionObjects ()
 Get the motion objects More...
 
unsafe
NXOpen.Motion.GraphBuilder.CurveData[] 
GetYCurves ()
 Get the defined y curves More...
 
unsafe void MoveDownYCurves (int[] selectedIndices)
 Move down the curves in the y curve list by one step More...
 
unsafe void MoveUpYCurves (int[] selectedIndices)
 Move up the curves in the y curve list by one step More...
 
unsafe void RemoveYCurve (NXOpen.Motion.GraphBuilder.CurveData yCurve)
 Remove the curve from the y curve list More...
 
unsafe void SetMotionObjects (NXOpen.NXObject[] motionObjects)
 Set the motion objects More...
 
unsafe void SetXCurve (NXOpen.Motion.GraphBuilder.CurveData newCurve)
 Set x curve More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe string AfuFile [get, set]
 Returns or sets the afu file name More...
 
unsafe
NXOpen.Motion.GraphBuilder.ComponentChoices 
Component [get, set]
 Returns or sets the component More...
 
unsafe
NXOpen.Motion.GraphBuilder.CsysChoices 
CoordinateSystemType [get, set]
 Returns or sets the csystype More...
 
unsafe string GraphTitle [get, set]
 Returns or sets the graph title More...
 
unsafe int Mode [get, set]
 Returns or sets the mode id More...
 
unsafe
NXOpen.Motion.GraphBuilder.RequestChoices 
ModeRequest [get, set]
 Returns or sets the mode request More...
 
unsafe NXOpen.NXObject Object [get, set]
 Returns or sets the object selected from motion objects More...
 
unsafe bool PlotEnable [get, set]
 Returns or sets the plot enable flag More...
 
unsafe
NXOpen.Motion.GraphBuilder.PlotStyleChoices 
PlotStyle [get, set]
 Returns or sets the plot style choice More...
 
unsafe
NXOpen.Motion.GraphBuilder.RequestChoices 
Request [get, set]
 Returns or sets the request More...
 
unsafe bool StoreEnable [get, set]
 Returns or sets the store enable flag More...
 
unsafe
NXOpen.Motion.GraphBuilder.XAxisTypeChoices 
XAxisType [get, set]
 Returns or sets the x axis type More...
 
unsafe
NXOpen.Motion.GraphBuilder.CurveData 
XCurve [get]
 Returns the x curve More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Motion.GraphBuilder , only creation is supported

To create a new instance of this class, use NXOpen.Motion.GraphManager.CreateGraphBuilder

Created in NX5.0.0

Deprecated in NX11.0.0. Use Motion.GraphObjectBuilder instead.

Member Enumeration Documentation

Component attribute of the curve data.

Enumerator
Mag 

Magnitude

X 

X

Y 

Y

Z 

Z

Amag 

Angular Magnitude

Xy 

XY

Yz 

YZ

Zx 

ZX

InputVoltage 

Input Voltage

ElectricCurrent 

Electric Current

ElectricTorque 

Electric Torque

SignalChart 

Signal Chart

Csys attribute of the curve data.

Enumerator
Relative 

Relative

Absolute 

Absolute

Plot output type

Enumerator
Ftk 

To FTK

Spreadsheet 

To Spreadsheet

Request attribute of the curve data.

Enumerator
Displacement 

Displacement

Velocity 

Velocity

Acceleration 

Acceleration

Force 

Force

MotorDriver 

Motor Driver

X axis type choice.

Enumerator
DefaultTime 

Time

UserDefined 

User defined

Member Function Documentation

unsafe void NXOpen.Motion.GraphBuilder.AddYCurves ( NXOpen.Motion.GraphBuilder.CurveData[]  curves)
inline

Add curves to the end of y curve list

Created in NX5.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
curves
unsafe NXOpen.NXObject [] NXOpen.Motion.GraphBuilder.GetMotionObjects ( )
inline

Get the motion objects

Created in NX5.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
unsafe NXOpen.Motion.GraphBuilder.CurveData [] NXOpen.Motion.GraphBuilder.GetYCurves ( )
inline

Get the defined y curves

Created in NX5.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
unsafe void NXOpen.Motion.GraphBuilder.MoveDownYCurves ( int[]  selectedIndices)
inline

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
unsafe void NXOpen.Motion.GraphBuilder.MoveUpYCurves ( int[]  selectedIndices)
inline

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
unsafe void NXOpen.Motion.GraphBuilder.RemoveYCurve ( NXOpen.Motion.GraphBuilder.CurveData  yCurve)
inline

Remove the curve from the y curve list

Created in NX5.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
yCurve
unsafe void NXOpen.Motion.GraphBuilder.SetMotionObjects ( NXOpen.NXObject[]  motionObjects)
inline

Set the motion objects

Created in NX5.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
motionObjects
unsafe void NXOpen.Motion.GraphBuilder.SetXCurve ( NXOpen.Motion.GraphBuilder.CurveData  newCurve)
inline

Set x curve

Created in NX5.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
newCurve

Property Documentation

unsafe string NXOpen.Motion.GraphBuilder.AfuFile
getset

Returns or sets the afu file name

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.GraphBuilder.ComponentChoices NXOpen.Motion.GraphBuilder.Component
getset

Returns or sets the component

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.GraphBuilder.CsysChoices NXOpen.Motion.GraphBuilder.CoordinateSystemType
getset

Returns or sets the csystype

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.GraphBuilder.GraphTitle
getset

Returns or sets the graph title

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe int NXOpen.Motion.GraphBuilder.Mode
getset

Returns or sets the mode id

Created in NX8.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.GraphBuilder.RequestChoices NXOpen.Motion.GraphBuilder.ModeRequest
getset

Returns or sets the mode request

Created in NX8.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.NXObject NXOpen.Motion.GraphBuilder.Object
getset

Returns or sets the object selected from motion objects

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe bool NXOpen.Motion.GraphBuilder.PlotEnable
getset

Returns or sets the plot enable flag

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.GraphBuilder.PlotStyleChoices NXOpen.Motion.GraphBuilder.PlotStyle
getset

Returns or sets the plot style choice

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.GraphBuilder.RequestChoices NXOpen.Motion.GraphBuilder.Request
getset

Returns or sets the request

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe bool NXOpen.Motion.GraphBuilder.StoreEnable
getset

Returns or sets the store enable flag

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.GraphBuilder.XAxisTypeChoices NXOpen.Motion.GraphBuilder.XAxisType
getset

Returns or sets the x axis type

Created in NX5.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.GraphBuilder.CurveData NXOpen.Motion.GraphBuilder.XCurve
get

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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.