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

Inheritance diagram for NXOpen::CAE::FunctionBuilder:

Public Member Functions
std::vector< NXString >	GetDefinitions ()
	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	SetName (const char *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	SetTableData (int recordIndex, const char recordName, const char 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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

Created in NX5.0.0.

Member Function Documentation

std::vector<NXString> NXOpen::CAE::FunctionBuilder::GetDefinitions ( )

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

dataCount	data count
xMinimum	x minimum
xIncrement	x increment

std::vector<NXOpen::CAE::Function *> NXOpen::CAE::FunctionBuilder::GetReferencedObjects ( )

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

recordIndex	Begins with one
recordName	record name
recordTimestamp	A time string indicating the last creating or editing time of an afu record
interpolateMethod	interpolate method

void NXOpen::CAE::FunctionBuilder::GetTypes	(	NXOpen::CAE::Function::Type *	functionType,
		NXOpen::CAE::XyFunctionMacroType *	macroType,
		NXOpen::CAE::XyFunctionGeneralType *	generalType
	)

Returns types of a function
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

functionType	Math function or Table function
macroType	For Motion Simulation or Advanced Simulation or General Purpose
generalType	Data type of function

void NXOpen::CAE::FunctionBuilder::GetUnits	(	NXOpen::CAE::XyFunctionUnit *	xUnit,
		NXOpen::CAE::XyFunctionUnit *	yUnit,
		NXOpen::CAE::XyFunctionUnit *	frfUnit
	)

Returns units of a function
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

xUnit	x unit
yUnit	y unit
frfUnit	frf unit

NXString NXOpen::CAE::FunctionBuilder::Name ( )

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

dataCount	data count
xMinimum	x minimum
xIncrement	x increment

void NXOpen::CAE::FunctionBuilder::SetName ( const NXString & name )

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

name name

void NXOpen::CAE::FunctionBuilder::SetName ( const char * name )

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

name name

void NXOpen::CAE::FunctionBuilder::SetReferencedObjects ( const std::vector< NXOpen::CAE::Function * > & objects )

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

objects objects

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

recordIndex	Begins with one
recordName	NOTE: The full Unicode character set is not supported for this parameter.
recordTimestamp	A 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.
interpolateMethod	interpolate method

void NXOpen::CAE::FunctionBuilder::SetTableData	(	int	recordIndex,
		const char *	recordName,
		const char *	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

recordIndex	Begins with one
recordName	NOTE: The full Unicode character set is not supported for this parameter.
recordTimestamp	A 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.
interpolateMethod	interpolate method

void NXOpen::CAE::FunctionBuilder::SetTypes	(	NXOpen::CAE::Function::Type	functionType,
		NXOpen::CAE::XyFunctionMacroType	macroType,
		NXOpen::CAE::XyFunctionGeneralType	generalType
	)

Sets types of a function
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

functionType	Math function or Table function.
macroType	For Motion Simulation or Advanced Simulation or General Purpose.
generalType	Data type of function. If macro_type is CAE::XyFunctionMacroTypeMotion , it must be CAE::XyFunctionGeneralTypeGeneral or CAE::XyFunctionGeneralTypeTime . If macro_type is CAE::XyFunctionMacroTypeLoad or it must be CAE::XyFunctionGeneralTypeGeneral or CAE::XyFunctionGeneralTypeTime or CAE::XyFunctionGeneralTypeSpectrum or CAE::XyFunctionGeneralTypePowerSpectralDensity or CAE::XyFunctionGeneralTypeShockResponseSpectrum . If macro_type is CAE::XyFunctionMacroTypeMaterial , it must be CAE::XyFunctionGeneralTypeGeneral or CAE::XyFunctionGeneralTypeTime or CAE::XyFunctionGeneralTypeTemperature or CAE::XyFunctionGeneralTypeStressStrain or CAE::XyFunctionGeneralTypeLife . If macro_type is CAE::XyFunctionMacroTypeResponse , it must be CAE::XyFunctionGeneralTypeGeneral or CAE::XyFunctionGeneralTypeTime or CAE::XyFunctionGeneralTypeSpectrum or CAE::XyFunctionGeneralTypePowerSpectralDensity or CAE::XyFunctionGeneralTypeShockResponseSpectrum or CAE::XyFunctionGeneralTypeCrossSpectrum or CAE::XyFunctionGeneralTypeTransmissibility .

void NXOpen::CAE::FunctionBuilder::SetUnits	(	NXOpen::CAE::XyFunctionUnit	xUnit,
		NXOpen::CAE::XyFunctionUnit	yUnit,
		NXOpen::CAE::XyFunctionUnit	frfUnit
	)

Sets units of a function
Created in NX5.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

xUnit	x unit
yUnit	y unit
frfUnit	frf unit

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

CAE_FunctionBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation