/*
 * Building.cs
 * Authors: Bradley 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.
*/

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Xna.Framework.Content;

namespace BuildingSharedContent
{
    /// <summary>
    /// Represents a building in the system.
    /// </summary>
    public abstract class Building
    {
        #region Fields

        // The name of the building
        string mName;

        // The name of the model for the building
        string mModelName;

        // The footprint size of the building
        int mFootPrintSize;

        // The amount of people it takes to run this
        int mRequiredUnskilledWorkers;
        int mRequiredSkilledWorkers;

        // The number of actual workers in the building
        int mUnskilledWorkers;
        int mSkilledWorkers;

        // The map of resource names and costs
        Dictionary<string, int> mResourceCosts;

        // The map of resources and costs for upkeep
        Dictionary<string, int> mUpkeepCosts;

        // The target building to upgrade to
        Building mTargetUpgrade;

        // The upgrade technologies for upgrading
        List<string> mUpgradeTechnologies;

        // The upgrade costs for upgrading
        Dictionary<string,int> mUpgradeCosts;

        // The costs string used for initializing the costs of the building
        string mCostsString;

        // The costs string used for initializing the upkeep costs of the building
        string mUpkeepString;

        // The upgrade string used for initializing the upgrade requirements
        string mUpgradeString;

        #endregion

        #region Properties

        /// <summary>
        /// Allows access to the name of the building.
        /// </summary>
        public string Name
        {
            get { return mName; }
            set { mName = value; }
        }

        /// <summary>
        /// Allows access to the name of the building's model.
        /// </summary>
        public string ModelName
        {
            get { return mModelName; }
            set { mModelName = value; }
        }

        /// <summary>
        /// Allows access to the footprint size of the building.
        /// </summary>
        public int FootPrintSize
        {
            get { return mFootPrintSize; }
            set { mFootPrintSize = value; }
        }

        /// <summary>
        /// Exposed serialized property used solely for creating the costs for
        /// the building.
        /// </summary>
        public string Costs
        {
            get { return mCostsString; }
            set { mCostsString = value; }
        }

        /// <summary>
        /// Allows access to the required number of unskilled workers.
        /// </summary>
        public int RequiredUnskilledWorkers
        {
            get { return mRequiredUnskilledWorkers; }
            set { mRequiredUnskilledWorkers = value; }
        }

        /// <summary>
        /// Allows access to the required number of skilled workers.
        /// </summary>
        public int RequiredSkilledWorkers
        {
            get { return mRequiredSkilledWorkers; }
            set { mRequiredSkilledWorkers = value; }
        }

        /// <summary>
        /// Exposed the upkeep string for the value.
        /// </summary>
        public string Upkeep
        {
            get { return mUpkeepString; }
            set { mUpkeepString = value; }
        }

        /// <summary>
        /// Allows access to the upgrade string.
        /// </summary>
        public string Upgrade
        {
            get { return mUpgradeString; }
            set { mUpgradeString = value; }
        }

        /// <summary>
        /// Allows access to the actual numbers of unskilled workers in the
        /// building.
        /// </summary>
        [ContentSerializerIgnore]
        public int UnskilledWorkers
        {
            get { return mUnskilledWorkers; }
            set { mUnskilledWorkers = value; }
        }

        /// <summary>
        /// Allows access to the actual numbers of skilled workers in the
        /// building.
        /// </summary>
        [ContentSerializerIgnore]
        public int SkilledWorkers
        {
            get { return mSkilledWorkers; }
            set { mSkilledWorkers = value; }
        }

        /// <summary>
        /// Allow viewing and use of the costs for the building.
        /// </summary>
        [ContentSerializerIgnore]
        public Dictionary<string, int> ResourceCosts
        {
            get { return mResourceCosts; }
        }

        /// <summary>
        /// Allow viewing and use of the costs for upkeeping the building.
        /// </summary>
        [ContentSerializerIgnore]
        public Dictionary<string, int> UpkeepCosts
        {
            get { return mUpkeepCosts; }
        }

        /// <summary>
        /// Represents the building for the targeted upgrade.
        /// </summary>
        [ContentSerializerIgnore]
        public Building TargetUpgrade
        {
            get { return mTargetUpgrade; }
            set { mTargetUpgrade = value; }
        }

        /// <summary>
        /// Allows viewing and use of the upgrade technology list.
        /// </summary>
        [ContentSerializerIgnore]
        public List<string> UpgradeTechnologies
        {
            get { return mUpgradeTechnologies; }
        }

        /// <summary>
        /// Allows viewing and use of the upgrade costs
        /// </summary>
        [ContentSerializerIgnore]
        public Dictionary<string, int> UpgradeCosts
        {
            get { return mUpgradeCosts; }
        }

        #endregion

        #region Constructs

        /// <summary>
        /// Base constructor
        /// </summary>
        public Building()
        {
            // Initialize all values needed
            mResourceCosts = new Dictionary<string, int>();
            mUpkeepCosts = new Dictionary<string, int>();
            mUpgradeTechnologies = new List<string>();
            mUpgradeCosts = new Dictionary<string,int>();
        }

        #endregion

        #region Initialization

        /// <summary>
        /// Iinitialize the building, loading the content required if needed.
        /// </summary>
        public abstract void Initialize();

        #endregion

        /// <summary>
        /// Return the information of the building in string form.
        /// </summary>
        /// <returns>Returns the basic building information.</returns>
        public override string ToString()
        {
            // Return the basic information
            return Name + ", " + ModelName + ", " + FootPrintSize;
        }
    }
}