#    Clarion Architecture implementation in Python.
#    Copyright (C) 2013  Clarion-Architecture Authors (see AUTHORS.txt)
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program 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 General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.

class Drive:
    """
    This is the abstract base class for all drives: physiological, social and custom, used in PyClarion.
    """

    # ICommitable, ISubscribes<ParameterChangeRequestedEventArgs>, IDefinesAgentMetaInfo

    # public enum MetaInfoReservations { DRIVE_GAIN, UNIVERSAL_GAIN, STIMULUS, DEFICIT, BASELINE, DRIVE_STRENGTH }

    isBAS = None    # True if part of the Behavioral Activation System
    isBIS = None    # True if part of the Behavioral Inhibition System

    # parameters = DriveParameter.

    def __init__(self):
        pass


class DriveCollection(dict):
    """
    A specialized dictionary used for holding a set of Drives, of mixed subtypes.
    """

    def __init__(self):
        dict.__init__()
        pass


if __name__ == '__main__':
    # TODO - TESTING
    print Drive.__name__ +  ":" + Drive.__doc__
    print DriveCollection.__name__  + ":" +  DriveCollection.__doc__
