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

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

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

Public Member Functions

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 or modify a plot.


This is an abstract class

Created in NX9.0.0.

Constructor & Destructor Documentation

virtual NXOpen::CAE::Xyplot::BasePlotParameters::~BasePlotParameters ( )
virtual

Destroys the object
Created in NX9.0.0.



License requirements : None

Member Function Documentation

int NXOpen::CAE::Xyplot::BasePlotParameters::DeviceIndex ( )

Returns the index of device on which plot graph will be shown.

A value of 1 represents the main graphic window, a value greater than 2 represents separate graphic window.
Created in NX9.0.0.

License requirements : None

std::vector<NXOpen::CAE::FTK::BaseRecord *> NXOpen::CAE::Xyplot::BasePlotParameters::GetRecords ( )

Gets the records to be plotted.

Returns
Records
Created in NX9.0.0.

License requirements : None
void NXOpen::CAE::Xyplot::BasePlotParameters::SetDeviceIndex ( int  deviceIndex)

Sets the index of device on which plot graph will be shown.

A value of 1 represents the main graphic window, a value greater than 2 represents separate graphic window.
Created in NX9.0.0.

License requirements : None

Parameters
deviceIndexdeviceindex
void NXOpen::CAE::Xyplot::BasePlotParameters::SetRecords ( const std::vector< NXOpen::CAE::FTK::BaseRecord * > &  records)

Sets the records to be plotted
Created in NX9.0.0.



License requirements : None

Parameters
recordsRecords
void NXOpen::CAE::Xyplot::BasePlotParameters::SetViewPortIndex ( int  viewIndex)

Sets the index of a view port on main graphic window, on which plot graph will be shown.

Only available when CAE::Xyplot::BasePlotParameters::DeviceIndex and CAE::Xyplot::BasePlotParameters::SetDeviceIndex is 1.
Created in NX9.0.0.

License requirements : None

Parameters
viewIndexviewindex
int NXOpen::CAE::Xyplot::BasePlotParameters::ViewPortIndex ( )

Returns the index of a view port on main graphic window, on which plot graph will be shown.

Only available when CAE::Xyplot::BasePlotParameters::DeviceIndex and CAE::Xyplot::BasePlotParameters::SetDeviceIndex is 1.
Created in NX9.0.0.

License requirements : None


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