CCA
State.h
Go to the documentation of this file.
00001 /* ============================================================
00002  *
00003  * This file is a part of CCA project
00004  *
00005  * Copyright (C) 2011 by Arne Nordmann <anordman at cor-lab dot uni-bielefeld dot de>
00006  *
00007  * This file may be licensed under the terms of the
00008  * GNU Lesser General Public License Version 3 (the ``LGPL''),
00009  * or (at your option) any later version.
00010  *
00011  * Software distributed under the License is distributed
00012  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
00013  * express or implied. See the LGPL for the specific language
00014  * governing rights and limitations.
00015  *
00016  * You should have received a copy of the LGPL along with this
00017  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
00018  * or write to the Free Software Foundation, Inc.,
00019  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00020  *
00021  * The development of this software was supported by:
00022  *   CoR-Lab, Research Institute for Cognition and Robotics
00023  *     Bielefeld University
00024  *
00025  * ============================================================ */
00026 
00027 #pragma once
00028 
00029 #include <iostream>
00030 
00031 #include <boost/shared_ptr.hpp>
00032 
00033 #include "cca/dto/DataTransferObject.h"
00034 
00035 namespace cca {
00036 
00045 class ComponentState;
00046 typedef ::boost::shared_ptr<ComponentState> ComponentStatePtr;
00047 
00051 class ComponentState: public DataTransferObject {
00052 public:
00053     static ComponentStatePtr PERSISTED();
00054     static ComponentStatePtr LOADED();
00055     static ComponentStatePtr PAUSED();
00056     static ComponentStatePtr STOPPED();
00057     static ComponentStatePtr EXECUTION();
00058     static ComponentStatePtr ONLINELEARNING();
00059     static ComponentStatePtr OFFLINELEARNING();
00060     static ComponentStatePtr DATAACQUISITION();
00061     static ComponentStatePtr RESET();
00062 
00066     enum State {
00067         STATE_RESET = 32,
00068         STATE_PAUSE = 31,
00069         STATE_ACQUIRE = 24,
00070         STATE_OFFLLEARN = 23,
00071         STATE_ONLLEARN = 22,
00072         STATE_EXEC = 21,
00073         STATE_LOAD = 12,
00074         STATE_PERSIST = 11,
00075         STATE_OFF = 0
00076     };
00077 
00078     ComponentState::State getState() const;
00079 
00085     virtual std::string print() const;
00086 
00087     virtual ~ComponentState();
00088 
00089 protected:
00090 
00092     ComponentState(ComponentState::State state);
00093 
00094     ComponentState::State state;
00095 };
00096 
00097 bool operator==(ComponentStatePtr const a, ComponentStatePtr const b);
00098 
00102 bool operator==(ComponentState const a, ComponentState const b);
00103 
00107 bool operator!=(ComponentState const a, ComponentState const b);
00108 
00109 }