code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/computation/state/parts/ResourceInstanceAmount.scala

   1 /*
   2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35
  36 package gr.grnet.aquarium.computation
  37 package state
  38 package parts
  39
  40 /**
  41  * Maintains the current state of a resource instance owned by the user.
  42  *
  43  * In order to have a uniform representation of the resource state for all
  44  * resource types (complex or simple) the following convention applies:
  45  *
  46  *  - If the resource is complex, the (name, instanceID) is (DSLResource.name, instance-id)
  47  *  - If the resource is simple,  the (name, instanceID) is (DSLResource.name, "1")
  48  *
  49  * @param resource        Same as `resource` of [[gr.grnet.aquarium.event.model.resource.ResourceEventModel]]
  50  * @param instanceID      Same as `instanceID` of [[gr.grnet.aquarium.event.model.resource.ResourceEventModel]]
  51  * @param instanceAmount  This is the amount kept for the resource instance.
  52 *                         The general rule is that an amount saved in a
  53  *                        [[gr.grnet.aquarium.computation.parts. ResourceInstanceSnapshot]]
  54  *                        represents a total value, while a value appearing in a
  55  *                        [[gr.grnet.aquarium.event .model.resource.ResourceEventModel]]
  56  *                        represents a difference. How these two values are combined to form the new amount is dictated
  57  *                        by the underlying [[gr.grnet.aquarium.charging.ChargingBehavior]]
  58  *
  59  * @author Christos KK Loverdos <loverdos@gmail.com>
  60  */
  61 case class ResourceInstanceAmount(
  62     resource: String,
  63     instanceID: String,
  64     instanceAmount: Double
  65 ) {
  66
  67   def isSameResourceInstance(resource: String, instanceId: String) = {
  68     this.resource == resource &&
  69     this.instanceID == instanceId
  70   }
  71
  72   def toResourceInstanceAmountMapElement = (resource, instanceID) -> this
  73 }