NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::CAE::Xyplot::SourceDataExportParameters Class Reference

Represents the parameter settings for exporting source data. More...

Inheritance diagram for NXOpen::CAE::Xyplot::SourceDataExportParameters:
NXOpen::CAE::Xyplot::DataExportParameters NXOpen::TransientObject

Public Types

enum  ComplextDataSaveOption { ComplextDataSaveOptionRealImag, ComplextDataSaveOptionMagPhase }
 Defines the ordinate complex data type. More...
 

Public Member Functions

NXOpen::CAE::Xyplot::SourceDataExportParameters::ComplextDataSaveOption ComplexDataSaveSetting ()
 Returns the option to save complex data
Created in NX1847.0.0. More...
 
std::vector< int > GetSectionDataIndices ()
 Gets the section data index vector. More...
 
void SetComplexDataSaveSetting (NXOpen::CAE::Xyplot::SourceDataExportParameters::ComplextDataSaveOption complexDataType)
 Sets the option to save complex data
Created in NX1847.0.0. More...
 
void SetSectionDataIndices (const std::vector< int > &sectionDataIndices)
 Sets the section data index vector. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::DataExportParameters
std::vector< int > GetRecordIndices ()
 Gets the data index vector of the plot. More...
 
NXOpen::CAE::Xyplot::PlotPlot ()
 Returns the plot which is being exported
Created in NX1847.0.0. More...
 
void SetPlot (NXOpen::CAE::Xyplot::Plot *plot)
 Sets the plot which is being exported
Created in NX1847.0.0. More...
 
void SetRecordIndices (const std::vector< int > &plotDataIndices)
 Sets the plot data index vector
Created in NX1847.0.0. More...
 
virtual ~DataExportParameters ()
 Destroys the object
Created in NX1847.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 parameter settings for exporting source data.


To create a new instance of this class, use NXOpen::CAE::Xyplot::DataExporter::NewSourceDataExportParameters

Created in NX1847.0.0.

Member Enumeration Documentation

Defines the ordinate complex data type.

Enumerator
ComplextDataSaveOptionRealImag 

real imag

ComplextDataSaveOptionMagPhase 

mag phase

Member Function Documentation

NXOpen::CAE::Xyplot::SourceDataExportParameters::ComplextDataSaveOption NXOpen::CAE::Xyplot::SourceDataExportParameters::ComplexDataSaveSetting ( )

Returns the option to save complex data
Created in NX1847.0.0.



License requirements : None

std::vector<int> NXOpen::CAE::Xyplot::SourceDataExportParameters::GetSectionDataIndices ( )

Gets the section data index vector.

For CAE::Xyplot::PlotTypePlotColorMap , CAE::Xyplot::PlotTypePlot3D , and CAE::Xyplot::PlotTypePlotMatrix2D , the plot data is composed with multiple section data. When saving the data of above plots to AFU or CSV files, user could specify the indexes of the section data.


Created in NX1847.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::SourceDataExportParameters::SetComplexDataSaveSetting ( NXOpen::CAE::Xyplot::SourceDataExportParameters::ComplextDataSaveOption  complexDataType)

Sets the option to save complex data
Created in NX1847.0.0.



License requirements : None

Parameters
complexDataTypecomplexdatatype
void NXOpen::CAE::Xyplot::SourceDataExportParameters::SetSectionDataIndices ( const std::vector< int > &  sectionDataIndices)

Sets the section data index vector.

For CAE::Xyplot::PlotTypePlotColorMap , CAE::Xyplot::PlotTypePlot3D , and CAE::Xyplot::PlotTypePlotMatrix2D , the plot data is composed with multiple section data. When saving the data of above plots to AFU or CSV files, user could specify the indexes of the section data.


Created in NX1847.0.0.

License requirements : None

Parameters
sectionDataIndicessectiondataindices

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