SBFunction#

See also

SAMSON SDK: SBCClassFunction

class samson.SBFunction#

Bases: pybind11_object

This class describes a class function in a class proxy.

SAMSON API: Introspection, SBCClassFunction

call(self: samson.SBFunction, object: samson.SBValue, *args) samson.SBValue#

Calls the function for object with the given arguments. Set the object to SBValue(None) when calling a static function. You can supply up to 16 SBValue arguments.

canCall(self: samson.SBFunction, *args) bool#

Returns whether can call the function with the given arguments. You can supply up to 16 SBValue arguments.

getName(self: samson.SBFunction) str#

Returns the name of the function

getNumberOfParameters(self: samson.SBFunction) int#

Returns the number of parameters of the function

getOutputType(self: samson.SBFunction) str#

Returns the output type of the function

getParameterType(self: samson.SBFunction, i: int) samson.SBValue#

Returns the parameter type of the function parameter i

getParameterTypeName(self: samson.SBFunction, i: int) str#

Returns the parameter type name of the function parameter i

isConstFunction(self: samson.SBFunction) bool#

Returns True if and only if the function is a const function

isStaticFunction(self: samson.SBFunction) bool#

Returns True if and only if the function is a static function

signature(self: samson.SBFunction) str#

Returns the signature of the function