Customizing

interface - Conditionals

Die nachfolgenden Inhalte sind nur in englischer Sprache verfügbar.

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

Classes

BaseConditional

Methods

Function

Parameters

Return Value

Description

BaseConditional.__init__(self, parameter='')

parameter: Value to compare

conditional instance

Initialize a new conditional object

Properties

Property

Getter

Setter

Description

BaseConditional.is_satisfied

Returns whether the value it was initialized with matches the current value.

BaseConditional.value

This 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

Function

Parameters

Return Value

Description

get_conditional_from_class_name(class_name)

class_name: Name of the conditional class

conditional class

Get the class object of a conditional based on its name. If the name cannot be resolved to a class, UndefinedConditional is returned instead.