FunctionObject class is used to specify the function setting when using a function for the condition setting.
The class can be called from FunctionObjectFactory class.
. More...

Public Member Functions
void	AddFunction (FunctionObject *function)
	Adds a new function to the composite function. More...

FunctionObject *	GetFunction (int i)
	Returns the type of the function in the composite function. More...

Variant	GetParameters ()
	Returns the property name of the function as a string list. More...

String	GetParameterTable ()
	Returns the property name and value of the function as a string. More...

String	GetPropertyHelp (String &propName)
	Returns the help of the properties as a string. More...

String	GetType ()
	Returns the type of the function as a string. More...

double	GetValue (String &propName)
	Returns the value of properties as a real number. More...

bool	IsValid ()
	Returns True if an object is valid. More...

int	NumFunctions ()
	functions for composite function More...

void	RemoveFunction (int index)
	Deletes a function from the composite function. More...

void	SetFlagByName (String &propName, String &scriptKeyName)
	Specifies the value of flag property for the specified name. More...

void	SetTable (String array &list)
	Specifies a definition table for each higher harmonics. More...

void	SetTableProperty (String &propName, DataSet *set)
	Specifies a table for the specified properties. More...

void	SetValue (String &propName, Variant &value)
	Returns the value of properties as a real number. More...

void	SetValueWithUnit (String &propName, Variant &value, String &unitName)
	Specifies the value of the specified property. More...

Detailed Description

FunctionObject class is used to specify the function setting when using a function for the condition setting.
The class can be called from FunctionObjectFactory class.
.

Example of calling the class object:

app.FunctionFactory().Constant(1.0)

For information about the property name that can be specified for the argument of a function, see Settings for Functions .

Member Function Documentation

void FunctionObject::AddFunction ( FunctionObject * function )

Adds a new function to the composite function.

Parameters

function FunctionObject object

FunctionObject * FunctionObject::GetFunction ( int i )

Returns the type of the function in the composite function.

Parameters

i	Function ID

Returns: FunctionObject object

Variant FunctionObject::GetParameters ( )

Returns the property name of the function as a string list.

Returns: Property name and value of the function

String FunctionObject::GetParameterTable ( )

Returns the property name and value of the function as a string.

Returns: Property name of the function

String FunctionObject::GetPropertyHelp ( String & propName )

Returns the help of the properties as a string.

Parameters

propName Property name

Returns: Help of the properties

String FunctionObject::GetType ( )

Returns the type of the function as a string.

Returns: Function type name

double FunctionObject::GetValue ( String & propName )

Returns the value of properties as a real number.

Parameters

Argument name

Returns: Property value

bool FunctionObject::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the FunctionObject objects in the list are valid

int FunctionObject::NumFunctions ( )

functions for composite function

Returns the number of functions in the composite function.

Returns: Number of functions

void FunctionObject::RemoveFunction ( int index )

Deletes a function from the composite function.

Parameters

index Function ID

void FunctionObject::SetFlagByName	(	String &	propName,
		String &	scriptKeyName
	)

Specifies the value of flag property for the specified name.

Parameters

propName	Property name
scriptKeyName	Flag name

void FunctionObject::SetTable ( String array & list )

Specifies a definition table for each higher harmonics.

Parameters

list	Multidimensional array

void FunctionObject::SetTableProperty	(	String &	propName,
		DataSet *	set
	)

Specifies a table for the specified properties.

Parameters

propName	Property name
set	DataSet (table)

void FunctionObject::SetValue	(	String &	propName,
		Variant &	value
	)

Returns the value of properties as a real number.

Parameters

propName	Property name
value	Property value

For information about the condition type name that can be specified as propName, see Function Settings .

void FunctionObject::SetValueWithUnit	(	String &	propName,
		Variant &	value,
		String &	unitName
	)

Specifies the value of the specified property.

Parameters

propName	Property name
value	Property value
unitName	Unit

For information about the condition type name that can be specified as propName , see Function Settings .

Public Member Functions

Detailed Description

Member Function Documentation