engforge.properties.system_property

class system_property(fget=None, fset=None, fdel=None, doc=None, desc=None, label=None, stochastic=False)

Bases: engforge_prop

this property notifies the system this is a property to be tabulated in the dataframe output.

@system_property def function(…): < this uses __init__ to assign function

@system_property(desc=’really nice’,label=’funky function’) def function(…): < this uses __call__ to assign function

When the underlying data has some random element, set stochastic=True and this will flag the component to always save data.

Functions wrapped with table type must have an return annotion of (int,float,str)… ex def func() -> int:

You can initalize just the functions, or precreate the object but with meta @system_property def function(…): < this uses __init__ to assign function

@system_property(desc=’really nice’,label=’funky function’) def function(…): < this uses __call__ to assign function

Methods

deleter
get_func_return	ensures that the function has a return annotation, and that return annotation is in valid sort types
getter
setter

Attributes

desc
label
must_return
return_type
stochastic
valid_types

__call__(fget=None, fset=None, fdel=None, doc=None)

this will be called when input is provided before property is set

get_func_return(func)

ensures that the function has a return annotation, and that return annotation is in valid sort types