CoreParameter

pywr_v1_schema::parameters

Enum CoreParameter

pub enum CoreParameter {
Show 39 variants
    Aggregated(AggregatedParameter),
    AggregatedIndex(AggregatedIndexParameter),
    AsymmetricSwitchIndex(AsymmetricSwitchIndexParameter),
    Constant(ConstantParameter),
    ControlCurvePiecewiseInterpolated(ControlCurvePiecewiseInterpolatedParameter),
    ControlCurveInterpolated(ControlCurveInterpolatedParameter),
    ControlCurveIndex(ControlCurveIndexParameter),
    ControlCurve(ControlCurveParameter),
    DailyProfile(DailyProfileParameter),
    IndexedArray(IndexedArrayParameter),
    MonthlyProfile(MonthlyProfileParameter),
    WeeklyProfile(WeeklyProfileParameter),
    UniformDrawdownProfile(UniformDrawdownProfileParameter),
    Max(MaxParameter),
    Min(MinParameter),
    NegativeMin(NegativeMinParameter),
    NegativeMax(NegativeMaxParameter),
    Division(DivisionParameter),
    Negative(NegativeParameter),
    Polynomial1D(Polynomial1DParameter),
    ParameterThreshold(ParameterThresholdParameter),
    NodeThreshold(NodeThresholdParameter),
    StorageThreshold(StorageThresholdParameter),
    MultipleThresholdIndex(MultipleThresholdIndexParameter),
    MultipleThresholdParameterIndex(MultipleThresholdParameterIndexParameter),
    CurrentYearThreshold(CurrentYearThresholdParameter),
    CurrentOrdinalDayThreshold(CurrentOrdinalDayThresholdParameter),
    TablesArray(TablesArrayParameter),
    DataFrame(DataFrameParameter),
    Deficit(DeficitParameter),
    DiscountFactor(DiscountFactorParameter),
    InterpolatedVolume(InterpolatedVolumeParameter),
    InterpolatedFlow(InterpolatedFlowParameter),
    HydropowerTarget(HydropowerTargetParameter),
    Storage(StorageParameter),
    RollingMeanFlowNode(RollingMeanFlowNodeParameter),
    ScenarioWrapper(ScenarioWrapperParameter),
    Flow(FlowParameter),
    RbfProfile(RbfProfileParameter),
}

Variants§

Aggregated(AggregatedParameter)

AggregatedIndex(AggregatedIndexParameter)

AsymmetricSwitchIndex(AsymmetricSwitchIndexParameter)

Constant(ConstantParameter)

ControlCurvePiecewiseInterpolated(ControlCurvePiecewiseInterpolatedParameter)

ControlCurveInterpolated(ControlCurveInterpolatedParameter)

ControlCurveIndex(ControlCurveIndexParameter)

ControlCurve(ControlCurveParameter)

DailyProfile(DailyProfileParameter)

IndexedArray(IndexedArrayParameter)

MonthlyProfile(MonthlyProfileParameter)

WeeklyProfile(WeeklyProfileParameter)

UniformDrawdownProfile(UniformDrawdownProfileParameter)

Max(MaxParameter)

Min(MinParameter)

NegativeMin(NegativeMinParameter)

NegativeMax(NegativeMaxParameter)

Division(DivisionParameter)

Negative(NegativeParameter)

Polynomial1D(Polynomial1DParameter)

ParameterThreshold(ParameterThresholdParameter)

NodeThreshold(NodeThresholdParameter)

StorageThreshold(StorageThresholdParameter)

MultipleThresholdIndex(MultipleThresholdIndexParameter)

MultipleThresholdParameterIndex(MultipleThresholdParameterIndexParameter)

CurrentYearThreshold(CurrentYearThresholdParameter)

CurrentOrdinalDayThreshold(CurrentOrdinalDayThresholdParameter)

TablesArray(TablesArrayParameter)

DataFrame(DataFrameParameter)

Deficit(DeficitParameter)

DiscountFactor(DiscountFactorParameter)

InterpolatedVolume(InterpolatedVolumeParameter)

InterpolatedFlow(InterpolatedFlowParameter)

HydropowerTarget(HydropowerTargetParameter)

Storage(StorageParameter)

RollingMeanFlowNode(RollingMeanFlowNodeParameter)

ScenarioWrapper(ScenarioWrapperParameter)

Flow(FlowParameter)

RbfProfile(RbfProfileParameter)

Implementations§

impl CoreParameter

pub fn parameters(&self) -> HashMap<&str, ParameterValueType<'_>>

pub fn parameters_mut(&mut self) -> HashMap<&str, ParameterValueTypeMut<'_>>

pub fn ty(&self) -> &'static str

pub fn resource_paths(&self) -> Vec<PathBuf>

Return any external resource paths referenced by this parameter

pub fn resource_paths_recursive(&self) -> Vec<PathBuf>

pub fn update_resource_paths(&mut self, new_paths: &HashMap<PathBuf, PathBuf>)

pub fn update_resource_paths_recursive( &mut self, new_paths: &HashMap<PathBuf, PathBuf>, )

Trait Implementations§

impl Clone for CoreParameter

fn clone(&self) -> CoreParameter

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for CoreParameter

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for CoreParameter

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for CoreParameter

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for CoreParameter

impl RefUnwindSafe for CoreParameter

impl Send for CoreParameter

impl Sync for CoreParameter

impl Unpin for CoreParameter

impl UnwindSafe for CoreParameter

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,