RdsContainer.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
 
    Copyright (c) 2004 Media Development Loan Fund
  
    This file is part of the Campcaster project.
    https://www.campware.org/
    To report bugs, send an e-mail to [email protected]
  
    Campcaster 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.
   
    Campcaster 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 Campcaster; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  
  
    Author   : $Author: fgerlits $
    Version  : $Revision: 3185 $
    Location : $URL: svn://code.campware.org/campcaster/trunk/campcaster/src/modules/core/include/LiveSupport/Core/RdsContainer.h $
 
------------------------------------------------------------------------------*/
#ifndef LiveSupport_Core_RdsContainer_h
 #define LiveSupport_Core_RdsContainer_h
 
#ifndef __cplusplus
 #error This is a C++ include file
 #endif
 

/* ============================================================ include files */

#ifdef HAVE_CONFIG_H
 #include "configure.h"
#endif
 
#include <map>

#include "LiveSupport/Core/Ptr.h"
#include "LiveSupport/Core/Configurable.h"

#include "LiveSupport/Core/RdsItem.h"


namespace LiveSupport {
namespace Core {

using namespace LiveSupport::Core;

/* ================================================================ constants */


/* =================================================================== macros */


/* =============================================================== data types */

class RdsContainer : public Configurable
{
    private:
        static const std::string    configElementName;

        typedef std::vector<Ptr<RdsItem>::Ref>
                                    RdsItemListType;

        RdsItemListType             rdsItemList;

        Ptr<xmlpp::Document>::Ref   xmlDocument;
        
        bool                        touched;


    public:
        RdsContainer()                                 throw ()
            : touched(false)
        {
        }

        virtual
        ~RdsContainer(void)                            throw ()
        {
        }

        static const std::string
        getConfigElementName(void)                              throw ()
        {
            return configElementName;
        }

        virtual void
        configure(const xmlpp::Element &element)
                                                throw (std::invalid_argument);

        void
        setRdsOptions(Ptr<const Glib::ustring>::Ref  key,
                      Ptr<const Glib::ustring>::Ref  value,
                      bool                           enabled)       throw ();
        
        Ptr<const Glib::ustring>::Ref
        getRdsValue(Ptr<const Glib::ustring>::Ref  key)
                                                throw (std::invalid_argument);

        bool
        getRdsEnabled(Ptr<const Glib::ustring>::Ref  key)
                                                throw (std::invalid_argument);

        Ptr<Glib::ustring>::Ref
        toString(void)                                              throw ();

        const xmlpp::Element *
        toXmlElement(void)                                          throw ();

        bool
        isTouched(void)                                             throw ()
        {
            return touched;
        }
};


/* ================================================= external data structures */


/* ====================================================== function prototypes */


} // namespace Core
} // namespace LiveSupport

#endif // LiveSupport_Core_RdsContainer_h
 

---