engagement_recognition: engagement_recognition/src/recognition/response/action.h Source File

00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2010, Worcester Polytechnic Institute
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions
00009  *  are met:
00010  *
00011  *   * Redistributions of source code must retain the above copyright
00012  *     notice, this list of conditions and the following disclaimer.
00013  *   * Redistributions in binary form must reproduce the above
00014  *     copyright notice, this list of conditions and the following
00015  *     disclaimer in the documentation and/or other materials provided
00016  *     with the distribution.
00017  *   * Neither the name of Worcester Polytechnic Institute. nor the names
00018  *     of its contributors may be used to endorse or promote products
00019  *     derived from this software without specific prior written permission.
00020  *
00021  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032  *  POSSIBILITY OF SUCH DAMAGE.
00033  */
00034 #ifndef ACTION_H_
00035 #define ACTION_H_
00036 
00037 #include <string>
00038 
00046 class Action
00047 {
00048 protected:
00050   std::string action_;
00051 
00053   std::string data_;
00054 
00061   Action(std::string action, std::string data);
00062 public:
00064   static const std::string NO_ACTION;
00066   static const std::string NOD;
00068   static const std::string SHAKE;
00070   static const std::string SPEECH;
00072   static const std::string POINT;
00074   static const std::string LOOK;
00076   static const std::string EXTENDED_ACTION;
00077 
00082   Action();
00083 
00089   static Action noAction();
00090 
00096   static Action nod();
00097 
00103   static Action shake();
00104 
00111   static Action speech(std::string data = "");
00112 
00119   static Action point(std::string data = "");
00120 
00127   static Action look(std::string data = "");
00128 
00135   static Action extendedAction(std::string data = "");
00136 
00142   bool isNoAction();
00143 
00149   bool isNod();
00150 
00156   bool isShake();
00157 
00163   bool isSpeech();
00164 
00170   bool isPoint();
00171 
00177   bool isLook();
00178 
00184   bool isExtendedAction();
00185 
00191   bool equals(Action a);
00192 
00198   std::string getData();
00199 
00205   void setData(std::string data);
00206 
00213   static Action fromString(std::string str);
00214 
00220   const char *toString();
00221 
00227   int toValue();
00228 };
00229 
00230 #endif /* ACTION_H_ */