/*
 * Resource.cs
 * Authors: Bradley R. Blankenship
 * Copyright (c) 2007-2008 Cornell University

 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 2
 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, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

namespace ColonySim
{
    /// <summary>
    /// Represents a resource in the Colony game.
    /// </summary>
    public class Resource
    {
        #region Fields

        /// <summary>
        /// Name of the resource
        /// </summary>
        ResourceCode mResourceCode = ResourceCode.B1;

        /// <summary>
        /// Amount of the resource
        /// </summary>
        int mResourceAmount = 100;

        #endregion

        #region Properties

        /// <summary>
        /// Allows access to the code of the given resource.
        /// </summary>
        public ResourceCode ResourceCode
        {
            get { return mResourceCode; }
            set { mResourceCode = value; }
        }

        /// <summary>
        /// Allows access to the amount of the given resource.
        /// </summary>
        public int Amount
        {
            get { return mResourceAmount; }
            set { mResourceAmount = value; }
        }

        #endregion

        #region Utility

        /// <summary>
        /// Makes a copy of this resource object
        /// </summary>
        /// <returns>A copy of this resource object</returns>
        public Resource Clone()
        {
            // The return value
            Resource retVal = new Resource();

            // Set its values to our values
            retVal.ResourceCode = ResourceCode;
            retVal.Amount = Amount;

            // Return the value
            return retVal;
        }

        #endregion
    }
}