NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.CAE.AfuData Class Reference

the data used to create an AFU Data Record More...

Inheritance diagram for NXOpen.CAE.AfuData:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Types

enum  AbscissaType { Even, Uneven, Sequence }
 Defines abscissa data type for AFU data record More...
 
enum  ExtrapolationType { Linear, Parabolic }
 Defines data extrapolation type for AFU data record More...
 
enum  InterpolationType { Cubic, Akima, Akima72, Linear }
 Defines data interpolation type for AFU data record More...
 
enum  OrdinateType { Real, RealImaginary, MagnitudePhase }
 Defines ordinate data type for AFU data record More...
 

Public Member Functions

unsafe void GetAbscissaAndOrdinateAxisDefinition (out NXOpen.CAE.AfuData.AbscissaType abscissaType, out NXOpen.CAE.XyFunctionUnit xUnit, out NXOpen.CAE.AfuData.OrdinateType ordinateType, out NXOpen.CAE.XyFunctionUnit yUnit, out NXOpen.CAE.XyFunctionUnit yDenominatorUnit)
 Get the Abscissa and Ordinate Axis definitions of an AFU Data Record More...
 
unsafe double[] GetComplexData (out double[] xValues, out double[] yValues)
 Get the XY data of an AFU Data Record when the ordinate type is Complex More...
 
unsafe void GetEvenData (out double xMinimum, out double xIncrement, out int numberOfPoints)
 Get the Abscissa Information for an AFU Data Record when the abscissa type is even More...
 
unsafe double[] GetRealData (out double[] xValues)
 Get the XY Data of an AFU Data Record when the ordinate type is real More...
 
unsafe 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 More...
 
unsafe void SetComplexData (double[] xValues, double[] yValues, double[] zValues)
 Set the XY Data of an AFU record when the ordinate type is Complex More...
 
unsafe void SetComplexData (double xMinimum, double xIncrement, double[] yValues, double[] zValues)
 Set the XY Data of an AFU record when the ordinate type is Complex More...
 
unsafe void SetRealData (double[] xValues, double[] yValues)
 Set the XY Data of an AFU Data Record when the ordinate type is real More...
 
unsafe void SetRealData (double xMinimum, double xIncrement, double[] yValues)
 Set the XY Data of an AFU Data Record when the ordinate type is real and the absicssa type is even More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override void FreeResource ()
 Free the AFU Data transient object memory More...
 

Properties

unsafe
NXOpen.CAE.AfuAbscissaHeaderInfo 
AfuAbscissaHeaderInfo [get, set]
 Returns or sets the abscissa header information data of the AFU Data Record More...
 
unsafe NXOpen.CAE.AfuHeaderId AfuHeaderId [get, set]
 Returns or sets the AFU Header Id data of the AFU Data Record More...
 
unsafe
NXOpen.CAE.AfuOrdinateHeaderInfo 
AfuOrdinateHeaderInfo [get, set]
 Returns or sets the ordinate header information data of the AFU Data Record More...
 
unsafe NXOpen.CAE.AfuZHeaderInfo AfuZHeaderInfo [get, set]
 Returns or sets the Z axis header information data of the AFU Data Record More...
 
unsafe
NXOpen.CAE.AfuData.ExtrapolationType 
Extrapolation [get, set]
 Returns or sets the extrapolation type More...
 
unsafe string FileName [get, set]
 Returns or sets the name of AFU file More...
 
unsafe
NXOpen.CAE.XyFunctionDataType 
FunctionDataType [get, set]
 Returns or sets the data type of the AFU Data Record More...
 
unsafe
NXOpen.CAE.AfuData.InterpolationType 
Interpolation [get, set]
 Returns or sets the interpolation type More...
 
unsafe string RecordName [get, set]
 Returns or sets the name of the AFU Data Record More...
 
- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. 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
Even 

The abscissa value is even and calculated by increment

Uneven 

The abscissa value is uneven and input by user

Sequence 

The abscissa value is a sequence and input by user.

Deprecated in NX13.0; This enum type has no replacement. It is no longer supported.

Defines data extrapolation type for AFU data record

Enumerator
Linear 

Linear Extrapolation

Parabolic 

Parabolic Extrapolation

Defines data interpolation type for AFU data record

Enumerator
Cubic 

Cubic Interpolation

Akima 

Akima Interpolation

Akima72 

Akima72 Interpolation

Linear 

Linear Interplolation

Defines ordinate data type for AFU data record

Enumerator
Real 

Ordinate Data is a single Real value

RealImaginary 

Ordinate Data is Complex with Real and Imaginary values

MagnitudePhase 

Ordinate Data is Complex with Amplitude and Phase values

Member Function Documentation

override void NXOpen.CAE.AfuData.FreeResource ( )
inlineprotectedvirtual

Free the AFU Data transient object memory

Created in NX4.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe void NXOpen.CAE.AfuData.GetAbscissaAndOrdinateAxisDefinition ( out NXOpen.CAE.AfuData.AbscissaType  abscissaType,
out NXOpen.CAE.XyFunctionUnit  xUnit,
out NXOpen.CAE.AfuData.OrdinateType  ordinateType,
out NXOpen.CAE.XyFunctionUnit  yUnit,
out NXOpen.CAE.XyFunctionUnit  yDenominatorUnit 
)
inline

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
unsafe double [] NXOpen.CAE.AfuData.GetComplexData ( out double[]  xValues,
out double[]  yValues 
)
inline

Get the XY data of an AFU Data 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
Returns
Ordinate element data values for imaginary part or phase part
unsafe void NXOpen.CAE.AfuData.GetEvenData ( out double  xMinimum,
out double  xIncrement,
out int  numberOfPoints 
)
inline

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
unsafe double [] NXOpen.CAE.AfuData.GetRealData ( out double[]  xValues)
inline

Get 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
Returns
Ordinate element data values
unsafe void NXOpen.CAE.AfuData.SetAbscissaAndOrdinateAxisDefinition ( NXOpen.CAE.XyFunctionUnit  xUnit,
NXOpen.CAE.AfuData.OrdinateType  ordinateType,
NXOpen.CAE.XyFunctionUnit  yUnit,
NXOpen.CAE.XyFunctionUnit  yDenominatorUnit 
)
inline

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
unsafe void NXOpen.CAE.AfuData.SetComplexData ( double[]  xValues,
double[]  yValues,
double[]  zValues 
)
inline

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
unsafe void NXOpen.CAE.AfuData.SetComplexData ( double  xMinimum,
double  xIncrement,
double[]  yValues,
double[]  zValues 
)
inline

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
unsafe void NXOpen.CAE.AfuData.SetRealData ( double[]  xValues,
double[]  yValues 
)
inline

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
unsafe void NXOpen.CAE.AfuData.SetRealData ( double  xMinimum,
double  xIncrement,
double[]  yValues 
)
inline

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

Property Documentation

unsafe NXOpen.CAE.AfuAbscissaHeaderInfo NXOpen.CAE.AfuData.AfuAbscissaHeaderInfo
getset

Returns or sets the abscissa header information data of the AFU Data Record

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.AfuHeaderId NXOpen.CAE.AfuData.AfuHeaderId
getset

Returns or sets the AFU Header Id data of the AFU Data Record

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.AfuOrdinateHeaderInfo NXOpen.CAE.AfuData.AfuOrdinateHeaderInfo
getset

Returns or sets the ordinate header information data of the AFU Data Record

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.AfuZHeaderInfo NXOpen.CAE.AfuData.AfuZHeaderInfo
getset

Returns or sets the Z axis header information data of the AFU Data Record

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.AfuData.ExtrapolationType NXOpen.CAE.AfuData.Extrapolation
getset

Returns or sets the extrapolation type

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.CAE.AfuData.FileName
getset

Returns or sets the name of AFU file

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.XyFunctionDataType NXOpen.CAE.AfuData.FunctionDataType
getset

Returns or sets the data type of the AFU Data Record

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.AfuData.InterpolationType NXOpen.CAE.AfuData.Interpolation
getset

Returns or sets the interpolation type

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.CAE.AfuData.RecordName
getset

Returns or sets the name of the AFU Data Record

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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