Template Struct ComponentData

Defined in File ComponentData.hpp

Inheritance Relationships

Derived Type

public GridKit::PhasorDynamics::BusData< RealT, IdxT > (Template Struct BusData)

Struct Documentation

template<typename real_type, typename index_type, typename parameters_enum, typename buses_enum, typename signal_inputs_enum, typename signal_outputs_enum, typename monitorable_variables_enum> struct ComponentData

Unified interface for Component data containers.

Template Parameters:

real_type – Real parameter data type
index_type – Integer parameter data type

Subclassed by GridKit::PhasorDynamics::BusData< RealT, IdxT >

Public Types

using RealT = real_type : Real value type.

using IdxT = index_type : Index type.

using Parameters = parameters_enum : Enumeration over parameters.

using Buses = buses_enum : Enumeration over buses.

using SignalInputs = signal_inputs_enum : Enumeration over signal inputs.

using SignalOutputs = signal_outputs_enum : Enumeration over signal outputs.

using MonitorableVariables = monitorable_variables_enum : Enumeration over monitorable variables.

Public Members

std::string device_class: Class of device this is for.

std::map<Parameters, std::variant<std::string, bool, RealT, IdxT>> parameters: Mapping of parameters to parameter values.

std::map<Buses, IdxT> buses: Mapping of terminal attachments to bus identifiers.

std::map<SignalInputs, IdxT> signal_inputs: Mapping of signal inputs to signal identifiers.

std::map<SignalOutputs, IdxT> signal_outputs: Mapping of signal outputs to signal identifiers.

std::set<MonitorableVariables> monitored_variables: Set of variables being monitored.

std::string disambiguation_string: Disambiguation string for this device.