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

Inheritance diagram for NXOpen.CAE.FunctionBuilder:

Public Member Functions
unsafe string[]	GetDefinitions ()
	Returns definition strings of a math function. More...

unsafe void	GetMathPlotData (out int dataCount, out double xMinimum, out double xIncrement)
	Returns plot data setting of a math function. More...

unsafe NXOpen.CAE.Function[]	GetReferencedObjects ()
	Returns referenced objects of a math function. More...

unsafe void	GetTableData (out int recordIndex, out string recordName, out string recordTimestamp, out NXOpen.CAE.Function.InterpolationMethod interpolateMethod)
	Returns data of a table function. More...

unsafe void	GetTypes (out NXOpen.CAE.Function.Type functionType, out NXOpen.CAE.XyFunctionMacroType macroType, out NXOpen.CAE.XyFunctionGeneralType generalType)
	Returns types of a function More...

unsafe void	GetUnits (out NXOpen.CAE.XyFunctionUnit xUnit, out NXOpen.CAE.XyFunctionUnit yUnit, out NXOpen.CAE.XyFunctionUnit frfUnit)
	Returns units of a function More...

unsafe void	SetDefinitions (string[] definitions)
	Sets definition strings of a math function. More...

unsafe void	SetMathPlotData (int dataCount, double xMinimum, double xIncrement)
	Sets plot data setting for a math function. More...

unsafe void	SetReferencedObjects (NXOpen.CAE.Function[] objects)
	Sets referenced objects of a math function. More...

unsafe void	SetTableData (int recordIndex, string recordName, string recordTimestamp, NXOpen.CAE.Function.InterpolationMethod interpolateMethod)
	Sets data for a table function. More...

unsafe void	SetTypes (NXOpen.CAE.Function.Type functionType, NXOpen.CAE.XyFunctionMacroType macroType, NXOpen.CAE.XyFunctionGeneralType generalType)
	Sets types of a function More...

unsafe void	SetUnits (NXOpen.CAE.XyFunctionUnit xUnit, NXOpen.CAE.XyFunctionUnit yUnit, NXOpen.CAE.XyFunctionUnit frfUnit)
	Sets units of a function More...

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

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

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

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

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

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

Properties
unsafe double	InitialEstimateValue `[get, set]`
	Returns or sets the initial value for function More...

unsafe string	Name `[get, set]`
	Returns or sets the function name. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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

All: CAE.FunctionBuilder.Name , 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 NXOpen.CAE.FunctionCollection.CreateFunctionBuilder

Created in NX5.0.0

Member Function Documentation

unsafe string [] NXOpen.CAE.FunctionBuilder.GetDefinitions ( )

inline

Returns definition strings of a math function.

Only used when function type is NXOpen.CAE.Function.Type.Math

Created in NX5.0.0

License requirements: None.

Returns

unsafe void NXOpen.CAE.FunctionBuilder.GetMathPlotData	(	out int	dataCount,
		out double	xMinimum,
		out double	xIncrement
	)

inline

Returns plot data setting of a math function.

Only used when function type is NXOpen.CAE.Function.Type.Math

Created in NX5.0.0

License requirements: None.

Parameters

dataCount
xMinimum
xIncrement

unsafe NXOpen.CAE.Function [] NXOpen.CAE.FunctionBuilder.GetReferencedObjects ( )

inline

Returns referenced objects of a math function.

Only used when function type is NXOpen.CAE.Function.Type.Math

Created in NX5.0.0

License requirements: None.

Returns

unsafe void NXOpen.CAE.FunctionBuilder.GetTableData	(	out int	recordIndex,
		out string	recordName,
		out string	recordTimestamp,
		out NXOpen.CAE.Function.InterpolationMethod	interpolateMethod
	)

inline

Returns data of a table function.

Only used when function type is NXOpen.CAE.Function.Type.Table

Created in NX5.0.0

License requirements: None.

Parameters

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

unsafe void NXOpen.CAE.FunctionBuilder.GetTypes	(	out NXOpen.CAE.Function.Type	functionType,
		out NXOpen.CAE.XyFunctionMacroType	macroType,
		out NXOpen.CAE.XyFunctionGeneralType	generalType
	)

inline

Returns types of a function

Created in NX5.0.0

License requirements: None.

Parameters

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

unsafe void NXOpen.CAE.FunctionBuilder.GetUnits	(	out NXOpen.CAE.XyFunctionUnit	xUnit,
		out NXOpen.CAE.XyFunctionUnit	yUnit,
		out NXOpen.CAE.XyFunctionUnit	frfUnit
	)

inline

Returns units of a function

Created in NX5.0.0

License requirements: None.

Parameters

xUnit
yUnit
frfUnit

unsafe void NXOpen.CAE.FunctionBuilder.SetDefinitions ( string[] definitions )

inline

Sets definition strings of a math function.

Only used when function type is NXOpen.CAE.Function.Type.Math

Created in NX5.0.0

License requirements: None.

Parameters

definitions

unsafe void NXOpen.CAE.FunctionBuilder.SetMathPlotData	(	int	dataCount,
		double	xMinimum,
		double	xIncrement
	)

inline

Sets plot data setting for a math function.

Only used when function type is NXOpen.CAE.Function.Type.Math

Created in NX5.0.0

License requirements: None.

Parameters

dataCount
xMinimum
xIncrement

unsafe void NXOpen.CAE.FunctionBuilder.SetReferencedObjects ( NXOpen.CAE.Function[] objects )

inline

Sets referenced objects of a math function.

Only used when function type is NXOpen.CAE.Function.Type.Math

Created in NX5.0.0

License requirements: None.

Parameters

objects

unsafe void NXOpen.CAE.FunctionBuilder.SetTableData	(	int	recordIndex,
		string	recordName,
		string	recordTimestamp,
		NXOpen.CAE.Function.InterpolationMethod	interpolateMethod
	)

inline

Sets data for a table function.

Only used when function type is NXOpen.CAE.Function.Type.Table

Created in NX5.0.0

License requirements: None.

Parameters

recordIndex	Begins with one
recordName
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
interpolateMethod

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

inline

Sets types of a function

Created in NX5.0.0

License requirements: None.

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.XyFunctionMacroType.Motion , it must be CAE.XyFunctionGeneralType.General or CAE.XyFunctionGeneralType.Time . If macro_type is CAE.XyFunctionMacroType.Load or it must be CAE.XyFunctionGeneralType.General or CAE.XyFunctionGeneralType.Time or CAE.XyFunctionGeneralType.Spectrum or CAE.XyFunctionGeneralType.PowerSpectralDensity or CAE.XyFunctionGeneralType.ShockResponseSpectrum . If macro_type is CAE.XyFunctionMacroType.Material , it must be CAE.XyFunctionGeneralType.General or CAE.XyFunctionGeneralType.Time or CAE.XyFunctionGeneralType.Temperature or CAE.XyFunctionGeneralType.StressStrain or CAE.XyFunctionGeneralType.Life . If macro_type is CAE.XyFunctionMacroType.Response , it must be CAE.XyFunctionGeneralType.General or CAE.XyFunctionGeneralType.Time or CAE.XyFunctionGeneralType.Spectrum or CAE.XyFunctionGeneralType.PowerSpectralDensity or CAE.XyFunctionGeneralType.ShockResponseSpectrum or CAE.XyFunctionGeneralType.CrossSpectrum or CAE.XyFunctionGeneralType.Transmissibility .

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

inline

Sets units of a function

Created in NX5.0.0

License requirements: None.

Parameters

xUnit
yUnit
frfUnit

Property Documentation

unsafe double NXOpen.CAE.FunctionBuilder.InitialEstimateValue

getset

Returns or sets the initial value for function

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.CAE.FunctionBuilder.Name

getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

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

CAE_FunctionBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation