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 Session::XYPlotManager . More...

Public Member Functions

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

Detailed Description

XYPlot function manager
To obtain an instance of this class use 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  viewIndex)

Gets the current plot on the specific view.

Returns
Current plot
Deprecated:
Deprecated in NX9.0.0. Use CAE::Xyplot::XYPlotManager::GetCurrentPlot instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
viewIndexView index
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
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 a CAE::Xyplot::PlotParameters .

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 a CAE::Xyplot::PlotParameters .

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 ( const std::vector< NXOpen::CAE::FTK::BaseRecord * > &  records,
int  viewIndex 
)

Overlay records on the specific view.

Returns
Overlayed plot
Deprecated:
Deprecated in NX9.0.0. Use CAE::Xyplot::XYPlotManager::OverlayRecords instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
recordsRecords
viewIndexView index
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 ( const std::vector< NXOpen::CAE::FTK::BaseRecord * > &  records,
int  viewIndex 
)

Creates plot on a specified view for given records.

Returns
Created plot
Deprecated:
Deprecated in NX9.0.0. Use CAE::Xyplot::XYPlotManager::PlotRecords instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
recordsRecords
viewIndexView index
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::WindowManager* NXOpen::CAE::Xyplot::XYPlotManager::WindowManager ( )

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