Package com.hexaly.modeler

Interface HxmFunctor

public interface HxmFunctor

External modeler function interface. To use your own external functions in the modeler, you have to follow these steps :

• Implement the HxmFunctor interface with the call method.
• Then create a HxmFunction with HexalyModeler.createFunction(java.lang.String, com.hexaly.modeler.HxmFunctor).
• Finally, if you want to make this function available in your Hexaly modeling code, you have to assign it to a module variable with HxmModule.setFunction(java.lang.String, com.hexaly.modeler.HxmFunction).

Note: This class should only be implemented to expose functions used during the modeling process. You should not use this class to create a function that will be called during the resolution as an external function. In this case, you should instead use the optimizer API directly (see HxIntExternalFunction or HxDoubleExternalFunction).

Since:

10.0

See Also:

HxmFunction

Method Summary

Modifier and Type	Method	Description
HxmValue	call(HexalyModeler modeler, java.util.List<HxmValue> arguments)	The function to call with its arguments.

Method Detail

call

HxmValue call(HexalyModeler modeler,
              java.util.List<HxmValue> arguments)

The function to call with its arguments.

Parameters:

modeler - Modeler instance.

arguments - List of modeler values passed to the function by the caller.

Returns:

Return value of the call.