NX Open C++ Reference Guide
Public Member Functions
NXOpen::CAE::FunctionBuilder Class Reference

This builder class is used to create or edit CAE::Function objects. More...

Inheritance diagram for NXOpen::CAE::FunctionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Member Functions

std::vector< NXStringGetDefinitions ()
 Returns definition strings of a math function.
void GetMathPlotData (int *dataCount, double *xMinimum, double *xIncrement)
 Returns plot data setting of a math function.
std::vector
< NXOpen::CAE::Function * > 
GetReferencedObjects ()
 Returns referenced objects of a math function.
void GetTableData (int *recordIndex, NXString *recordName, NXString *recordTimestamp, NXOpen::CAE::Function::InterpolationMethod *interpolateMethod)
 Returns data of a table function.
void GetTypes (NXOpen::CAE::Function::Type *functionType, NXOpen::CAE::XyFunctionMacroType *macroType, NXOpen::CAE::XyFunctionGeneralType *generalType)
 Returns types of a function
Created in NX5.0.0.
void GetUnits (NXOpen::CAE::XyFunctionUnit *xUnit, NXOpen::CAE::XyFunctionUnit *yUnit, NXOpen::CAE::XyFunctionUnit *frfUnit)
 Returns units of a function
Created in NX5.0.0.
NXString Name ()
 Returns the function name.
void SetDefinitions (std::vector< NXString > &definitions)
 Sets definition strings of a math function.
void SetMathPlotData (int dataCount, double xMinimum, double xIncrement)
 Sets plot data setting for a math function.
void SetName (const NXString &name)
 Sets the function name.
void SetReferencedObjects (const std::vector< NXOpen::CAE::Function * > &objects)
 Sets referenced objects of a math function.
void SetTableData (int recordIndex, const NXString &recordName, const NXString &recordTimestamp, NXOpen::CAE::Function::InterpolationMethod interpolateMethod)
 Sets data for a table function.
void SetTypes (NXOpen::CAE::Function::Type functionType, NXOpen::CAE::XyFunctionMacroType macroType, NXOpen::CAE::XyFunctionGeneralType generalType)
 Sets types of a function
Created in NX5.0.0.
void SetUnits (NXOpen::CAE::XyFunctionUnit xUnit, NXOpen::CAE::XyFunctionUnit yUnit, NXOpen::CAE::XyFunctionUnit frfUnit)
 Sets units of a function
Created in NX5.0.0.

Detailed Description

This builder class is used to create or edit CAE::Function objects.

All: CAE::FunctionBuilder::SetName , CAE::FunctionBuilder::SetTypes , CAE::FunctionBuilder::SetUnits ;

formula: CAE::FunctionBuilder::SetDefinitions , CAE::FunctionBuilder::SetReferencedObjects , CAE::FunctionBuilder::SetMathPlotData ;

table function: CAE::FunctionBuilder::SetTableData .
To create a new instance of this class, use CAE::FunctionCollection::CreateFunctionBuilder


Member Function Documentation

Returns definition strings of a math function.

Only used when function type is CAE::Function::TypeMath

Returns:

Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
void NXOpen::CAE::FunctionBuilder::GetMathPlotData ( int *  dataCount,
double *  xMinimum,
double *  xIncrement 
)

Returns plot data setting of a math function.

Only used when function type is CAE::Function::TypeMath
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
dataCountdata count
xMinimumx minimum
xIncrementx increment

Returns referenced objects of a math function.

Only used when function type is CAE::Function::TypeMath

Returns:

Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")
void NXOpen::CAE::FunctionBuilder::GetTableData ( int *  recordIndex,
NXString recordName,
NXString recordTimestamp,
NXOpen::CAE::Function::InterpolationMethod interpolateMethod 
)

Returns data of a table function.

Only used when function type is CAE::Function::TypeTable
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
recordIndexBegins with one
recordNamerecord name
recordTimestampA time string indicating the last creating or editing time of an afu record
interpolateMethodinterpolate method

Returns types of a function
Created in NX5.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
functionTypeMath function or Table function
macroTypeFor Motion Simulation or Advanced Simulation or General Purpose
generalTypeData type of function

Returns units of a function
Created in NX5.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
xUnitx unit
yUnity unit
frfUnitfrf unit

Returns the function name.

For math function, the name is function name. For table function, the name is the AFU file name with directory
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

void NXOpen::CAE::FunctionBuilder::SetDefinitions ( std::vector< NXString > &  definitions)

Sets definition strings of a math function.

Only used when function type is CAE::Function::TypeMath
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
definitions
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAE::FunctionBuilder::SetMathPlotData ( int  dataCount,
double  xMinimum,
double  xIncrement 
)

Sets plot data setting for a math function.

Only used when function type is CAE::Function::TypeMath
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
dataCountdata count
xMinimumx minimum
xIncrementx increment

Sets the function name.

For math function, the name is function name. For table function, the name is the AFU file name with directory
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
namename

Sets referenced objects of a math function.

Only used when function type is CAE::Function::TypeMath
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
objectsobjects
void NXOpen::CAE::FunctionBuilder::SetTableData ( int  recordIndex,
const NXString recordName,
const NXString recordTimestamp,
NXOpen::CAE::Function::InterpolationMethod  interpolateMethod 
)

Sets data for a table function.

Only used when function type is CAE::Function::TypeTable
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
recordIndexBegins with one
recordName
NOTE: The full Unicode character set is not supported for this parameter.
recordTimestampA time string indicating the creating or editing time of an afu record. The string could be returned by CAE::AfuManager::CreateRecord or CAE::AfuManager::EditRecord or CAE::AfuManager::GetAfuData
NOTE: The full Unicode character set is not supported for this parameter.
interpolateMethodinterpolate method

Sets units of a function
Created in NX5.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
xUnitx unit
yUnity unit
frfUnitfrf unit

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