This topic discusses the conditionals feature provided by the PLANTA link API.

Classes

BaseConditional

Methods

FunctionParametersReturn ValueDescription
BaseConditional.__init__(self, parameter='')parameter: Value to compareconditional instanceInitialize a new conditional object

Properties

PropertyGetterSetterDescription
BaseConditional.is_satisfiedReturns whether the value it was initialized with matches the current value.
BaseConditional.valueThis property is abstract and must be implemented in a subclass. It must return the current value for the condition you want to check.

UndefinedConditional

The UndefinedConditional class is a dummy class that will always return False from UndefinedConditional.is_satisfied

Functions

FunctionParametersReturn ValueDescription
get_conditional_from_class_name(class_name)class_name: Name of the conditional classconditional classGet the class object of a conditional based on its name. If the name cannot be resolved to a class, UndefinedConditional is returned instead.