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

Public Member Functions
NXOpen::CAE::Xyplot::Plot *	FindObject (const NXString &journalIdentifier)
	Finds the CAE::Xyplot::Plot with the given identifier as recorded in a journal. More...

NXOpen::CAE::Xyplot::Plot *	FindObject (const char *journalIdentifier)
	Finds the CAE::Xyplot::Plot with the given identifier as recorded in a journal. More...

std::vector< int >	GetAvailableWindowDevices ()
	Gets all window devices on which XY graph could be plotted. More...

NXOpen::CAE::Xyplot::Plot *	GetCurrentPlot (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...

std::vector< int >	GetWindowDevicesViews (int windowDevice)
	Gets view count and views for specified window device. More...

NXOpen::CAE::Xyplot::OverlayParameters *	NewOverlayParameters ()
	Creates an transient object NXOpen::CAE::Xyplot::PlotParameters to contain the settings required by overlaying new records on a plot. More...

NXOpen::CAE::Xyplot::PlotParameters *	NewPlotParameters ()
	Creates an transient object NXOpen::CAE::Xyplot::PlotParameters to contain the settings required by creating a plot. More...

NXOpen::CAE::Xyplot::Plot *	OverlayRecords (NXOpen::CAE::Xyplot::OverlayParameters *overlayParameters)
	Overlay records with given parameters. More...

NXOpen::CAE::Xyplot::Plot *	PlotRecords (NXOpen::CAE::Xyplot::PlotParameters *plotParameters)
	Creates plot with given parameters. More...

NXOpen::CAE::Xyplot::Preference *	Preference ()
	Returns the preference Created in NX9.0.0. More...

void	ReturnToModelView (int view)
	Clears all plots on a view of main graphics windows and returns to model view Created in NX11.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::BaseTemplateManager *	TemplateManager ()
	Returns the template manager. More...

NXOpen::CAE::Xyplot::WindowManager *	WindowManager ()
	Returns the NXOpen::CAE::Xyplot::WindowManager belonging. More...

void	WriteImageToClipBoard (int deviceIndex, int viewIndex, bool isUseWhiteBackGround)
	Write the image of current plot on a view to Windows's ClipBoard Created in NX12.0.0. 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

NXOpen::CAE::Xyplot::Plot* NXOpen::CAE::Xyplot::XYPlotManager::FindObject ( const NXString & journalIdentifier )

Finds the CAE::Xyplot::Plot with the given identifier as recorded in a journal.

Returns: Plot object found, or null if no such plot exists
Created in NX12.0.0.

License requirements : None

Parameters

journalIdentifier Identifier of the CAE::Xyplot::Plot to be found

NXOpen::CAE::Xyplot::Plot* NXOpen::CAE::Xyplot::XYPlotManager::FindObject ( const char * journalIdentifier )

Finds the CAE::Xyplot::Plot with the given identifier as recorded in a journal.

Returns: Plot object found, or null if no such plot exists
Created in NX12.0.0.

License requirements : None

Parameters

journalIdentifier Identifier of the CAE::Xyplot::Plot to be found

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 : None

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 : None

Parameters

deviceIndex	Device index
viewIndex	View 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 : None

Parameters

windowDevice	Plot index
view	View index

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 : None

Parameters

windowDevice window 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 : None

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 : None

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 : None

Parameters

overlayParameters the 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 : None

Parameters

plotParameters the plot parameters

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

Returns the preference
Created in NX9.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::XYPlotManager::ReturnToModelView ( int view )

Clears all plots on a view of main graphics windows and returns to model view
Created in NX11.0.0.

License requirements : None

Parameters

view	View index

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 : None

Parameters

deviceIndex	Device index
viewIndex	View 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 : None

Parameters

deviceIndex	Device index
viewIndex	View 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 : None

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.

void NXOpen::CAE::Xyplot::XYPlotManager::WriteImageToClipBoard	(	int	deviceIndex,
		int	viewIndex,
		bool	isUseWhiteBackGround
	)

Write the image of current plot on a view to Windows's ClipBoard
Created in NX12.0.0.

License requirements : None

Parameters

deviceIndex	Device index
viewIndex	View index
isUseWhiteBackGround	isusewhitebackground

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

CAE_Xyplot_XYPlotManager.hxx

Public Member Functions

Detailed Description

Member Function Documentation