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

Inheritance diagram for NXOpen::CAE::AfuData:

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::AfuHeaderId *	AfuHeaderId ()
	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	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.

void	GetAxisDefinition (NXOpen::CAE::AfuData::AbscissaType abscissaType, NXOpen::CAE::XyFunctionUnit xUnit, NXOpen::CAE::AfuData::OrdinateType oridinateType, NXOpen::CAE::XyFunctionUnit yUnit)
	Get the Abscissa and Ordinate Axis definitions of an AFU Data Record

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	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.

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 and Ordinate Axis definitions of an AFU Data Record

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	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.

void	SetEvenData (double xMinimum, double xIncrement, int numberOfPoints)
	Set the Abscissa Information for AFU Data Record when abscissa type is even

void	SetFileName (const NXString &afuFileName)
	Sets the name of AFU file Created in NX4.0.0.

void	SetFileName (const char *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	SetIdInformation (const char reference, int referenceId, const char 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	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.

void	SetRecordName (const NXString &afuRecordName)
	Sets the name of the AFU Data Record Created in NX4.0.0.

void	SetRecordName (const char *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.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

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

Member Enumeration Documentation

enum NXOpen::CAE::AfuData::AbscissaType

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

enum NXOpen::CAE::AfuData::OrdinateType

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::AfuHeaderId* NXOpen::CAE::AfuData::AfuHeaderId ( )

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

License requirements : nx_ftk ("NX Advanced Graphing")

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

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

License requirements : nx_ftk ("NX Advanced Graphing")

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

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

License requirements : nx_ftk ("NX Advanced Graphing")

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 : nx_ftk ("NX Advanced Graphing")

Parameters

abscissaType	Abscissa specific data type
xUnit	Unit Code of abscissa data
ordinateType	Ordinate data type
yUnit	Unit Code of ordinate data
yDenominatorUnit	Unit Code of ordinate data

void NXOpen::CAE::AfuData::GetAxisDefinition	(	NXOpen::CAE::AfuData::AbscissaType *	abscissaType,
		NXOpen::CAE::XyFunctionUnit *	xUnit,
		NXOpen::CAE::AfuData::OrdinateType *	oridinateType,
		NXOpen::CAE::XyFunctionUnit *	yUnit
	)

Get the Abscissa and Ordinate Axis definitions of an AFU Data Record

Deprecated:: Deprecated in NX9.0.0.

Use AfuData::GetAbscissaAndOrdinateAxisDefinition with Denominator.

Created in NX4.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

abscissaType	Abscissa specific data type
xUnit	Unit Code of abscissa data
oridinateType	Ordinate data type
yUnit	Unit 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

xValues	Abscissa element data values
yValues	Ordinate 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

xMinimum	Minimum abscissa data value
xIncrement	Abscissa increment
numberOfPoints	Number 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

reference	String 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 )
referenceId	ID of reference element or node
response	String 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 )
responseId	ID 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

xValues Abscissa element data values

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

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

License requirements : nx_ftk ("NX Advanced Graphing")

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 : nx_ftk ("NX Advanced Graphing")

Parameters

xUnit	Unit Code of abscissa data
ordinateType	Ordinate data type
yUnit	Unit Code of ordinate data
yDenominatorUnit	Unit Code of ordinate data

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 : nx_ftk ("NX Advanced Graphing")

Parameters

afuHeaderId The AFU Header Id data

void NXOpen::CAE::AfuData::SetAxisDefinition	(	NXOpen::CAE::AfuData::AbscissaType	abscissaType,
		NXOpen::CAE::XyFunctionUnit	xUnit,
		NXOpen::CAE::AfuData::OrdinateType	oridinateType,
		NXOpen::CAE::XyFunctionUnit	yUnit
	)

Set the Abscissa and Ordinate Axis definitions of an AFU Data Record

Deprecated:: Deprecated in NX9.0.0.

Use AfuData::SetAbscissaAndOrdinateAxisDefinition with Denominator.

Created in NX4.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

abscissaType	Abscissa specific data type
xUnit	Unit Code of abscissa data
oridinateType	Ordinate specific data type
yUnit	Unit 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

xValues	Abscissa element data values
yValues	Ordinate element data values for real part or magnitude part
zValues	Ordinate 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 : nx_ftk ("NX Advanced Graphing")

Parameters

xMinimum	Minimum abscissa data value
xIncrement	Abscissa increment
yValues	Ordinate element data values for real part or magnitude part
zValues	Ordinate 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

Deprecated:: Deprecated in NX9.0.0.

Use AfuData::SetRealData or AfuData::SetComplexData that takes minimum abscissa value and increment instead.

Created in NX4.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

xMinimum	Minimum abscissa data value
xIncrement	Abscissa increment
numberOfPoints	Number 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

afuFileName The 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 : nx_ftk ("NX Advanced Graphing")

Parameters

afuFileName The 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 : nx_ftk ("NX Advanced Graphing")

Parameters

functionDataType The 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

reference	String 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.
referenceId	ID of reference element or node
response	String 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.
responseId	ID of response element or node

void NXOpen::CAE::AfuData::SetIdInformation	(	const char *	reference,
		int	referenceId,
		const char *	response,
		int	responseId
	)

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

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

reference	String 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.
referenceId	ID of reference element or node
response	String 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.
responseId	ID 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

xValues	Abscissa element data values
yValues	Ordinate 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 : nx_ftk ("NX Advanced Graphing")

Parameters

xMinimum	Minimum abscissa data value
xIncrement	Abscissa increment
yValues	Ordinate 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

afuRecordName The 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 : nx_ftk ("NX Advanced Graphing")

Parameters

afuRecordName The name of AFU Data Record

The documentation for this class was generated from the following file:

CAE_AfuData.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation