Template Class SignalIn

Defined in File SignalIn.hpp

Inheritance Relationships

Base Type

public GridKit::PhasorDynamics::Port< scalar_type, index_type > (Template Class Port)

Class Documentation

template<typename scalar_type, typename index_type> class SignalIn : public GridKit::PhasorDynamics::Port<scalar_type, index_type>

Port for receiving a signal from a SignalNode.

Public Functions

inline const ScalarT &readSignal() const: Read the value of the signal node if connected.

inline IdxT signalVariableIndex() const: Retrieve the variable index of the connected signal node.

inline void writeValue(ScalarT value): Write a value to the connected signal node.

Warning

Use only during initialization as this violates assumptions.