NX Open C++ Reference Guide
Classes | Enumerations
NXOpen::CAE::Xyplot Namespace Reference

Provides classes and interfaces for XY Graphing. More...

Classes

struct  AxisLabelStyle
 Axis label display style. More...
struct  AxisNumberStyle
 Axis number display style. More...
struct  AxisStyle
 Axis display style. More...
struct  BarOption2D
 Bar display option for 2D plot. More...
struct  BarOption3D
 Bar display option for 3D plot. More...
class  BaseTemplate
 Manages the display style
Not support KF. More...
class  BaseTemplateManager
 Manages the graph template
Not support KF. More...
struct  GridLayout2D
 Grid layout style for 2D plot. More...
struct  GridLayout3D
 Grid layout style for 3D plot. More...
struct  LineOption2D
 Line display option for 2D plot. More...
struct  LineOption3D
 Line display option for 3D plot. More...
struct  PlateOption2D
 Plate option for 2D plot. More...
struct  PlateOption3D
 Plate option for 3D plot. More...
class  Plot
 Manages the plot template
Not support KF. More...
struct  SurfaceOption3D
 Surface option for 3D plot. More...
class  Template2D
 Manages the 2D display style
Not support KF. More...
class  Template3D
 Manages the 3D display style
Not support KF. More...
struct  TextBoxStyle
 Text box display style. More...
struct  TextOption
 Text display option. More...
struct  TextStyle
 Text display style. More...
class  XYPlotManager
 XYPlot function manager
To obtain an instance of this class use Session::XYPlotManager . More...

Enumerations

enum  AxisDBScale { AxisDBScaleTen, AxisDBScaleTwenty }
 Represents the DB scale for plot. More...
enum  AxisDirection { AxisDirectionX, AxisDirectionY, AxisDirectionZ }
 Represents the axis direction. More...
enum  AxisType { AxisTypeAuto, AxisTypeLinear, AxisTypeLog, AxisTypeDb }
 Represents the type of scale for X or Y axis. More...
enum  BarColorOption { BarColorOptionFill, BarColorOptionHidden, BarColorOptionShaded }
 Represents the bar filling color option. More...
enum  ComplexOption2D {
  ComplexOption2DMagnitude, ComplexOption2DMagnitudePhase, ComplexOption2DPhase, ComplexOption2DReal,
  ComplexOption2DRealImaginary, ComplexOption2DRealImaginaryPhase, ComplexOption2DPolar, ComplexOption2DArgand,
  ComplexOption2DPolar3D, ComplexOption2DArgand3D, ComplexOption2DPhaseMagnitude, ComplexOption2DImaginaryReal,
  ComplexOption2DPhaseRealImaginary, ComplexOption2DImaginaryRealPhase, ComplexOption2DPhaseImaginaryReal
}
 Represents the 2D plot complex option. More...
enum  ComplexOption3D { ComplexOption3DMagnitude, ComplexOption3DPhase, ComplexOption3DReal, ComplexOption3DImaginary }
 Represents the 3D plot complex option. More...
enum  ContouringRange { ContouringRangeBorderGrid, ContouringRangeFullGrid }
 Represents the contouring range. More...
enum  DecimalFormat {
  DecimalFormatActual, DecimalFormatX, DecimalFormatXx, DecimalFormatXxx,
  DecimalFormatXxxx, DecimalFormatXexx, DecimalFormatXxexx, DecimalFormatXxxexx,
  DecimalFormatXxxxexx
}
 Represents the decimal number format. More...
enum  Direction { DirectionX, DirectionZ, DirectionXz }
 Represents the direction option. More...
enum  GraphStyle { GraphStyleLine, GraphStyleBar, GraphStylePlate, GraphStyleSurface }
 Represents the plot graph style. More...
enum  GridStyle {
  GridStyleNoGrid, GridStyleGridOnly, GridStyleTicksOnly, GridStyleGridAndTicks,
  GridStyleDenseGrid
}
 Represents the grid style for plot. More...
enum  LineFont {
  LineFontSolid, LineFontDashed, LineFontPhantom, LineFontCenterLine,
  LineFontDotted, LineFontLongDashed, LineFontDottedDashed
}
 Represents the line font. More...
enum  LineWidth { LineWidthThin, LineWidthNormal, LineWidthThick }
 Represents the line width. More...
enum  PhaseRangeOption {
  PhaseRangeOptionNegativeTwoPiToZero, PhaseRangeOptionZeroToTwoPi, PhaseRangeOptionNegativePiToPi, PhaseRangeOptionNegativeOneHalfPiToHalfPi,
  PhaseRangeOptionNegativeHalfPiToOneHalfPi
}
 Prepresents the phase range option. More...
enum  PlateColorOption { PlateColorOptionFill, PlateColorOptionHidden, PlateColorOptionShaded }
 Represents the plate filling color option. More...
enum  PointMarker {
  PointMarkerNone, PointMarkerPlus, PointMarkerDot, PointMarkerAsterisk,
  PointMarkerCircle, PointMarkerPoundsign, PointMarkerCross, PointMarkerSquare,
  PointMarkerTriangle, PointMarkerDiamond, PointMarkerCenterLine
}
 Represents the point marker. More...
enum  SurfaceColorOption { SurfaceColorOptionNone, SurfaceColorOptionHidden, SurfaceColorOptionShaded }
 Represents the surface filling color option. More...
enum  TextAlignment { TextAlignmentLeft, TextAlignmentCenter, TextAlignmentRight }
 Represents the text alignment. More...
enum  TextOrientation { TextOrientationHorizontal, TextOrientationUpward, TextOrientationDownward }
 Represents the text orientation. More...
enum  TextType {
  TextTypeNone, TextTypeTitle, TextTypeLegend, TextTypeGraphName,
  TextTypePageNumber, TextTypeMarker, TextTypeNote, TextTypeProbingText,
  TextTypeXLabel, TextTypeYLabel, TextTypeZLabel, TextTypeXNumber,
  TextTypeYNumber, TextTypeZNumber
}
 Represents the label text type. More...
enum  UnitSystem {
  UnitSystemFunction, UnitSystemModel, UnitSystemSi, UnitSystemMn,
  UnitSystemMm, UnitSystemIn, UnitSystemCustom
}
 Represents the unit system. More...

Detailed Description

Provides classes and interfaces for XY Graphing.


Enumeration Type Documentation

Represents the DB scale for plot.

Enumerator:
AxisDBScaleTen 

Db 10.

AxisDBScaleTwenty 

Db 20.

Represents the axis direction.

Enumerator:
AxisDirectionX 

X-axis.

AxisDirectionY 

Y-axis.

AxisDirectionZ 

Z-axis.

Represents the type of scale for X or Y axis.

Enumerator:
AxisTypeAuto 

Automatic type.

AxisTypeLinear 

Linear type.

AxisTypeLog 

Log type.

AxisTypeDb 

Db type.

Represents the bar filling color option.

Enumerator:
BarColorOptionFill 

Fill color or contour color with no shading.

BarColorOptionHidden 

Background color as fill.

BarColorOptionShaded 

Fill Color or contour color with shading.

Represents the 2D plot complex option.

Enumerator:
ComplexOption2DMagnitude 

Magnitude of the complex data for 2D plot.

ComplexOption2DMagnitudePhase 

Magnitude and phase angle of complex data for 2D plot.

ComplexOption2DPhase 

Only the phase of the complex data for 2D plot.

ComplexOption2DReal 

Only the real part of the complex data for 2D plot.

ComplexOption2DRealImaginary 

Real and imaginary of the complex data for 2D plot.

ComplexOption2DRealImaginaryPhase 

Real, imaginary and phase angle of the complex data for 2D plot.

ComplexOption2DPolar 

Polar for 2D plot.

ComplexOption2DArgand 

Argand for 2D plot.

ComplexOption2DPolar3D 

Polar for 3D plot.

ComplexOption2DArgand3D 

Argand for 3D plot.

ComplexOption2DPhaseMagnitude 

Phase angle and Magnitude of complex data for 2D plot.

ComplexOption2DImaginaryReal 

Real and imaginary of the complex data for 2D plot.

ComplexOption2DPhaseRealImaginary 

Phase angle, real and imaginary of the complex data for 2D plot.

ComplexOption2DImaginaryRealPhase 

Imaginary, real and phase angle of the complex data for 2D plot.

ComplexOption2DPhaseImaginaryReal 

Phase angle, imaginary and real of the complex data for 2D plot.

Represents the 3D plot complex option.

Enumerator:
ComplexOption3DMagnitude 

Magnitude of the complex data for 3D plot.

ComplexOption3DPhase 

Phase of the complex data for 3D plot.

ComplexOption3DReal 

Real part of the complex data for 3D plot.

ComplexOption3DImaginary 

Imaginary part of the complex data for 3D plot.

Represents the contouring range.

Enumerator:
ContouringRangeBorderGrid 

Option to show contour range on the border of the grid.

ContouringRangeFullGrid 

Option to show contour range on the face of the grid.

Represents the decimal number format.

Enumerator:
DecimalFormatActual 

Show decimal automatically.

DecimalFormatX 

Displays one digit followed by period.

DecimalFormatXx 

Displays two digits followed by period.

DecimalFormatXxx 

Displays three digits followed by period.

DecimalFormatXxxx 

Displays four digits followed by period.

DecimalFormatXexx 

Scientific notation with one digit followed by period, for example: 5.3E+05.

DecimalFormatXxexx 

Scientific notation with two digits followed by period.

DecimalFormatXxxexx 

Scientific notation with three digits followed by period.

DecimalFormatXxxxexx 

Scientific notation with four digits followed by period.

Represents the direction option.

Enumerator:
DirectionX 

Option to show plot in the X axis direction.

DirectionZ 

Option to show plot in the Z axis direction.

DirectionXz 

Option to show plot in the both X and Z axis direction.

Represents the plot graph style.

Enumerator:
GraphStyleLine 

Option to display plot in curve style.

GraphStyleBar 

Option to display plot in bar style.

GraphStylePlate 

Option to display plot in plate style.

GraphStyleSurface 

Option to display plot in surface style.

Represents the grid style for plot.

Enumerator:
GridStyleNoGrid 

No grid displayed.

GridStyleGridOnly 

Only display grid.

GridStyleTicksOnly 

Only display tick.

GridStyleGridAndTicks 

Display both grid and tick.

GridStyleDenseGrid 

Display dense grid.

Represents the line font.

Enumerator:
LineFontSolid 

Solid font.

LineFontDashed 

Dashed font.

LineFontPhantom 

Phantom font.

LineFontCenterLine 

Center line font.

LineFontDotted 

Dotted font.

LineFontLongDashed 

Long dashed font.

LineFontDottedDashed 

Dotted dashed font.

Represents the line width.

Enumerator:
LineWidthThin 

Thin width.

LineWidthNormal 

Normal width.

LineWidthThick 

Thick width.

Prepresents the phase range option.

Enumerator:
PhaseRangeOptionNegativeTwoPiToZero 

Displays phase between 0 and 360.

PhaseRangeOptionZeroToTwoPi 

Displays phase between -360 and 0.

PhaseRangeOptionNegativePiToPi 

Displays phase between -180 and 180.

PhaseRangeOptionNegativeOneHalfPiToHalfPi 

Displays phase between -270 and 90.

PhaseRangeOptionNegativeHalfPiToOneHalfPi 

Displays phase between -90 and 270.

Represents the plate filling color option.

Enumerator:
PlateColorOptionFill 

Fill color with no shading.

PlateColorOptionHidden 

Background color as fill.

PlateColorOptionShaded 

Fill Color with shading.

Represents the point marker.

Enumerator:
PointMarkerNone 

No marker.

PointMarkerPlus 

Plus marker.

PointMarkerDot 

Dot marker.

PointMarkerAsterisk 

Asterisk marker.

PointMarkerCircle 

Circle marker.

PointMarkerPoundsign 

Pound sign marker.

PointMarkerCross 

Cross marker.

PointMarkerSquare 

Square marker.

PointMarkerTriangle 

Triangle marker.

PointMarkerDiamond 

Diamond marker.

PointMarkerCenterLine 

Center line marker.

Represents the surface filling color option.

Enumerator:
SurfaceColorOptionNone 

No shading.

SurfaceColorOptionHidden 

Background color as fill.

SurfaceColorOptionShaded 

Fill Color or contour color with shading.

Represents the text alignment.

Enumerator:
TextAlignmentLeft 

Left align text.

TextAlignmentCenter 

Center align text.

TextAlignmentRight 

Right align text.

Represents the text orientation.

Enumerator:
TextOrientationHorizontal 

Horizontal text orientation.

TextOrientationUpward 

Upward text orientation.

TextOrientationDownward 

Downward text orientation.

Represents the label text type.

Enumerator:
TextTypeNone 

Not defined type.

TextTypeTitle 

Title label.

TextTypeLegend 

Legend label.

TextTypeGraphName 

Graph name label.

TextTypePageNumber 

Page number label.

TextTypeMarker 

Marker label.

TextTypeNote 

Note label.

TextTypeProbingText 

Probing label.

TextTypeXLabel 

X Axis name label.

TextTypeYLabel 

Y Axis name label.

TextTypeZLabel 

Z Axis name label.

TextTypeXNumber 

X Axis number label.

TextTypeYNumber 

Y Axis number label.

TextTypeZNumber 

Z Axis number label.

Represents the unit system.

Enumerator:
UnitSystemFunction 

Function unit.

UnitSystemModel 

Model unit.

UnitSystemSi 

International standard unit.

UnitSystemMn 

Milliforce unit.

UnitSystemMm 

Millimeter unit.

UnitSystemIn 

Inch unit.

UnitSystemCustom 

Custom unit.

Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.