package votorola.a.count.gwt; // Copyright 2011, 2013, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.


/** A superaccount register for quantitive summation at a particular node.
  *
  *     @see <a href='http://reluk.ca/w/Wiki:Quantitive_summation' target='_top'
  *                  >http://reluk.ca/w/Wiki:Quantitive summation</a>
  */
public final class SacRegisterJS_q extends SacRegisterJS
{

    // cf. SacRegisterJS_v


    protected SacRegisterJS_q() {} // "precisely one constructor... protected, empty, and no-argument"



    /** The volume of {@linkplain #receiveVolume() received pledges} that flows to the
      * candidate node along with the {@linkplain SacRegisterJS_v#castVolume() cast
      * volume}.  The cast volume is excluded from this count.
      */
    public native Long carryVolume()
    /*-{
        return @java.lang.Long::new(Ljava/lang/String;)( this.carryVolume );
    }-*/;



    /** The original amount pledged by the node.
      */
    public native Long castVolume()
    /*-{
        return @java.lang.Long::new(Ljava/lang/String;)( this.castVolume );
    }-*/;



    /** The volume of pleges held.  This is simply {@linkplain #receiveVolume()
      * receiveVolume} - {@linkplain #carryVolume() carryVolume}.
      */
    public Long holdVolume() { return receiveVolume() - carryVolume(); }



    /** The volume pledges received from other nodes.
      */
    public native Long receiveVolume()
    /*-{
        return @java.lang.Long::new(Ljava/lang/String;)( this.receiveVolume );
    }-*/;


}