hlrc

"""

This file is part of hlrc

Copyright(c) sschulz <AT> techfak.uni-bielefeld.de

http://opensource.cit-ec.de/projects/hlrc

This file may be licensed under the terms of the

GNU General Public License Version 3 (the ``GPL''),

or (at your option) any later version.

Software distributed under the License is distributed

on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either

express or implied. See the GPL for the specific language

governing rights and limitations.

You should have received a copy of the GPL along with this

program. If not, go to http://www.gnu.org/licenses/gpl.html

or write to the Free Software Foundation, Inc.,

51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

The development of this software was supported by the

Excellence Cluster EXC 277 Cognitive Interaction Technology.

The Excellence Cluster EXC 277 is a grant of the Deutsche

Forschungsgemeinschaft (DFG) in the context of the German

Excellence Initiative.

"""

class RobotEmotion:

    TYPE_DEFAULT = 0

    TYPE_CURRENT = 1

    NEUTRAL   = 0

    HAPPY     = 1

    SAD       = 2

    ANGRY     = 3

    SURPRISED = 4

    FEAR      = 5

    # mappings from values to strings and vice versa

    __value_as_str = dict(zip([NEUTRAL, HAPPY, SAD, ANGRY, SURPRISED, FEAR],

                              ['neutral', 'happy', 'sad', 'angry', 'surprised', 'fear']))

    __str_as_value = dict([(s,v) for v,s in __value_as_str.iteritems()])

    def __init__(self, emotion = NEUTRAL, duration = 1.):

        """ constructor

        param emotion: emotion constant

        param duration: duration of emotion in seconds

        """

        try:

            self.value = int(emotion)

            try:

                self.__value_as_str[self.value]

            except KeyError:

                raise Exception('invalid emotion id: %d' % self.value)

        except ValueError:

            try:

                self.value = self.__str_as_value[emotion.lower()]

            except KeyError:

                raise Exception('invalid emotion: %s' % emotion)

        self.time_ms = int(1000*duration) # convert from s to ms

    def value_as_str(self):

        try:

            return self.__value_as_str[self.value]

        except KeyError:

            return "INVALID EMOTION TYPE"

    def __str__(self):

        return "RobotEmotion = { value='%s', time_ms=%d }" % (self.value_as_str(), self.time_ms)