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

Provides methods to evaluate curve expressions. More...

Public Member Functions

NXOpen::CAE::Xyplot::PlotCreatePlot (int deviceIndex, int viewIndex, NXOpen::CAE::FTK::ArrayRecord2D *arrayRecord)
 Creates a plot on the graphic window. More...
 
NXOpen::CAE::FTK::ArrayRecord2DEvaluateCurveExpressionStrings (const NXString &recordName, NXOpen::CAE::XyFunctionDataComplexType dataType, std::vector< NXString > &curveExpressionStrings)
 Generates array record data(see NXOpen::CAE::FTK::ArrayRecord2D ) by evaluating an array of curve expressions. More...
 
NXOpen::CAE::FTK::ArrayRecord2DEvaluateCurveExpressionStrings (const char *recordName, NXOpen::CAE::XyFunctionDataComplexType dataType, std::vector< NXString > &curveExpressionStrings)
 Generates array record data(see NXOpen::CAE::FTK::ArrayRecord2D ) by evaluating an array of curve expressions. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void ValidateCurveExpressionString (const NXString &curveExpressionString, bool isNeedToPrintErrorMessages)
 Validates curve expression string. More...
 
void ValidateCurveExpressionString (const char *curveExpressionString, bool isNeedToPrintErrorMessages)
 Validates curve expression string. More...
 

Detailed Description

Provides methods to evaluate curve expressions.


A curve expressions can consist of math functions, curve variables, and expressions (see NXOpen::Expression ). Curve expression could be evaluated to generate a data list to represent a data component of a record.


Curve variable is a function. It denotes a data list of curve. For curve expression curve("w1v0p0r0c0","x")+sin(50), curve variable is curve("w1v0p0r0c0","x"). It consists of two parts:curve identifier and data dimension. For curve variable curve("w1v0p0r0c0","x"), curve identifier is w1v0p0r0c0 and data dimension is x.


To obtain an instance of this class use NXOpen::Session::CurveOperation .

Created in NX1847.0.0.

Member Function Documentation

NXOpen::CAE::Xyplot::Plot* NXOpen::CAE::CurveOperation::CreatePlot ( int  deviceIndex,
int  viewIndex,
NXOpen::CAE::FTK::ArrayRecord2D arrayRecord 
)

Creates a plot on the graphic window.


Created in NX1847.0.0.

License requirements : None

Parameters
deviceIndexdeviceindex
viewIndexviewindex
arrayRecordarrayrecord
NXOpen::CAE::FTK::ArrayRecord2D* NXOpen::CAE::CurveOperation::EvaluateCurveExpressionStrings ( const NXString recordName,
NXOpen::CAE::XyFunctionDataComplexType  dataType,
std::vector< NXString > &  curveExpressionStrings 
)

Generates array record data(see NXOpen::CAE::FTK::ArrayRecord2D ) by evaluating an array of curve expressions.

Do math operation on displayed curves on existing XY graph to create new record data or update an existing record data.


For different function data complex type, the curve expressions amount is limited. And the elements of curve expression array needs to follow some orders.

  1. For NXOpen::CAE::XyFunctionDataComplexType::RealOnly , curve expression array consists of two elements. The first element is X curve expression, the second element is Y curve expression.
  2. For NXOpen::CAE::XyFunctionDataComplexType::RealImaginary , curve expression array consists of three elements. The first element is X curve expression, the second element is Real curve expression, the third element is Imaginary curve expression.
  3. For NXOpen::CAE::XyFunctionDataComplexType::MagnitudePhase , curve expression array consists of three elements.The first element is X curve expression, the second element is Magnitude curve expression, the third element is Phase curve expression.



Created in NX1847.0.0.

License requirements : None

Parameters
recordNamerecordname
dataTypedatatype
curveExpressionStringscurveexpressionstrings
NXOpen::CAE::FTK::ArrayRecord2D* NXOpen::CAE::CurveOperation::EvaluateCurveExpressionStrings ( const char *  recordName,
NXOpen::CAE::XyFunctionDataComplexType  dataType,
std::vector< NXString > &  curveExpressionStrings 
)

Generates array record data(see NXOpen::CAE::FTK::ArrayRecord2D ) by evaluating an array of curve expressions.

Do math operation on displayed curves on existing XY graph to create new record data or update an existing record data.


For different function data complex type, the curve expressions amount is limited. And the elements of curve expression array needs to follow some orders.

  1. For NXOpen::CAE::XyFunctionDataComplexType::RealOnly , curve expression array consists of two elements. The first element is X curve expression, the second element is Y curve expression.
  2. For NXOpen::CAE::XyFunctionDataComplexType::RealImaginary , curve expression array consists of three elements. The first element is X curve expression, the second element is Real curve expression, the third element is Imaginary curve expression.
  3. For NXOpen::CAE::XyFunctionDataComplexType::MagnitudePhase , curve expression array consists of three elements.The first element is X curve expression, the second element is Magnitude curve expression, the third element is Phase curve expression.



Created in NX1847.0.0.

License requirements : None

Parameters
recordNamerecordname
dataTypedatatype
curveExpressionStringscurveexpressionstrings
tag_t NXOpen::CAE::CurveOperation::Tag ( ) const

Returns the tag of this object.

void NXOpen::CAE::CurveOperation::ValidateCurveExpressionString ( const NXString curveExpressionString,
bool  isNeedToPrintErrorMessages 
)

Validates curve expression string.

Prints error validation message to listing window if failing to validate and being required for output .
Created in NX1847.0.0.

License requirements : None

Parameters
curveExpressionStringcurveexpressionstring
isNeedToPrintErrorMessagesisneedtoprinterrormessages
void NXOpen::CAE::CurveOperation::ValidateCurveExpressionString ( const char *  curveExpressionString,
bool  isNeedToPrintErrorMessages 
)

Validates curve expression string.

Prints error validation message to listing window if failing to validate and being required for output .
Created in NX1847.0.0.

License requirements : None

Parameters
curveExpressionStringcurveexpressionstring
isNeedToPrintErrorMessagesisneedtoprinterrormessages

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