functionDescription.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014 Patrick P. Frey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef _STRUS_FUNCTION_DESCRIPTION_HPP_INCLUDED
#define _STRUS_FUNCTION_DESCRIPTION_HPP_INCLUDED
#include "strus/numericVariant.hpp"
#include <string>
#include <vector>

namespace strus
{

class FunctionDescription
{
public:
        struct Parameter
        {
                enum Type
                {
                        Feature,                
                        Attribute,              
                        Metadata,               
                        Numeric,                
                        String                  
                };
                static const char* typeName( Type i)
                {
                        static const char* ar[] = {"Feature","Attribute","Metadata","Numeric","String",0};
                        return ar[i];
                }

                Parameter( const Type& type_, const std::string& name_, const std::string& text_, const std::string& domain_)
                        :m_type(type_),m_name(name_),m_text(text_),m_domain(domain_){}
                Parameter( const Parameter& o)
                        :m_type(o.m_type),m_name(o.m_name),m_text(o.m_text),m_domain(o.m_domain){}

                Type type() const                       {return m_type;}
                const char* typeName() const            {return typeName(m_type);}

                const std::string& name() const         {return m_name;}

                const std::string& text() const         {return m_text;}

                const std::string& domain() const       {return m_domain;}

        private:
                Type m_type;                    
                std::string m_name;             
                std::string m_text;             
                std::string m_domain;           
        };

public:
        FunctionDescription& operator()( Parameter::Type type_, const std::string& name_, const std::string& text_, const std::string& domain_=std::string())
        {
                m_param.push_back( Parameter( type_, name_, text_, domain_));
                return *this;
        }

        FunctionDescription(){}

        explicit FunctionDescription( const std::string& text_)
                :m_text(text_){}

        FunctionDescription( const FunctionDescription& o)
                :m_text(o.m_text),m_param(o.m_param){}

        FunctionDescription( const FunctionDescription& o, const std::string& text_)
                :m_text(text_ + ": " + o.m_text),m_param(o.m_param){}

        const std::string& text() const                         {return m_text;}

        const std::vector<Parameter>& parameter() const         {return m_param;}

private:
        std::string m_text;             
        std::vector<Parameter> m_param; 
};

} //namespace
#endif