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

the data used to create an AFU Data Record
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::CAE::AfuData:
NXOpen::TransientObject

Public Types

enum  AbscissaType { AbscissaTypeEven, AbscissaTypeUneven, AbscissaTypeSequence }
 Defines abscissa data type for AFU data record. More...
 
enum  ExtrapolationType { ExtrapolationTypeLinear, ExtrapolationTypeParabolic }
 Defines data extrapolation type for AFU data record. More...
 
enum  InterpolationType { InterpolationTypeCubic, InterpolationTypeAkima, InterpolationTypeAkima72, InterpolationTypeLinear }
 Defines data interpolation type for AFU data record. More...
 
enum  OrdinateType { OrdinateTypeReal, OrdinateTypeRealImaginary, OrdinateTypeMagnitudePhase }
 Defines ordinate data type for AFU data record. More...
 

Public Member Functions

NXOpen::CAE::AfuAbscissaHeaderInfoAfuAbscissaHeaderInfo ()
 Returns the abscissa header information data of the AFU Data Record
Created in NX10.0.0. More...
 
NXOpen::CAE::AfuHeaderIdAfuHeaderId ()
 Returns the AFU Header Id data of the AFU Data Record
Created in NX5.0.0. More...
 
NXOpen::CAE::AfuOrdinateHeaderInfoAfuOrdinateHeaderInfo ()
 Returns the ordinate header information data of the AFU Data Record
Created in NX10.0.0. More...
 
NXOpen::CAE::AfuZHeaderInfoAfuZHeaderInfo ()
 Returns the Z axis header information data of the AFU Data Record
Created in NX10.0.0. More...
 
NXOpen::CAE::AfuData::ExtrapolationType Extrapolation ()
 Returns the extrapolation type
Created in NX11.0.0. More...
 
NXString FileName ()
 Returns the name of AFU file
Created in NX4.0.0. More...
 
NXOpen::CAE::XyFunctionDataType FunctionDataType ()
 Returns the data type of the AFU Data Record
Created in NX5.0.0. More...
 
void GetAbscissaAndOrdinateAxisDefinition (NXOpen::CAE::AfuData::AbscissaType *abscissaType, NXOpen::CAE::XyFunctionUnit *xUnit, NXOpen::CAE::AfuData::OrdinateType *ordinateType, NXOpen::CAE::XyFunctionUnit *yUnit, NXOpen::CAE::XyFunctionUnit *yDenominatorUnit)
 Get the Abscissa and Ordinate Axis definitions of an AFU Data Record
Created in NX9.0.0. More...
 
std::vector< double > GetComplexData (std::vector< double > &xValues, std::vector< double > &yValues)
 Get the XY data of an AFU Data Record when the ordinate type is Complex. More...
 
void GetEvenData (double *xMinimum, double *xIncrement, int *numberOfPoints)
 Get the Abscissa Information for an AFU Data Record when the abscissa type is even
Created in NX4.0.0. More...
 
std::vector< double > GetRealData (std::vector< double > &xValues)
 Get the XY Data of an AFU Data Record when the ordinate type is real. More...
 
NXOpen::CAE::AfuData::InterpolationType Interpolation ()
 Returns the interpolation type
Created in NX11.0.0. More...
 
NXString RecordName ()
 Returns the name of the AFU Data Record
Created in NX4.0.0. More...
 
void SetAbscissaAndOrdinateAxisDefinition (NXOpen::CAE::XyFunctionUnit xUnit, NXOpen::CAE::AfuData::OrdinateType ordinateType, NXOpen::CAE::XyFunctionUnit yUnit, NXOpen::CAE::XyFunctionUnit yDenominatorUnit)
 Set the Abscissa and Ordinate Axis definitions of an AFU Data Record
Created in NX9.0.0. More...
 
void SetAfuAbscissaHeaderInfo (NXOpen::CAE::AfuAbscissaHeaderInfo *abscissaHeaderInfo)
 Sets the abscissa header information data of the AFU Data Record
Created in NX10.0.0. More...
 
void SetAfuHeaderId (NXOpen::CAE::AfuHeaderId *afuHeaderId)
 Sets the AFU Header Id data of the AFU Data Record
Created in NX5.0.0. More...
 
void SetAfuOrdinateHeaderInfo (NXOpen::CAE::AfuOrdinateHeaderInfo *ordinateHeaderInfo)
 Sets the ordinate header information data of the AFU Data Record
Created in NX10.0.0. More...
 
void SetAfuZHeaderInfo (NXOpen::CAE::AfuZHeaderInfo *zHeaderInfoP)
 Sets the Z axis header information data of the AFU Data Record
Created in NX10.0.0. More...
 
void SetComplexData (const std::vector< double > &xValues, const std::vector< double > &yValues, const std::vector< double > &zValues)
 Set the XY Data of an AFU record when the ordinate type is Complex
Created in NX4.0.0. More...
 
void SetComplexData (double xMinimum, double xIncrement, const std::vector< double > &yValues, const std::vector< double > &zValues)
 Set the XY Data of an AFU record when the ordinate type is Complex
Created in NX9.0.0. More...
 
void SetExtrapolation (NXOpen::CAE::AfuData::ExtrapolationType extrapolation)
 Sets the extrapolation type
Created in NX11.0.0. More...
 
void SetFileName (const NXString &afuFileName)
 Sets the name of AFU file
Created in NX4.0.0. More...
 
void SetFileName (const char *afuFileName)
 Sets the name of AFU file
Created in NX4.0.0. More...
 
void SetFunctionDataType (NXOpen::CAE::XyFunctionDataType functionDataType)
 Sets the data type of the AFU Data Record
Created in NX5.0.0. More...
 
void SetInterpolation (NXOpen::CAE::AfuData::InterpolationType interpolation)
 Sets the interpolation type
Created in NX11.0.0. More...
 
void SetRealData (const std::vector< double > &xValues, const std::vector< double > &yValues)
 Set the XY Data of an AFU Data Record when the ordinate type is real
Created in NX4.0.0. More...
 
void SetRealData (double xMinimum, double xIncrement, const std::vector< double > &yValues)
 Set the XY Data of an AFU Data Record when the ordinate type is real and the absicssa type is even
Created in NX9.0.0. More...
 
void SetRecordName (const NXString &afuRecordName)
 Sets the name of the AFU Data Record
Created in NX4.0.0. More...
 
void SetRecordName (const char *afuRecordName)
 Sets the name of the AFU Data Record
Created in NX4.0.0. More...
 
virtual ~AfuData ()
 Free the AFU Data transient object memory
Created in NX4.0.0. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

the data used to create an AFU Data Record
Created in NX4.0.0.


Member Enumeration Documentation

Defines abscissa data type for AFU data record.

Enumerator
AbscissaTypeEven 

The abscissa value is even and calculated by increment.

AbscissaTypeUneven 

The abscissa value is uneven and input by user.

AbscissaTypeSequence 

The abscissa value is a sequence and input by user.

Please don't use this value after NX9.0

Defines data extrapolation type for AFU data record.

Enumerator
ExtrapolationTypeLinear 

Linear Extrapolation.

ExtrapolationTypeParabolic 

Parabolic Extrapolation.

Defines data interpolation type for AFU data record.

Enumerator
InterpolationTypeCubic 

Cubic Interpolation.

InterpolationTypeAkima 

Akima Interpolation.

InterpolationTypeAkima72 

Akima72 Interpolation.

InterpolationTypeLinear 

Linear Interplolation.

Defines ordinate data type for AFU data record.

Enumerator
OrdinateTypeReal 

Ordinate Data is a single Real value.

OrdinateTypeRealImaginary 

Ordinate Data is Complex with Real and Imaginary values.

OrdinateTypeMagnitudePhase 

Ordinate Data is Complex with Amplitude and Phase values.

Constructor & Destructor Documentation

virtual NXOpen::CAE::AfuData::~AfuData ( )
virtual

Free the AFU Data transient object memory
Created in NX4.0.0.



License requirements : None

Member Function Documentation

NXOpen::CAE::AfuAbscissaHeaderInfo* NXOpen::CAE::AfuData::AfuAbscissaHeaderInfo ( )

Returns the abscissa header information data of the AFU Data Record
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::AfuHeaderId* NXOpen::CAE::AfuData::AfuHeaderId ( )

Returns the AFU Header Id data of the AFU Data Record
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::AfuOrdinateHeaderInfo* NXOpen::CAE::AfuData::AfuOrdinateHeaderInfo ( )

Returns the ordinate header information data of the AFU Data Record
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::AfuZHeaderInfo* NXOpen::CAE::AfuData::AfuZHeaderInfo ( )

Returns the Z axis header information data of the AFU Data Record
Created in NX10.0.0.



License requirements : None

NXOpen::CAE::AfuData::ExtrapolationType NXOpen::CAE::AfuData::Extrapolation ( )

Returns the extrapolation type
Created in NX11.0.0.



License requirements : None

NXString NXOpen::CAE::AfuData::FileName ( )

Returns the name of AFU file
Created in NX4.0.0.



License requirements : None

NXOpen::CAE::XyFunctionDataType NXOpen::CAE::AfuData::FunctionDataType ( )

Returns the data type of the AFU Data Record
Created in NX5.0.0.



License requirements : None

void NXOpen::CAE::AfuData::GetAbscissaAndOrdinateAxisDefinition ( NXOpen::CAE::AfuData::AbscissaType abscissaType,
NXOpen::CAE::XyFunctionUnit xUnit,
NXOpen::CAE::AfuData::OrdinateType ordinateType,
NXOpen::CAE::XyFunctionUnit yUnit,
NXOpen::CAE::XyFunctionUnit yDenominatorUnit 
)

Get the Abscissa and Ordinate Axis definitions of an AFU Data Record
Created in NX9.0.0.



License requirements : None

Parameters
abscissaTypeAbscissa specific data type
xUnitUnit Code of abscissa data
ordinateTypeOrdinate data type
yUnitUnit Code of ordinate data
yDenominatorUnitUnit Code of ordinate data
std::vector<double> NXOpen::CAE::AfuData::GetComplexData ( std::vector< double > &  xValues,
std::vector< double > &  yValues 
)

Get the XY data of an AFU Data Record when the ordinate type is Complex.

Returns
Ordinate element data values for imaginary part or phase part
Created in NX4.0.0.

License requirements : None
Parameters
xValuesAbscissa element data values
yValuesOrdinate element data values for real part or magnitude part
void NXOpen::CAE::AfuData::GetEvenData ( double *  xMinimum,
double *  xIncrement,
int *  numberOfPoints 
)

Get the Abscissa Information for an AFU Data Record when the abscissa type is even
Created in NX4.0.0.



License requirements : None

Parameters
xMinimumMinimum abscissa data value
xIncrementAbscissa increment
numberOfPointsNumber of abscissa elements
std::vector<double> NXOpen::CAE::AfuData::GetRealData ( std::vector< double > &  xValues)

Get the XY Data of an AFU Data Record when the ordinate type is real.

Returns
Ordinate element data values
Created in NX4.0.0.

License requirements : None
Parameters
xValuesAbscissa element data values
NXOpen::CAE::AfuData::InterpolationType NXOpen::CAE::AfuData::Interpolation ( )

Returns the interpolation type
Created in NX11.0.0.



License requirements : None

NXString NXOpen::CAE::AfuData::RecordName ( )

Returns the name of the AFU Data Record
Created in NX4.0.0.



License requirements : None

void NXOpen::CAE::AfuData::SetAbscissaAndOrdinateAxisDefinition ( NXOpen::CAE::XyFunctionUnit  xUnit,
NXOpen::CAE::AfuData::OrdinateType  ordinateType,
NXOpen::CAE::XyFunctionUnit  yUnit,
NXOpen::CAE::XyFunctionUnit  yDenominatorUnit 
)

Set the Abscissa and Ordinate Axis definitions of an AFU Data Record
Created in NX9.0.0.



License requirements : None

Parameters
xUnitUnit Code of abscissa data
ordinateTypeOrdinate data type
yUnitUnit Code of ordinate data
yDenominatorUnitUnit Code of ordinate data
void NXOpen::CAE::AfuData::SetAfuAbscissaHeaderInfo ( NXOpen::CAE::AfuAbscissaHeaderInfo abscissaHeaderInfo)

Sets the abscissa header information data of the AFU Data Record
Created in NX10.0.0.



License requirements : None

Parameters
abscissaHeaderInfoAbscissa header information data CAE::AfuAbscissaHeaderInfo to be set
void NXOpen::CAE::AfuData::SetAfuHeaderId ( NXOpen::CAE::AfuHeaderId afuHeaderId)

Sets the AFU Header Id data of the AFU Data Record
Created in NX5.0.0.



License requirements : None

Parameters
afuHeaderIdThe AFU Header Id data
void NXOpen::CAE::AfuData::SetAfuOrdinateHeaderInfo ( NXOpen::CAE::AfuOrdinateHeaderInfo ordinateHeaderInfo)

Sets the ordinate header information data of the AFU Data Record
Created in NX10.0.0.



License requirements : None

Parameters
ordinateHeaderInfoOrdindate header information data CAE::AfuOrdinateHeaderInfo to be set
void NXOpen::CAE::AfuData::SetAfuZHeaderInfo ( NXOpen::CAE::AfuZHeaderInfo zHeaderInfoP)

Sets the Z axis header information data of the AFU Data Record
Created in NX10.0.0.



License requirements : None

Parameters
zHeaderInfoPZ axis header information data CAE::AfuZHeaderInfo to be set
void NXOpen::CAE::AfuData::SetComplexData ( const std::vector< double > &  xValues,
const std::vector< double > &  yValues,
const std::vector< double > &  zValues 
)

Set the XY Data of an AFU record when the ordinate type is Complex
Created in NX4.0.0.



License requirements : None

Parameters
xValuesAbscissa element data values
yValuesOrdinate element data values for real part or magnitude part
zValuesOrdinate element data values for imaginary part or phase part
void NXOpen::CAE::AfuData::SetComplexData ( double  xMinimum,
double  xIncrement,
const std::vector< double > &  yValues,
const std::vector< double > &  zValues 
)

Set the XY Data of an AFU record when the ordinate type is Complex
Created in NX9.0.0.



License requirements : None

Parameters
xMinimumMinimum abscissa data value
xIncrementAbscissa increment
yValuesOrdinate element data values for real part or magnitude part
zValuesOrdinate element data values for imaginary part or phase part
void NXOpen::CAE::AfuData::SetExtrapolation ( NXOpen::CAE::AfuData::ExtrapolationType  extrapolation)

Sets the extrapolation type
Created in NX11.0.0.



License requirements : None

Parameters
extrapolationthe extrapolation method
void NXOpen::CAE::AfuData::SetFileName ( const NXString afuFileName)

Sets the name of AFU file
Created in NX4.0.0.



License requirements : None

Parameters
afuFileNameThe full name of the AFU file
void NXOpen::CAE::AfuData::SetFileName ( const char *  afuFileName)

Sets the name of AFU file
Created in NX4.0.0.



License requirements : None

Parameters
afuFileNameThe full name of the AFU file
void NXOpen::CAE::AfuData::SetFunctionDataType ( NXOpen::CAE::XyFunctionDataType  functionDataType)

Sets the data type of the AFU Data Record
Created in NX5.0.0.



License requirements : None

Parameters
functionDataTypeThe data type of a function in AFU
void NXOpen::CAE::AfuData::SetInterpolation ( NXOpen::CAE::AfuData::InterpolationType  interpolation)

Sets the interpolation type
Created in NX11.0.0.



License requirements : None

Parameters
interpolationthe interpolation method
void NXOpen::CAE::AfuData::SetRealData ( const std::vector< double > &  xValues,
const std::vector< double > &  yValues 
)

Set the XY Data of an AFU Data Record when the ordinate type is real
Created in NX4.0.0.



License requirements : None

Parameters
xValuesAbscissa element data values
yValuesOrdinate element data values
void NXOpen::CAE::AfuData::SetRealData ( double  xMinimum,
double  xIncrement,
const std::vector< double > &  yValues 
)

Set the XY Data of an AFU Data Record when the ordinate type is real and the absicssa type is even
Created in NX9.0.0.



License requirements : None

Parameters
xMinimumMinimum abscissa data value
xIncrementAbscissa increment
yValuesOrdinate element data values
void NXOpen::CAE::AfuData::SetRecordName ( const NXString afuRecordName)

Sets the name of the AFU Data Record
Created in NX4.0.0.



License requirements : None

Parameters
afuRecordNameThe name of AFU Data Record
void NXOpen::CAE::AfuData::SetRecordName ( const char *  afuRecordName)

Sets the name of the AFU Data Record
Created in NX4.0.0.



License requirements : None

Parameters
afuRecordNameThe name of AFU Data Record

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