AlgMetadata.hh

Go to the documentation of this file.

#ifndef _OM_ALGORITHM_METADATAHH_
#define _OM_ALGORITHM_METADATAHH_

#include <openmodeller/om_defs.hh>
#include <string>

enum AlgParamDatatype {

  Integer = 0,
  Real    = 1,
  String  = 2

} ;

/****************************************************************/
/***************** Algorithm Parameter Metadata *****************/

struct AlgParamMetadata
{
  std::string id;          
  std::string name;        
  AlgParamDatatype type;   
  std::string overview;    
  std::string description; 

  int    has_min;      
  Scalar min_val;      
  int    has_max;      
  Scalar max_val;      
  std::string typical; 
} ;


/****************************************************************/
/********************** Algorithm Metadata **********************/

struct AlgMetadata
{
  std::string id;          
  std::string name;        
  std::string version;     
  std::string overview;    
  std::string description; 

  std::string author;      
  std::string biblio;      

  std::string code_author; 
  std::string contact;     

  int  categorical;  
  int  absence;      
  int  nparam;       

  AlgParamMetadata * param;
} ;



#endif