bbtkBlackBoxInputOutputDescriptor.h

Go to the documentation of this file.

/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkBlackBoxInputOutputDescriptor.h,v $
  Language:  C++
  Date:      $Date: 2008/10/17 08:18:12 $
  Version:   $Revision: 1.5 $
=========================================================================*/

/* ---------------------------------------------------------------------

* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
*
*  This software is governed by the CeCILL-B license under French law and 
*  abiding by the rules of distribution of free software. You can  use, 
*  modify and/ or redistribute the software under the terms of the CeCILL-B 
*  license as circulated by CEA, CNRS and INRIA at the following URL 
*  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
*  or in the file LICENSE.txt.
*
*  As a counterpart to the access to the source code and  rights to copy,
*  modify and redistribute granted by the license, users are provided only
*  with a limited warranty  and the software's author,  the holder of the
*  economic rights,  and the successive licensors  have only  limited
*  liability. 
*
*  The fact that you are presently reading this means that you have had
*  knowledge of the CeCILL-B license and that you accept its terms.
* ------------------------------------------------------------------------ */                                                                         


#ifndef __bbtkBlackBoxInputOutputDescriptor_h__
#define __bbtkBlackBoxInputOutputDescriptor_h__

#include "bbtkSystem.h"
#include "bbtkData.h"
#include "bbtkRTTI.h"


namespace bbtk
{
  class BBTK_EXPORT BlackBoxInputOutputDescriptor
  {
  public:
    BlackBoxInputOutputDescriptor(TypeInfo creator_type_info,
                                  const std::string& name,
                                  const std::string& description,
                                  const std::string& nature,
                                  bool copy_construct = true
                                  )
      : mCreatorTypeInfo(creator_type_info),
        mName(name), 
        mDescription(description),
        mNature(nature),
        mCopyConstruct(copy_construct)
    {}
    virtual ~BlackBoxInputOutputDescriptor() {}

    TypeInfo GetCreatorTypeInfo() const { return mCreatorTypeInfo; }
    const std::string& GetName() const { return mName; }
    const std::string& GetDescription() const { return mDescription; }
    const std::string& GetNature() const { return mNature; }
    virtual TypeInfo GetTypeInfo() const = 0;
    virtual std::string GetTypeName() const = 0;
    virtual DataInfo GetDataInfo() const 
    { return DataInfo(this->GetTypeInfo(),mNature); }
    virtual std::string GetHumanTypeName() const = 0;
    virtual bool IsPointerType() const = 0;
    bool GetCopyConstruct() const { return mCopyConstruct; }

  protected:
    BlackBoxInputOutputDescriptor() : mCreatorTypeInfo(typeid(void)),
                                      mName(""), mDescription(""),
                                      mNature(""),
                                      mCopyConstruct(true)
                                {}
  private:

    TypeInfo mCreatorTypeInfo;
    std::string mName;
    std::string mDescription;
    std::string mNature;
    bool mCopyConstruct;
  };
  
}
// namespace bbtk
#endif