indi_del_property.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 json
 
from . import utils
 
########################################################################################################################
 
@utils.nyx_property(
    'device',
    '@device',
)
@utils.nyx_property(
    'name',
    '@name',
)
@utils.nyx_property(
    'message',
    '@message',
)
class NyxDelProperty(json.json_dict.NyxDict):
    """!
    @brief INDI / Nyx `delete-property` message object.
    """
 
    ####################################################################################################################
 
    def __init__(self, device: str, name: str | None = None, message: str | None = None):
        """!
        @brief Allocates a new INDI / Nyx `delete-property` message object.
 
        @param device Device name.
        @param name Optional vector name (`None` means the whole device).
        @param message Optional human-oriented message.
 
        @note Prefer using `NyxNode.send_del_property()`.
        """
 
        super().__init__(bind.lib.nyx_del_property_new(
            bind.as_bytes(device, allow_none = False),
            bind.as_bytes(name, allow_none = True),
            bind.as_bytes(message, allow_none = True),
        ))
 
########################################################################################################################
 
__all__ = [name for name in globals() if name.lower().startswith('nyx')]
 
########################################################################################################################