rateengine

Documentation

Index

• type CostComputation
  • func GetNonWinningCostMove(costDetails CostDetails) CostComputation
  • func GetWinningCostMove(costDetails CostDetails) CostComputation
• type CostDetail
• type CostDetails
• type FeeAndRate
• type LinehaulCostComputation
• type NonLinehaulCostComputation
• type RateEngine
  • func NewRateEngine(move models.Move) *RateEngine
  • func (re *RateEngine) ComputePPMMoveCosts(appCtx appcontext.AppContext, _ unit.Pound, _ string, _ string, _ string, ...) (costDetails CostDetails, err error)

Types

type CostComputation

type CostComputation struct {
	LinehaulCostComputation
	NonLinehaulCostComputation

	SITFee      unit.Cents
	SITMax      unit.Cents
	GCC         unit.Cents
	LHDiscount  unit.DiscountRate
	SITDiscount unit.DiscountRate
	Weight      unit.Pound
}

CostComputation represents the results of a computation. Deprecated: This is part of the old pre-GHC rate engine.

func GetNonWinningCostMove

func GetNonWinningCostMove(costDetails CostDetails) CostComputation

GetNonWinningCostMove returns a costComputation of the non-winning calculation Deprecated: This is part of the old pre-GHC rate engine.

func GetWinningCostMove

func GetWinningCostMove(costDetails CostDetails) CostComputation

GetWinningCostMove returns a costComputation of the winning calculation Deprecated: This is part of the old pre-GHC rate engine.

type CostDetail

type CostDetail struct {
	Cost      CostComputation
	IsWinning bool
}

CostDetail holds the costComputation and a bool that signifies if the calculation is the winning (lowest cost) computation Deprecated: This is part of the old pre-GHC rate engine.

type CostDetails

type CostDetails map[string]*CostDetail

CostDetails is a map of CostDetail Deprecated: This is part of the old pre-GHC rate engine.

type FeeAndRate

type FeeAndRate struct {
	Fee  unit.Cents
	Rate unit.Millicents
}

FeeAndRate holds the rate lookup and calculated fee (non-discounted) Deprecated: This is part of the old pre-GHC rate engine.

type LinehaulCostComputation

type LinehaulCostComputation struct {
	BaseLinehaul              unit.Cents
	OriginLinehaulFactor      unit.Cents
	DestinationLinehaulFactor unit.Cents
	ShorthaulCharge           unit.Cents
	LinehaulChargeTotal       unit.Cents
	Mileage                   int
	FuelSurcharge             FeeAndRate
}

LinehaulCostComputation represents the results of a computation. Deprecated: This is part of the old pre-GHC rate engine.

type NonLinehaulCostComputation

type NonLinehaulCostComputation struct {
	OriginService      FeeAndRate
	DestinationService FeeAndRate
	Pack               FeeAndRate
	Unpack             FeeAndRate
}

NonLinehaulCostComputation represents the results of a computation. Deprecated: This is part of the old pre-GHC rate engine.

type RateEngine

type RateEngine struct {
	// contains filtered or unexported fields
}

RateEngine encapsulates the TSP rate engine process Deprecated: This is part of the old pre-GHC rate engine.

func NewRateEngine

func NewRateEngine(move models.Move) *RateEngine

NewRateEngine creates a new RateEngine Deprecated: This is part of the old pre-GHC rate engine.

func (*RateEngine) ComputePPMMoveCosts

func (re *RateEngine) ComputePPMMoveCosts(appCtx appcontext.AppContext, _ unit.Pound, _ string, _ string, _ string, _ int, _ int, _ time.Time, _ int) (costDetails CostDetails, err error)

ComputePPMMoveCosts uses zip codes to make two calculations for the price of a PPM move - once with the pickup zip and once with the current duty location zip - and returns both calcs. Deprecated: This is part of the old pre-GHC rate engine.