amxd_object_parameter.h

Go to the documentation of this file.

/****************************************************************************
**
** SPDX-License-Identifier: BSD-2-Clause-Patent
**
** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
**
** Redistribution and use in source and binary forms, with or without modification,
** are permitted provided that the following conditions are met:
**
** 1. Redistributions of source code must retain the above copyright notice,
** this list of conditions and the following disclaimer.
**
** 2. Redistributions in binary form must reproduce the above copyright notice,
** this list of conditions and the following disclaimer in the documentation
** and/or other materials provided with the distribution.
**
** Subject to the terms and conditions of this license, each copyright holder
** and contributor hereby grants to those receiving rights under this license
** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
** (except for failure to satisfy the conditions of this license) patent license
** to make, have made, use, offer to sell, sell, import, and otherwise transfer
** this software, where such license applies only to those patent claims, already
** acquired or hereafter acquired, licensable by such copyright holder or contributor
** that are necessarily infringed by:
**
** (a) their Contribution(s) (the licensed copyrights of copyright holders and
** non-copyrightable additions of contributors, in source or binary form) alone;
** or
**
** (b) combination of their Contribution(s) with the work of authorship to which
** such Contribution(s) was added by such copyright holder or contributor, if,
** at the time the Contribution is added, such addition causes such combination
** to be necessarily infringed. The patent license shall not apply to any other
** combinations which include the Contribution.
**
** Except as expressly stated above, no rights or licenses from any copyright
** holder or contributor is granted under this license, whether expressly, by
** implication, estoppel or otherwise.
**
** DISCLAIMER
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
****************************************************************************/
 
#if !defined(__AMXD_OBJECT_PARAMETER_H__)
#define __AMXD_OBJECT_PARAMETER_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <amxd/amxd_types.h>
#include <amxd/amxd_parameter.h>
 
#define amxd_object_set_value(type, object, name, value) \
    amxd_object_set_ ## type(object, name, value)
 
#define amxd_object_get_value(type, object, name, status) \
    amxd_object_get_ ## type(object, name, status)
 
amxd_status_t amxd_object_add_param(amxd_object_t* const object,
                                    amxd_param_t* const param);
 
amxd_param_t* amxd_object_get_param_def(const amxd_object_t* const object,
                                        const char* name);
 
 
amxd_param_t* amxd_object_get_param_counter_by_counted_object(const amxd_object_t* const object);
 
 
amxd_status_t amxd_object_set_param(amxd_object_t* const object,
                                    const char* name,
                                    amxc_var_t* const value);
 
amxd_status_t amxd_object_set_params(amxd_object_t* const object,
                                     amxc_var_t* const values);
 
amxd_status_t amxd_object_get_param(amxd_object_t* const object,
                                    const char* name,
                                    amxc_var_t* const value);
 
const amxc_var_t* amxd_object_get_param_value(const amxd_object_t* const object,
                                              const char* name);
 
amxd_status_t amxd_object_get_params(amxd_object_t* const object,
                                     amxc_var_t* const params,
                                     amxd_dm_access_t access);
 
amxd_status_t amxd_object_get_params_with_attr(amxd_object_t* const object,
                                               amxc_var_t* const params,
                                               uint32_t attrs,
                                               amxd_dm_access_t access);
 
amxd_status_t amxd_object_get_params_filtered(amxd_object_t* const object,
                                              amxc_var_t* const params,
                                              const char* filter,
                                              amxd_dm_access_t access);
 
amxd_status_t amxd_object_get_key_params(amxd_object_t* const object,
                                         amxc_var_t* const params,
                                         amxd_dm_access_t access);
 
amxd_status_t amxd_object_list_params(amxd_object_t* const object,
                                      amxc_var_t* const list,
                                      amxd_dm_access_t access);
 
amxd_status_t amxd_object_describe_params(amxd_object_t* const object,
                                          amxc_var_t* const value,
                                          amxd_dm_access_t access);
 
amxd_status_t amxd_object_describe_key_params(amxd_object_t* const object,
                                              amxc_var_t* const value,
                                              amxd_dm_access_t access);
 
uint32_t amxd_object_get_param_count(amxd_object_t* object,
                                     amxd_dm_access_t access);
 
 
// helper functions
amxd_status_t amxd_object_set_cstring_t(amxd_object_t* const object,
                                        const char* name,
                                        const char* value);
 
amxd_status_t amxd_object_set_csv_string_t(amxd_object_t* const object,
                                           const char* name,
                                           const char* value);
 
amxd_status_t amxd_object_set_ssv_string_t(amxd_object_t* const object,
                                           const char* name,
                                           const char* value);
 
amxd_status_t amxd_object_set_bool(amxd_object_t* const object,
                                   const char* name,
                                   bool value);
 
 
amxd_status_t amxd_object_set_int8_t(amxd_object_t* const object,
                                     const char* name,
                                     int8_t value);
 
amxd_status_t amxd_object_set_uint8_t(amxd_object_t* const object,
                                      const char* name,
                                      uint8_t value);
 
amxd_status_t amxd_object_set_int16_t(amxd_object_t* const object,
                                      const char* name,
                                      int16_t value);
 
amxd_status_t amxd_object_set_uint16_t(amxd_object_t* const object,
                                       const char* name,
                                       uint16_t value);
 
amxd_status_t amxd_object_set_int32_t(amxd_object_t* const object,
                                      const char* name,
                                      int32_t value);
 
amxd_status_t amxd_object_set_uint32_t(amxd_object_t* const object,
                                       const char* name,
                                       uint32_t value);
 
amxd_status_t amxd_object_set_int64_t(amxd_object_t* const object,
                                      const char* name,
                                      int64_t value);
 
amxd_status_t amxd_object_set_uint64_t(amxd_object_t* const object,
                                       const char* name,
                                       uint64_t value);
 
amxd_status_t amxd_object_set_double(amxd_object_t* const object,
                                     const char* name,
                                     double value);
 
amxd_status_t amxd_object_set_amxc_ts_t(amxd_object_t* const object,
                                        const char* name,
                                        amxc_ts_t* value);
 
char* amxd_object_get_cstring_t(amxd_object_t* const object,
                                const char* name,
                                amxd_status_t* status);
 
bool amxd_object_get_bool(amxd_object_t* const object,
                          const char* name,
                          amxd_status_t* status);
 
int8_t amxd_object_get_int8_t(amxd_object_t* const object,
                              const char* name,
                              amxd_status_t* status);
 
uint8_t amxd_object_get_uint8_t(amxd_object_t* const object,
                                const char* name,
                                amxd_status_t* status);
 
int16_t amxd_object_get_int16_t(amxd_object_t* const object,
                                const char* name,
                                amxd_status_t* status);
 
uint16_t amxd_object_get_uint16_t(amxd_object_t* const object,
                                  const char* name,
                                  amxd_status_t* status);
 
int32_t amxd_object_get_int32_t(amxd_object_t* const object,
                                const char* name,
                                amxd_status_t* status);
 
uint32_t amxd_object_get_uint32_t(amxd_object_t* const object,
                                  const char* name,
                                  amxd_status_t* status);
 
int64_t amxd_object_get_int64_t(amxd_object_t* const object,
                                const char* name,
                                amxd_status_t* status);
 
uint64_t amxd_object_get_uint64_t(amxd_object_t* const object,
                                  const char* name,
                                  amxd_status_t* status);
 
double amxd_object_get_double(amxd_object_t* const object,
                              const char* name,
                              amxd_status_t* status);
 
amxc_ts_t* amxd_object_get_amxc_ts_t(amxd_object_t* const object,
                                     const char* name,
                                     amxd_status_t* status);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_OBJECT_PARAMETER_H__