/**
 * This class is used by the <code>ServerImageSet</code> object to reply to
 * requests from the <code>Plate</code> for a possible update of images to show a new view
 * desired by the user.
 * <br><br>
 * <a href="mailto:ehudsons@andrew.cmu.edu">Ellen Hudson-Snyder</a>, 
 * <a href="mailto:evedar@andrew.cmu.edu">Elvin Vedar</a>,
 * <a href="mailto:cbalz@andrew.cmu.edu">Christopher M. Balz</a>.
 * <br><br>CVS Version Info:<br>
 *  $Id: PlateUpdateResponse.js,v 1.7 2005/11/12 23:25:25 ehudsons Exp $
 * <br><br>
 * @object-prop <code>boolean</code> <code>booHasNewImages</code>  A boolean value that indicates if there are new 
 *                                   images to load onto the <code>plate</code> document object model object.
 * @object-prop <code>number</code> <code>intNumRowsInCompositeImage</code>  An integer value representing the number of 
 *                                   rows in this plate load of images from the server.
 * @object-prop <code>number</code> <code>intNumColsInCompositeImage</code>  An integer value representing the number of 
 *                                   columns in this plate load of images from the server.
 * @object-prop <code>FastLinkedList</code>  <code>objNewImagesList</code> A linked list of the image urls required
 *                                           for the new viewon the <code>plate</code> document object model
 *                                           object.
 * @object-prop <code>number</code> <code>intXOffsetPx</code>  A value reflecting the distance moved, in pixels, by
 *                                  the user across part of a screen tile in the horizontal direction.
 * @object-prop <code>number</code> <code>intYOffsetPx</code>  A value reflecting the distance moved, in pixels, by
 *                                  the user across part of a screen tile in the vertical direction.
 * @object-prop <code>number</code> <code>intAdjustment</code>  A value reflecting the distance the X or Y
 *                                  presentation value needs to be adjusted in the case of reaching the end of the 
 *                                  Image Set.  If, 
 *                                  during a plate reload we determine we cannot the full number of rows or columns 
 *                                  due to reaching the end of the Image Set on the server, we need to adjust our
 *                                  starting tile value and our presentation value by this amount.
 * @author Team GigaToasted (Fall-2005-CMU-NASA/Google-Practicum Subteam) 
 * @version 1.0
 */


/**
 * Create a <code>PlateUpdateResponse</code> object.
 * @param booHasNewImages  <code>boolean<code> A value that indicates if there are new images to load onto the 
 *                         <code>plate</code> document object model object.
 * @param pIntNumRowsInCompositeImage <code>number</code>  OPTIONAL - An integer value indicating the number of 
 *							rows in this plateload.
 * @param pIntNumColsInCompositeImage <code>number</code>  OPTIONAL - An integer value indicating the number of 
 *							columns in this plateload.							
 * @param objNewImagesList <code>FastLinkedList</code>  OPTIONAL - A linked list of the image urls required for the
 *                         new view on the <code>plate</code> document object model object.
 * @param intXOffsetPx     <code>number</code> OPTIONAL - An integer value reflecting the distance moved, in
 *                         pixels, by the user across part of a screen tile in the horizontal direction.
 * @param intYOffsetPx     <code>number</code> OPTIONAL - An integer value reflecting the distance moved, in
 *                         pixels, by the user across part of a screen tile in the vertical direction.
 * @param intAdjustment <code>number</code>  A value reflecting the distance the X or Y
 *                                  presentation value needs to be adjusted in the case of reaching the end 
 *                                  of the Image Set.
 */
function PlateUpdateResponse( pBooHasNewImages, pIntNumRowsInCompositeImage, pIntNumColsInCompositeImage,
		pObjNewImagesList, pIntXOffsetPx, pIntYOffsetPx, pIntAdjustment  ) {
    this.booHasNewImages  = pBooHasNewImages;
    if (this.booHasNewImages) {
        this.intNumRowsInCompositeImage = pIntNumRowsInCompositeImage;  
		this.intNumColsInCompositeImage = pIntNumColsInCompositeImage;
        this.objNewImagesList = pObjNewImagesList;
        this.intXOffsetPx     = pIntXOffsetPx;
        this.intYOffsetPx     = pIntYOffsetPx;
        this.intAdjustmentPx  = pIntAdjustment;
    }
}


