NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::Xyplot::XYPlotManager Class Reference

XYPlot function manager
To obtain an instance of this class use NXOpen::Session::XYPlotManager . More...

Public Member Functions

std::vector< int > GetAvailableWindowDevices ()
 Gets all window devices on which XY graph could be plotted. More...
 
NXOpen::CAE::Xyplot::PlotGetCurrentPlot (int deviceIndex, int viewIndex)
 Gets the current plot on the view port of specific device. More...
 
std::vector
< NXOpen::CAE::Xyplot::Plot * > 
GetPlots (int windowDevice, int view)
 Gets all plots on a view of specified window device. More...
 
NXOpen::CAE::Xyplot::BaseTemplateManagerGetTemplateManager2d ()
 Gets the 2D template manager. More...
 
NXOpen::CAE::Xyplot::BaseTemplateManagerGetTemplateManager3d ()
 Gets the 3D template manager. More...
 
std::vector< int > GetWindowDevicesViews (int windowDevice)
 Gets view count and views for specified window device. More...
 
NXOpen::CAE::Xyplot::OverlayParametersNewOverlayParameters ()
 Creates an transient object NXOpen::CAE::Xyplot::PlotParameters to contain the settings required by overlaying new records on a plot. More...
 
NXOpen::CAE::Xyplot::PlotParametersNewPlotParameters ()
 Creates an transient object NXOpen::CAE::Xyplot::PlotParameters to contain the settings required by creating a plot. More...
 
NXOpen::CAE::Xyplot::PlotOverlayRecords (NXOpen::CAE::Xyplot::OverlayParameters *overlayParameters)
 Overlay records with given parameters. More...
 
NXOpen::CAE::Xyplot::PlotPlotRecords (NXOpen::CAE::Xyplot::PlotParameters *plotParameters)
 Creates plot with given parameters. More...
 
NXOpen::CAE::Xyplot::PreferencePreference ()
 Returns the preference
Created in NX9.0.0. More...
 
void ShowNextPlot (int deviceIndex, int viewIndex)
 Shows the next plot on the view port of specific device
Created in NX9.0.0. More...
 
void ShowPreviousPlot (int deviceIndex, int viewIndex)
 Shows the previous plot on the view port of specific device
Created in NX9.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
NXOpen::CAE::Xyplot::BaseTemplateManagerTemplateManager ()
 Returns the template manager. More...
 
NXOpen::CAE::Xyplot::WindowManagerWindowManager ()
 Returns the NXOpen::CAE::Xyplot::WindowManager belonging. More...
 

Detailed Description

XYPlot function manager
To obtain an instance of this class use NXOpen::Session::XYPlotManager .



Created in NX7.5.0.

Member Function Documentation

std::vector<int> NXOpen::CAE::Xyplot::XYPlotManager::GetAvailableWindowDevices ( )

Gets all window devices on which XY graph could be plotted.

Returns
Available Plot Winodw Devices
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
NXOpen::CAE::Xyplot::Plot* NXOpen::CAE::Xyplot::XYPlotManager::GetCurrentPlot ( int  deviceIndex,
int  viewIndex 
)

Gets the current plot on the view port of specific device.

Returns
Current plot
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
Parameters
deviceIndexDevice index
viewIndexView index
std::vector<NXOpen::CAE::Xyplot::Plot *> NXOpen::CAE::Xyplot::XYPlotManager::GetPlots ( int  windowDevice,
int  view 
)

Gets all plots on a view of specified window device.

Returns
Plots
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
Parameters
windowDevicePlot index
viewView index
NXOpen::CAE::Xyplot::BaseTemplateManager* NXOpen::CAE::Xyplot::XYPlotManager::GetTemplateManager2d ( )

Gets the 2D template manager.

Returns
2D template manager
Deprecated:
Deprecated in NX10.0.0. Use NXOpen::CAE::Xyplot::XYPlotManager::TemplateManager instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

NXOpen::CAE::Xyplot::BaseTemplateManager* NXOpen::CAE::Xyplot::XYPlotManager::GetTemplateManager3d ( )

Gets the 3D template manager.

Returns
3D template manager
Deprecated:
Deprecated in NX10.0.0. Use NXOpen::CAE::Xyplot::XYPlotManager::TemplateManager instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

std::vector<int> NXOpen::CAE::Xyplot::XYPlotManager::GetWindowDevicesViews ( int  windowDevice)

Gets view count and views for specified window device.

Returns
the views on window device
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
Parameters
windowDevicewindow index
NXOpen::CAE::Xyplot::OverlayParameters* NXOpen::CAE::Xyplot::XYPlotManager::NewOverlayParameters ( )

Creates an transient object NXOpen::CAE::Xyplot::PlotParameters to contain the settings required by overlaying new records on a plot.

The object should be destroyed after overlaying plot is created.

Returns
the overlay parameters object created
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
NXOpen::CAE::Xyplot::PlotParameters* NXOpen::CAE::Xyplot::XYPlotManager::NewPlotParameters ( )

Creates an transient object NXOpen::CAE::Xyplot::PlotParameters to contain the settings required by creating a plot.

The object should be destroyed after plot is created.

Returns
the plot parameters object created
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
NXOpen::CAE::Xyplot::Plot* NXOpen::CAE::Xyplot::XYPlotManager::OverlayRecords ( NXOpen::CAE::Xyplot::OverlayParameters overlayParameters)

Overlay records with given parameters.

Returns
Overlayed plot
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
Parameters
overlayParametersthe overlay parameters
NXOpen::CAE::Xyplot::Plot* NXOpen::CAE::Xyplot::XYPlotManager::PlotRecords ( NXOpen::CAE::Xyplot::PlotParameters plotParameters)

Creates plot with given parameters.

Returns
Created plot
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
Parameters
plotParametersthe plot parameters
NXOpen::CAE::Xyplot::Preference* NXOpen::CAE::Xyplot::XYPlotManager::Preference ( )

Returns the preference
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

void NXOpen::CAE::Xyplot::XYPlotManager::ShowNextPlot ( int  deviceIndex,
int  viewIndex 
)

Shows the next plot on the view port of specific device
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
deviceIndexDevice index
viewIndexView index
void NXOpen::CAE::Xyplot::XYPlotManager::ShowPreviousPlot ( int  deviceIndex,
int  viewIndex 
)

Shows the previous plot on the view port of specific device
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
deviceIndexDevice index
viewIndexView index
tag_t NXOpen::CAE::Xyplot::XYPlotManager::Tag ( ) const

Returns the tag of this object.

NXOpen::CAE::Xyplot::BaseTemplateManager* NXOpen::CAE::Xyplot::XYPlotManager::TemplateManager ( )

Returns the template manager.


Created in NX10.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

NXOpen::CAE::Xyplot::WindowManager* NXOpen::CAE::Xyplot::XYPlotManager::WindowManager ( )

Returns the NXOpen::CAE::Xyplot::WindowManager belonging.

This class is restricted to being called from a program running during an interactive NX session. If run from a non-interactive session it will return NULL.
Created in NX9.0.0.


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