operator/ALDOpParameterDescriptor.h

Go to the documentation of this file.

/*
 * This file is part of Alida-C++ library for
 *
 * Advanced Library for Integrated Development of Data Analysis Applications.
 *
 * Copyright (C) 2012 - @YEAR@
 *
 * 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 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Fore more information on Alida, visit
 *
 *    http://www.informatik.uni-halle.de/alida/
 *
 */

/*
 * Most recent change(s):
 *
 * $Rev: 47 $
 * $Date: 2012/03/06 20:50:22 $
 * $Author: posch $
 *
 */

#ifndef OPPARAMETERDESCRIPTOR_H_INCLUDED
#define OPPARAMETERDESCRIPTOR_H_INCLUDED

#include <string>
#include <typeinfo>

namespace Alida {

typedef enum {  PARAMETER_IN,
                                PARAMETER_OUT,
                                PARAMETER_INOUT} ALDParameterDirection;

class ALDOpParameterDescriptor
{
 public:

  const std::string name;
  const std::string typeIdStr;
  const std::string typeNiceName;
  const ALDParameterDirection direction;
  const bool required;
  const bool supplemental;
  const std::string label;
  const std::string explanation;
  const void* defaultValue;
  void* value;

  ALDOpParameterDescriptor( std::string _name, std::string _typeIdStr,
            std::string _typeNiceName, ALDParameterDirection _direction,
            bool _required, bool _supplemental, std::string _label,
            std::string _explanation, void* _defaultValue);

  ~ALDOpParameterDescriptor() {
    //TODO: delete value and defaultValue
  }
};

}

#endif /* OPPARAMETERDESCRIPTOR_H_INCLUDED */