parameter_entry.h

// Copyright Maciej Sobczak 2008-2022.
// This file is part of YAMI4.
// See the package-level LICENSE.txt file.
 
#ifndef YAMICPP_PARAMETER_ENTRY_H_INCLUDED
#define YAMICPP_PARAMETER_ENTRY_H_INCLUDED
 
#include "parameter_type.h"
#include <yami4-core/dll.h>
#include <yami4-core/parameter_entry.h>
#include <yami4-core/parameters.h>
#include <string>
 
namespace yami
{
 
class DLL parameter_entry
{
public:
    parameter_type type() const;
 
    std::string name() const;
 
    bool get_boolean() const;
 
    int get_integer() const;
 
    long long get_long_long() const;
 
    unsigned int get_word() const;
 
    unsigned long long get_long_long_word() const;
 
    double long get_double_float() const;
 
    std::string get_string() const;
 
    const char * get_string(std::size_t & length) const;
 
    const void * get_binary(std::size_t & length) const;
 
    core::parameters * get_nested_parameters() const;
 
    bool * get_boolean_array(std::size_t & array_length) const;
 
    int * get_integer_array(std::size_t & array_length) const;
 
    long long * get_long_long_array(std::size_t & array_length) const;
 
    unsigned int * get_word_array(std::size_t & array_length) const;
 
    unsigned long long * get_long_long_word_array(std::size_t & array_length) const;
 
    double * get_double_float_array(std::size_t & array_length) const;
 
    std::size_t get_string_array_length() const;
 
    std::string get_string_in_array(std::size_t index) const;
 
    const char * get_string_in_array(std::size_t index,
        std::size_t & value_length) const;
 
    std::size_t get_binary_array_length() const;
 
    const void * get_binary_in_array(std::size_t index,
        std::size_t & value_length) const;
 
    core::parameter_entry entry_;
};
 
} // namespace yami
 
#endif // YAMICPP_PARAMETER_ENTRY_H_INCLUDED