concepts.dm.crow.crow_function.CrowFunctionEvaluationMode#
- class CrowFunctionEvaluationMode[source]#
Bases:
JacEnumThe evaluation mode of a function. 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)Return the type name of the enum.
Returns the list of the name of all possible choices.
Returns the list of the object of all possible choices.
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)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 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'#