concepts.dm.pdsketch.predicate.FunctionEvaluationDefinitionMode#

class FunctionEvaluationDefinitionMode[source]#

Bases: JacEnum

The evaluation mode of a function definition. This enum has three values:

  • FUNCTIONAL: the function is a pure function.

  • SIMULATION: the function is a simulation-dependent function, i.e., it is a function that can only be evaluated given the current state in simulation.

  • EXECUTION: the function is an execution-dependent function, i.e., it is a function that can only be evaluated given the current state in execution.

Methods

from_string(value)

type_name()

Return the type name of the enum.

choice_names()

Returns the list of the name of all possible choices.

choice_objs()

Returns the list of the object of all possible choices.

choice_values()

Returns the list of the value of all possible choices.

is_valid(value)

Check if the value is a valid choice.

assert_valid(value)

Assert if the value is a valid choice.

from_bools(simulation, execution)

get_prefix()

Attributes

classmethod __getitem__(name)#

Return the member matching name.

classmethod __iter__()#

Return members in definition order.

classmethod __len__()#

Return the number of members (no aliases)

__new__(value)#
classmethod assert_valid(value)#

Assert if the value is a valid choice.

classmethod choice_names()#

Returns the list of the name of all possible choices.

classmethod choice_objs()#

Returns the list of the object of all possible choices.

classmethod choice_values()#

Returns the list of the value of all possible choices.

classmethod from_bools(simulation, execution)[source]#
Parameters:
classmethod from_string(value)#
Parameters:

value (str | JacEnum)

Return type:

JacEnum

get_prefix()[source]#
Return type:

str

classmethod is_valid(value)#

Check if the value is a valid choice.

classmethod type_name()#

Return the type name of the enum.

EXECUTION = 'execution'#
FUNCTIONAL = 'functional'#
SIMULATION = 'simulation'#