json_boolean.py

# -*- coding: utf-8 -*-
########################################################################################################################
# NyxNode
# Author: Jérôme ODIER <jerome.odier@lpsc.in2p3.fr>
# SPDX-License-Identifier: GPL-3.0+
########################################################################################################################
 
from .. import bind
from .. import obj
 
########################################################################################################################
 
class NyxBoolean(obj.NyxObject):
    """!
    @brief JSON boolean object.
    """
 
    ####################################################################################################################
 
    def __init__(self, value: int | float | bool | None = None, ptr: int | None = None):
        """!
        @brief Allocates a new JSON boolean object or wraps one.
 
        @param value Optional default value.
        @param ptr Optional JSON boolean object pointer.
        """
 
        ################################################################################################################
 
        if ptr is None:
 
            ptr = bind.lib.nyx_boolean_new()
 
        elif bind.lib.nyx_object_get_type(ptr) != bind.NyxObjectType.BOOLEAN:
 
            raise TypeError('Not a pointer to a Nyx boolean object')
 
        ################################################################################################################
 
        super().__init__(ptr)
 
        ################################################################################################################
 
        if isinstance(value, (int, float, bool)):
 
            self.value = bool(value)
 
    ####################################################################################################################
 
    @property
    def value(self) -> bool:
        """!
        @brief Gets the value of this JSON boolean object.
 
        @return The current value.
        """
 
        return bool(bind.lib.nyx_boolean_get(self.ptr))
 
    ####################################################################################################################
 
    @value.setter
    def value(self, value: bool) -> bool:
        """!
        @brief Sets the value of this JSON boolean object.
 
        @return @c True if the value was modified, @c False otherwise.
        """
 
        return bool(bind.lib.nyx_boolean_set(self.ptr, bool(value)))
 
########################################################################################################################
 
__all__ = ['NyxBoolean']
 
########################################################################################################################