---

CommandFrame.hpp

#if   !defined(__COMMANDFRAME_HPP)
#define  __COMMANDFRAME_HPP

/*
  CoreLinux++ 
  Copyright (C) 1999,2000 CoreLinux Consortium
  
   The CoreLinux++ 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.

   The CoreLinux++ Library 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 the GNU C Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  
*/   

#if   !defined(__COMMON_HPP)
#include <Common.hpp>
#endif

#if   !defined(__ABSTRACTCOMMAND_HPP)
#include <AbstractCommand.hpp>
#endif

#if   !defined(__VECTOR_HPP)
#include <Vector.hpp>
#endif

#if   !defined(__COMMANDFRAMEEXCEPTION_HPP)
#include <CommandFrameException.hpp>
#endif

namespace corelinux
{
   CORELINUX_VECTOR(  AbstractCommandPtr ,  Commands );

   DECLARE_CLASS( CommandFrame );

   enum  WorkState
   {

      BUILDING = 0,
      EXECUTING,
      COMPLETED,
      REVERSING,
      REVERSED,
      NEVERCOMPLETED
   };

   class CommandFrame : public Synchronized
   {

   public:

      //
      // Constructors and destructor
      //

                        CommandFrame( bool autoReverse = false );

                        CommandFrame( CommandFrameCref )
                           throw( CommandFrameException );

      virtual           ~CommandFrame( void );      

      //
      // Operator overloads
      //

               CommandFrameRef   operator=( CommandFrameCref )
                  throw( CommandFrameException );


               bool  operator==( CommandFrameCref ) const;

      //
      // Accessors
      //

               WorkState   getState( void ) const;

               bool  getReverseFlag( void ) const;

      virtual  void  getCommands( CommandsRef ) const;

      //
      // Mutators
      //

               CommandFrameRef   operator+=( AbstractCommandPtr )
                  throw( CommandFrameException );

               CommandFrameRef   operator+=( CommandFrameCref )
                  throw( CommandFrameException );

      virtual  void  addCommand( AbstractCommandPtr )
                  throw( CommandFrameException );


               void  setAutoReverse( bool ) throw( CommandFrameException );

               void  execute( void ) throw( CommandFrameException );

               void  executeReverse( void ) throw( CommandFrameException );

   protected:

      virtual  WorkState   executeCommands( void );

      virtual  WorkState   executeReverseCommands( void );

   protected:


               bool        theAutoReverseFlag;


               WorkState   theWorkState;

         
               Commands   theCommands;
   };
}

#endif // if !defined(__COMMANDFRAME_HPP)

/*
   Common rcs information do not modify
   $Author: prudhomm $
   $Revision: 1.2 $
   $Date: 2000/08/31 22:52:20 $
   $Locker:  $
*/

---

This is the CoreLinux++ reference manual
Provided by The CoreLinux Consortium