andes.core.param.IdxParam

class andes.core.param.IdxParam(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, unique: bool = False, export: bool = True, model: str | None = None, iconvert: Callable | None = None, oconvert: Callable | None = None, replaces: bool = False, status_parent: bool = False)

Parameter for storing idx references into other models.

IdxParam creates the connection graph between models. It stores device idx values that point to entries in the referenced model (which can be a Model or Group name). These references are used by ExtParam and ExtAlgeb/ExtState to look up external values.

Parameters:

modelstr, optional

Name of the referenced Model or Group (e.g. 'Bus', 'StaticGen'). Required for BackRef and external-variable linking.

uniquebool, optional

If True, duplicate values raise IndexError. Useful when a one-to-one mapping is required (e.g. one TG per generator).

replacesbool, optional

If True, this model replaces the referenced device during time-domain simulation (static-dynamic replacement).

status_parentbool, optional

If True, the referenced device is treated as a status parent. When the parent is taken offline via set_status, the effective status ue of this device and its descendants is propagated automatically.

Examples

A PQ model connected to Bus

class PQModel(...):
    def __init__(...):
        self.bus = IdxParam(model='Bus')

An exciter referencing its parent generator with status propagation

self.syn = IdxParam(model='SynGen', mandatory=True,
                    status_parent=True)

__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, unique: bool = False, export: bool = True, model: str | None = None, iconvert: Callable | None = None, oconvert: Callable | None = None, replaces: bool = False, status_parent: bool = False)

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.