GullyRestorationCommand.go

// Copyright (c) 2019 Australian Rivers Institute.

package particulatenitrogen

import (
	"github.com/LindsayBradford/crem/internal/pkg/model/planningunit"
	"github.com/LindsayBradford/crem/internal/pkg/model/variable"
	"github.com/LindsayBradford/crem/pkg/command"
)

type GullyRestorationCommand struct {
	variable.ChangePerPlanningUnitDecisionVariableCommand

	undoneGullyContribution float64
	doneGullyContribution   float64
}

func (c *GullyRestorationCommand) ForVariable(variable variable.PlanningUnitDecisionVariable) *GullyRestorationCommand {
	c.WithTarget(variable)
	return c
}

func (c *GullyRestorationCommand) InPlanningUnit(planningUnit planningunit.Id) *GullyRestorationCommand {
	c.ChangePerPlanningUnitDecisionVariableCommand.InPlanningUnit(planningUnit)
	return c
}

func (c *GullyRestorationCommand) WithNitrogenContribution(contribution float64) *GullyRestorationCommand {
	c.undoneGullyContribution = c.gullyNitrogenContribution()
	c.doneGullyContribution = contribution
	return c
}

func (c *GullyRestorationCommand) WithChange(changeValue float64) *GullyRestorationCommand {
	c.ChangePerPlanningUnitDecisionVariableCommand.WithChange(changeValue)
	return c
}

func (c *GullyRestorationCommand) variable() *ParticulateNitrogenProduction {
	return c.Target().(*ParticulateNitrogenProduction)
}

func (c *GullyRestorationCommand) Do() command.CommandStatus {
	if c.BaseCommand.Do() == command.NoChange {
		return command.NoChange
	}
	c.ChangePerPlanningUnitDecisionVariableCommand.DoUnguarded()
	c.setGullyNitrogenContribution(c.doneGullyContribution)
	return command.Done
}

func (c *GullyRestorationCommand) Undo() command.CommandStatus {
	if c.BaseCommand.Undo() == command.NoChange {
		return command.NoChange
	}
	c.ChangePerPlanningUnitDecisionVariableCommand.UndoUnguarded()
	c.setGullyNitrogenContribution(c.undoneGullyContribution)

	return command.UnDone
}

func (c *GullyRestorationCommand) setGullyNitrogenContribution(contribution float64) {
	c.variable().subCatchmentAttributes[c.PlanningUnit()] =
		c.variable().subCatchmentAttributes[c.PlanningUnit()].Replace(GullyNitrogenContribution, contribution)
}

func (c *GullyRestorationCommand) gullyNitrogenContribution() float64 {
	planningUnitAttributes := c.variable().subCatchmentAttributes[c.PlanningUnit()]
	return planningUnitAttributes.Value(GullyNitrogenContribution).(float64)
}