NX Open C++ Reference Guide
Public Types | Public Member Functions
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

List of all members.

Public Types

enum  AbscissaType { AbscissaTypeEven, AbscissaTypeUneven, AbscissaTypeSequence }
 Defines abscissa data 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::AfuHeaderIdAfuHeaderId ()
 Returns the AFU Header Id data of the AFU Data Record
Created in NX5.0.0.
NXString FileName ()
 Returns the name of AFU file
Created in NX4.0.0.
NXOpen::CAE::XyFunctionDataType FunctionDataType ()
 Returns the data type of the AFU Data Record
Created in NX5.0.0.
void GetAxisDefinition (NXOpen::CAE::AfuData::AbscissaType *abscissaType, NXOpen::CAE::XyFunctionUnit *xUnit, NXOpen::CAE::AfuData::OrdinateType *oridinateType, NXOpen::CAE::XyFunctionUnit *yUnit)
 Get the Abscissa Axis definitions of an AFU Data Record
Created in NX4.0.0.
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.
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.
void GetIdInformation (NXString *reference, int *referenceId, NXString *response, int *responseId)
 Returns main AFU Data Record ID information
Created in NX4.0.0.
std::vector< double > GetRealData (std::vector< double > &xValues)
 Get the XY Data of an AFU Data Record when the ordinate type is real.
NXString RecordName ()
 Returns the name of the AFU Data Record
Created in NX4.0.0.
void SetAfuHeaderId (NXOpen::CAE::AfuHeaderId *afuHeaderId)
 Sets the AFU Header Id data of the AFU Data Record
Created in NX5.0.0.
void SetAxisDefinition (NXOpen::CAE::AfuData::AbscissaType abscissaType, NXOpen::CAE::XyFunctionUnit xUnit, NXOpen::CAE::AfuData::OrdinateType oridinateType, NXOpen::CAE::XyFunctionUnit yUnit)
 Set the Abscissa Axis definitions of an AFU Data Record
Created in NX4.0.0.
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.
void SetEvenData (double xMinimum, double xIncrement, int numberOfPoints)
 Set the Abscissa Information for AFU Data Record when abscissa type is even
Created in NX4.0.0.
void SetFileName (const NXString &afuFileName)
 Sets the name of AFU file
Created in NX4.0.0.
void SetFunctionDataType (NXOpen::CAE::XyFunctionDataType functionDataType)
 Sets the data type of the AFU Data Record
Created in NX5.0.0.
void SetIdInformation (const NXString &reference, int referenceId, const NXString &response, int responseId)
 Sets the main AFU Data Record ID information
Created in NX4.0.0.
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.
void SetRecordName (const NXString &afuRecordName)
 Sets the name of the AFU Data Record
Created in NX4.0.0.
virtual ~AfuData ()
 Free the AFU Data transient object memory
Created in NX4.0.0.

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.

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

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



License requirements : nx_ftk ("NX Advanced Graphing")

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



License requirements : nx_ftk ("NX Advanced Graphing")

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



License requirements : nx_ftk ("NX Advanced Graphing")

Get the Abscissa Axis definitions of an AFU Data Record
Created in NX4.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
abscissaTypeAbscissa specific data type
xUnitUnit Code of abscissa data
oridinateTypeOrdinate specific data type
yUnitUnit 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 : nx_ftk ("NX Advanced Graphing")
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 : nx_ftk ("NX Advanced Graphing")

Parameters:
xMinimumMinimum abscissa data value
xIncrementAbscissa increment
numberOfPointsNumber of abscissa elements
void NXOpen::CAE::AfuData::GetIdInformation ( NXString reference,
int *  referenceId,
NXString response,
int *  responseId 
)

Returns main AFU Data Record ID information
Created in NX4.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
referenceString to define reference direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a "+" or "-" as the last character. examples: ABC+ RSTU )
referenceIdID of reference element or node
responseString to define response direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a "+" or "-" as the last character. examples: ABC+ RSTU )
responseIdID of response element or node
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 : nx_ftk ("NX Advanced Graphing")
Parameters:
xValuesAbscissa element data values

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



License requirements : nx_ftk ("NX Advanced Graphing")

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



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
afuHeaderIdThe AFU Header Id data

Set the Abscissa Axis definitions of an AFU Data Record
Created in NX4.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
abscissaTypeAbscissas specific data type
xUnitUnit Code of abscissa data
oridinateTypeOrdinate specific data type
yUnitUnit Code of ordinate data
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 : nx_ftk ("NX Advanced Graphing")

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::SetEvenData ( double  xMinimum,
double  xIncrement,
int  numberOfPoints 
)

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



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
xMinimumMinimum abscissa data value
xIncrementAbscissa increment
numberOfPointsNumber of abscissa elements
void NXOpen::CAE::AfuData::SetFileName ( const NXString afuFileName)

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



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameThe full name of the AFU file

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



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
functionDataTypeThe data type of a function in AFU
void NXOpen::CAE::AfuData::SetIdInformation ( const NXString reference,
int  referenceId,
const NXString response,
int  responseId 
)

Sets the main AFU Data Record ID information
Created in NX4.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
referenceString to define reference direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a "+" or "-" as the last character. examples: ABC+ RSTU )
NOTE: The full Unicode character set is not supported for this parameter.
referenceIdID of reference element or node
responseString to define response direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a "+" or "-" as the last character. examples: ABC+ RSTU )
NOTE: The full Unicode character set is not supported for this parameter.
responseIdID of response element or node
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 : nx_ftk ("NX Advanced Graphing")

Parameters:
xValuesAbscissa element data values
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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuRecordNameThe name of AFU Data Record

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