Objects.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2011, SRI International (R)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef __OpenKarto_Object_h__
#define __OpenKarto_Object_h__

#include <OpenKarto/Object.h>

namespace karto
{




  class KARTO_EXPORT ModuleParameters : public Object
  {
    KARTO_RTTI();

  public:
    ModuleParameters(const Identifier& rName);

  protected:
    //@cond EXCLUDE
    virtual ~ModuleParameters();
    //@endcond
    
  private:
    // restrict the following functions
    ModuleParameters(const ModuleParameters&);
    const ModuleParameters& operator=(const ModuleParameters&);
  }; // ModuleParameters

  KARTO_TYPE(ModuleParameters);

  typedef SmartPointer<ModuleParameters> ParametersPtr;


  class KARTO_EXPORT CustomItem : public Object
  {
    KARTO_RTTI();

  public:
    CustomItem();

    CustomItem(const Identifier& rName);

  protected:
    //@cond EXCLUDE
    virtual ~CustomItem();
    //@endcond
    
  public:
    virtual const String& Write() const = 0;
    
    virtual void Read(const String& pValue) = 0;

  private:
    // restrict the following functions
    CustomItem(const CustomItem&);
    const CustomItem& operator=(const CustomItem&);
  }; // CustomItem

  KARTO_TYPE(CustomItem);

  typedef SmartPointer<CustomItem> CustomItemPtr;

  typedef List<CustomItemPtr> CustomItemList;


  class KARTO_EXPORT DatasetInfo : public Object
  {
    KARTO_RTTI();

  public:
    DatasetInfo();
  
  protected:
    //@cond EXCLUDE
    virtual ~DatasetInfo();
    //@endcond
    
  public:
    const String& GetTitle() const;

    const String& GetAuthor() const;

    const String& GetDescription() const;

    const String& GetCopyright() const;

  private:
    // restrict the following functions
    DatasetInfo(const DatasetInfo&);
    const DatasetInfo& operator=(const DatasetInfo&);

  private:
    Parameter<String>* m_pTitle;
    Parameter<String>* m_pAuthor;
    Parameter<String>* m_pDescription;
    Parameter<String>* m_pCopyright;
  }; // class DatasetInfo

  KARTO_TYPE(DatasetInfo);

  typedef SmartPointer<DatasetInfo> DatasetInfoPtr;


}

#endif // __OpenKarto_Object_h__