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

Represents the parameters passed to create a plot. More...

Inheritance diagram for NXOpen::CAE::Xyplot::PlotParameters:
NXOpen::CAE::Xyplot::BasePlotParameters NXOpen::TransientObject

Public Member Functions

int ComplexOption ()
 Returns the complex options,if complex option is smaller than zero, it will use default complex option from active template file
Created in NX11.0.0. More...
 
bool IsToCreateStandalonePlot ()
 Returns the create standalone plot
Created in NX11.0.0. More...
 
NXOpen::CAE::Xyplot::PlotGraphTemplatePlotTemplate ()
 Returns the plot template to be used by the plot
Created in NX10.0.0. More...
 
NXOpen::CAE::Xyplot::PlotType PlotType ()
 Returns the plot type
Created in NX10.0.0. More...
 
void SetComplexOption (int complexOption)
 Sets the complex options,if complex option is smaller than zero, it will use default complex option from active template file
Created in NX11.0.0. More...
 
void SetPlotType (NXOpen::CAE::Xyplot::PlotType plotType)
 Sets the plot type
Created in NX10.0.0. More...
 
void SetToCreateStandalonePlot (bool isToCreateStandalonePlot)
 Sets the create standalone plot
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BasePlotParameters
int DeviceIndex ()
 Returns the index of device on which plot graph will be shown. More...
 
std::vector
< NXOpen::CAE::FTK::BaseRecord * > 
GetRecords ()
 Gets the records to be plotted. More...
 
void SetDeviceIndex (int deviceIndex)
 Sets the index of device on which plot graph will be shown. More...
 
void SetRecords (const std::vector< NXOpen::CAE::FTK::BaseRecord * > &records)
 Sets the records to be plotted
Created in NX9.0.0. More...
 
void SetViewPortIndex (int viewIndex)
 Sets the index of a view port on main graphic window, on which plot graph will be shown. More...
 
int ViewPortIndex ()
 Returns the index of a view port on main graphic window, on which plot graph will be shown. More...
 
virtual ~BasePlotParameters ()
 Destroys the object
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents the parameters passed to create a plot.


To create a new instance of this class, use NXOpen::CAE::Xyplot::XYPlotManager::NewPlotParameters

Created in NX9.0.0.

Member Function Documentation

int NXOpen::CAE::Xyplot::PlotParameters::ComplexOption ( )

Returns the complex options,if complex option is smaller than zero, it will use default complex option from active template file
Created in NX11.0.0.



License requirements : None

bool NXOpen::CAE::Xyplot::PlotParameters::IsToCreateStandalonePlot ( )

Returns the create standalone plot
Created in NX11.0.0.



License requirements : None

NXOpen::CAE::Xyplot::PlotGraphTemplate* NXOpen::CAE::Xyplot::PlotParameters::PlotTemplate ( )

Returns the plot template to be used by the plot
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::Xyplot::PlotType NXOpen::CAE::Xyplot::PlotParameters::PlotType ( )

Returns the plot type
Created in NX10.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::PlotParameters::SetComplexOption ( int  complexOption)

Sets the complex options,if complex option is smaller than zero, it will use default complex option from active template file
Created in NX11.0.0.



License requirements : None

Parameters
complexOptioncomplexoption
void NXOpen::CAE::Xyplot::PlotParameters::SetPlotType ( NXOpen::CAE::Xyplot::PlotType  plotType)

Sets the plot type
Created in NX10.0.0.



License requirements : None

Parameters
plotTypeplottype
void NXOpen::CAE::Xyplot::PlotParameters::SetToCreateStandalonePlot ( bool  isToCreateStandalonePlot)

Sets the create standalone plot
Created in NX11.0.0.



License requirements : None

Parameters
isToCreateStandalonePlotistocreatestandaloneplot

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