andes.core.param.DataParam#

class andes.core.param.DataParam(default: float | str | int | None = None, name: str | None = None, tex_name: str | None = None, info: str | None = None, unit: str | None = None, mandatory: bool = False, export: bool = True, iconvert: Callable | None = None, oconvert: Callable | None = None)[source]#

An alias of the BaseParam class.

This class is used for string parameters or non-computational numerical parameters. This class does not provide a to_array method. All input values will be stored in v as a list.

See also

andes.core.param.BaseParam

Base parameter class

__init__(default: float | str | int | None = None, name: str | None = None, tex_name: str | None = None, info: str | None = None, unit: str | None = None, mandatory: bool = False, export: bool = True, iconvert: Callable | None = None, oconvert: Callable | None = None)#

Methods

add([value])

Add a new parameter value (from a new device of the owner model) to the v list.

get_names()

Return self.name in a list.

get_property(property_name)

Check the boolean value of the given property.

set(pos, attr, value)

Set attributes of the BaseParam class to new values at the given positions.

set_all(attr, value)

Set attributes of the BaseParam class to new values for all positions.

Attributes

class_name

Return the class name.

n

Return the count of elements in the value array.