Struct rtlola_interpreter::rtlola_mir::TimeDrivenStream

pub struct TimeDrivenStream {
    pub reference: StreamReference,
    pub frequency: Quantity<dyn Dimension<J = Z0, I = Z0, M = Z0, Kind = dyn Kind + 'static, L = Z0, N = Z0, Th = Z0, T = NInt<UInt<UTerm, B1>>> + 'static, dyn Units<Ratio<i64>, luminous_intensity = candela, amount_of_substance = mole, time = second, thermodynamic_temperature = kelvin, electric_current = ampere, mass = kilogram, length = meter> + 'static, Ratio<i64>>,
}

Wrapper for output streams providing additional information specific to time-driven streams.

Fields

reference: StreamReference

A reference to the stream that is specified.

frequency: Quantity<dyn Dimension<J = Z0, I = Z0, M = Z0, Kind = dyn Kind + 'static, L = Z0, N = Z0, Th = Z0, T = NInt<UInt<UTerm, B1>>> + 'static, dyn Units<Ratio<i64>, luminous_intensity = candela, amount_of_substance = mole, time = second, thermodynamic_temperature = kelvin, electric_current = ampere, mass = kilogram, length = meter> + 'static, Ratio<i64>>

The evaluation frequency of the stream.

Implementations

impl TimeDrivenStream

pub fn period(
    &self
) -> Quantity<dyn Dimension<J = Z0, I = Z0, M = Z0, Kind = dyn Kind + 'static, L = Z0, N = Z0, Th = Z0, T = PInt<UInt<UTerm, B1>>> + 'static, dyn Units<Ratio<i64>, luminous_intensity = candela, amount_of_substance = mole, time = second, thermodynamic_temperature = kelvin, electric_current = ampere, mass = kilogram, length = meter> + 'static, Ratio<i64>>

Returns the evaluation period, i.e., the multiplicative inverse of TimeDrivenStream::frequency.

pub fn frequency(
    &self
) -> Quantity<dyn Dimension<J = Z0, I = Z0, M = Z0, Kind = dyn Kind + 'static, L = Z0, N = Z0, Th = Z0, T = NInt<UInt<UTerm, B1>>> + 'static, dyn Units<Ratio<i64>, luminous_intensity = candela, amount_of_substance = mole, time = second, thermodynamic_temperature = kelvin, electric_current = ampere, mass = kilogram, length = meter> + 'static, Ratio<i64>>

Returns the evaluation frequency.

pub fn period_in_duration(&self) -> Duration

Returns the evaluation period, i.e., the multiplicative inverse of TimeDrivenStream::frequency, as Duration.

Trait Implementations

impl Clone for TimeDrivenStream

fn clone(&self) -> TimeDrivenStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimeDrivenStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimeDrivenStream

fn deserialize<__D>(
    __deserializer: __D
) -> Result<TimeDrivenStream, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<TimeDrivenStream> for TimeDrivenStream

fn eq(&self, other: &TimeDrivenStream) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TimeDrivenStream

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TimeDrivenStream

impl Eq for TimeDrivenStream

impl StructuralEq for TimeDrivenStream

impl StructuralPartialEq for TimeDrivenStream