parameter_entry.h

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