root/juggler/branches/2.2/modules/gadgeteer/cluster/Packets/StartBlock.h

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2007 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _GADGET_RIM_START_BLOCK_H
#define _GADGET_RIM_START_BLOCK_H

#include <gadget/gadgetConfig.h>

#include <vpr/vprTypes.h>
#include <vpr/IO/BufferObjectReader.h>

#include <gadget/Util/Debug.h>
#include <cluster/Packets/Header.h>
#include <cluster/Packets/Packet.h>

namespace cluster
{

/** \class StartBlock StartBlock.h cluster/Packets/StartBlock.h
 *
 * Data sequence start block packet.
 */
class GADGET_CLASS_API StartBlock : public Packet
{
public:
   StartBlock()
   {;}

   /**
    * Create a StartBlock packet to signal that the local node is ready to
    * start.
    *
    * @param plugin_id    GUID of the ClusterPlugin that should handle this
    *                     packet.
    * @param frame_number The current number of frames that have been drawn.
    */
   StartBlock(const vpr::GUID& plugin_id, const vpr::Uint32& frame_number);

   /**
    * Serializes member variables into a data stream.
    */
   void serialize();

   /**
    * Parses the data stream into the local member variables.
    */
   virtual void parse(vpr::BufferObjectReader* reader);

   /**
    * Print the data to the screen in a readable form.
    */
   virtual void printData(int debug_level);

   /**
    * Return the type of this packet.
    */
   static vpr::Uint16 getPacketFactoryType()
   {
       return(Header::RIM_START_BLOCK);
   }
};

}


#endif