org.powertac.distributionutility.SettlementContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of distribution-utility Show documentation

Balances supply and demand in the current timeslot

There is a newer version: 1.9.0

/*
 * Copyright (c) 2012 by the original author
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.powertac.distributionutility;

import org.powertac.common.interfaces.CapacityControl;
import org.powertac.common.repo.TariffRepo;

/**
 * Context interface for settlement processors. This is needed for testing,
 * and to limit the accessibility of the DistributionUtilityService to
 * settlement processors. Methods have package visibility, because we assume
 * settlement processors will be in the same package with the service.
 * @author jcollins
 */
public interface SettlementContext
{  
  /**
   * Returns the current value of pPlus. This is the marginal cost for
   * up-regulating power. Value is normally negative, because brokers must
   * pay. Cost increases (becomes more negative) with quantity according 
   * to pPlusPrime.
   */
  public double getPPlus ();
  
  /**
   * Returns the slope of cost curve for up-regulation. Total cost for
   * up-regulation by x kwh is pPlus + x * pPlusPrime. Note that x is
   * positive for up-regulation.
   */
  public double getPPlusPrime();
  
  /**
   * Returns the current value of pMinus. This is the marginal cost for
   * down-regulation. Value is normally positive, because brokers are paid.
   * Cost increases with quantity (becomes less positive, eventually becoming
   * negative) with quantity accoring to the value of pMinusPrime.
   */
  public double getPMinus ();
  
  /**
   * Returns the slope of cost curve for down-regulation. Total cost for
   * down-regulation by x kwh is pMinus + x * pMinusPrime. Note that x is
   * negative for down-regulation.
   */
  public double getPMinusPrime();
  
  /**
   * Returns the DU charge for running the balancing market
   */
  public Double getBalancingCost ();
}