001package 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.
002
003
004/** A superaccount register for quantitive summation at a particular node.
005  *
006  *     @see <a href='http://reluk.ca/w/Wiki:Quantitive_summation' target='_top'
007  *                  >http://reluk.ca/w/Wiki:Quantitive summation</a>
008  */
009public final class SacRegisterJS_q extends SacRegisterJS
010{
011
012    // cf. SacRegisterJS_v
013
014
015    protected SacRegisterJS_q() {} // "precisely one constructor... protected, empty, and no-argument"
016
017
018
019    /** The volume of {@linkplain #receiveVolume() received pledges} that flows to the
020      * candidate node along with the {@linkplain SacRegisterJS_v#castVolume() cast
021      * volume}.  The cast volume is excluded from this count.
022      */
023    public native Long carryVolume()
024    /*-{
025        return @java.lang.Long::new(Ljava/lang/String;)( this.carryVolume );
026    }-*/;
027
028
029
030    /** The original amount pledged by the node.
031      */
032    public native Long castVolume()
033    /*-{
034        return @java.lang.Long::new(Ljava/lang/String;)( this.castVolume );
035    }-*/;
036
037
038
039    /** The volume of pleges held.  This is simply {@linkplain #receiveVolume()
040      * receiveVolume} - {@linkplain #carryVolume() carryVolume}.
041      */
042    public Long holdVolume() { return receiveVolume() - carryVolume(); }
043
044
045
046    /** The volume pledges received from other nodes.
047      */
048    public native Long receiveVolume()
049    /*-{
050        return @java.lang.Long::new(Ljava/lang/String;)( this.receiveVolume );
051    }-*/;
052
053
054}