<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: api/multicast_group.proto

namespace Chirpstack\Api;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * Generated from protobuf message <code>api.MulticastGroup</code>
 */
class MulticastGroup extends \Google\Protobuf\Internal\Message
{
    /**
     * ID (UUID).
     * This will be generated automatically on create.
     *
     * Generated from protobuf field <code>string id = 1;</code>
     */
    protected $id = '';
    /**
     * Name.
     *
     * Generated from protobuf field <code>string name = 2;</code>
     */
    protected $name = '';
    /**
     * Application ID.
     * After creation, this can not be updated.
     *
     * Generated from protobuf field <code>string application_id = 3;</code>
     */
    protected $application_id = '';
    /**
     * Region.
     *
     * Generated from protobuf field <code>.common.Region region = 4;</code>
     */
    protected $region = 0;
    /**
     * Multicast address (HEX encoded DevAddr).
     *
     * Generated from protobuf field <code>string mc_addr = 5;</code>
     */
    protected $mc_addr = '';
    /**
     * Multicast network session key (HEX encoded AES128 key).
     *
     * Generated from protobuf field <code>string mc_nwk_s_key = 6;</code>
     */
    protected $mc_nwk_s_key = '';
    /**
     * Multicast application session key (HEX encoded AES128 key).
     *
     * Generated from protobuf field <code>string mc_app_s_key = 7;</code>
     */
    protected $mc_app_s_key = '';
    /**
     * Frame-counter.
     *
     * Generated from protobuf field <code>uint32 f_cnt = 8;</code>
     */
    protected $f_cnt = 0;
    /**
     * Multicast group type.
     *
     * Generated from protobuf field <code>.api.MulticastGroupType group_type = 9;</code>
     */
    protected $group_type = 0;
    /**
     * Data-rate.
     *
     * Generated from protobuf field <code>uint32 dr = 10;</code>
     */
    protected $dr = 0;
    /**
     * Frequency (Hz).
     *
     * Generated from protobuf field <code>uint32 frequency = 11;</code>
     */
    protected $frequency = 0;
    /**
     * Ping-slot period (only for Class-B).
     * Deprecated: use class_b_ping_slot_nb_k.
     *
     * Generated from protobuf field <code>uint32 class_b_ping_slot_period = 12;</code>
     */
    protected $class_b_ping_slot_period = 0;
    /**
     * Class-B ping-slots per beacon period (only for Class-B).
     * Valid options are: 0 - 7;
     * The actual number of ping-slots per beacon period equals to 2^k.
     *
     * Generated from protobuf field <code>uint32 class_b_ping_slot_nb_k = 14;</code>
     */
    protected $class_b_ping_slot_nb_k = 0;
    /**
     * Scheduling type (only for Class-C).
     *
     * Generated from protobuf field <code>.api.MulticastGroupSchedulingType class_c_scheduling_type = 13;</code>
     */
    protected $class_c_scheduling_type = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $id
     *           ID (UUID).
     *           This will be generated automatically on create.
     *     @type string $name
     *           Name.
     *     @type string $application_id
     *           Application ID.
     *           After creation, this can not be updated.
     *     @type int $region
     *           Region.
     *     @type string $mc_addr
     *           Multicast address (HEX encoded DevAddr).
     *     @type string $mc_nwk_s_key
     *           Multicast network session key (HEX encoded AES128 key).
     *     @type string $mc_app_s_key
     *           Multicast application session key (HEX encoded AES128 key).
     *     @type int $f_cnt
     *           Frame-counter.
     *     @type int $group_type
     *           Multicast group type.
     *     @type int $dr
     *           Data-rate.
     *     @type int $frequency
     *           Frequency (Hz).
     *     @type int $class_b_ping_slot_period
     *           Ping-slot period (only for Class-B).
     *           Deprecated: use class_b_ping_slot_nb_k.
     *     @type int $class_b_ping_slot_nb_k
     *           Class-B ping-slots per beacon period (only for Class-B).
     *           Valid options are: 0 - 7;
     *           The actual number of ping-slots per beacon period equals to 2^k.
     *     @type int $class_c_scheduling_type
     *           Scheduling type (only for Class-C).
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Chirpstack\Api\MulticastGroup::initOnce();
        parent::__construct($data);
    }

    /**
     * ID (UUID).
     * This will be generated automatically on create.
     *
     * Generated from protobuf field <code>string id = 1;</code>
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * ID (UUID).
     * This will be generated automatically on create.
     *
     * Generated from protobuf field <code>string id = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setId($var)
    {
        GPBUtil::checkString($var, True);
        $this->id = $var;

        return $this;
    }

    /**
     * Name.
     *
     * Generated from protobuf field <code>string name = 2;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Name.
     *
     * Generated from protobuf field <code>string name = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Application ID.
     * After creation, this can not be updated.
     *
     * Generated from protobuf field <code>string application_id = 3;</code>
     * @return string
     */
    public function getApplicationId()
    {
        return $this->application_id;
    }

    /**
     * Application ID.
     * After creation, this can not be updated.
     *
     * Generated from protobuf field <code>string application_id = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setApplicationId($var)
    {
        GPBUtil::checkString($var, True);
        $this->application_id = $var;

        return $this;
    }

    /**
     * Region.
     *
     * Generated from protobuf field <code>.common.Region region = 4;</code>
     * @return int
     */
    public function getRegion()
    {
        return $this->region;
    }

    /**
     * Region.
     *
     * Generated from protobuf field <code>.common.Region region = 4;</code>
     * @param int $var
     * @return $this
     */
    public function setRegion($var)
    {
        GPBUtil::checkEnum($var, \Chirpstack\Common\Region::class);
        $this->region = $var;

        return $this;
    }

    /**
     * Multicast address (HEX encoded DevAddr).
     *
     * Generated from protobuf field <code>string mc_addr = 5;</code>
     * @return string
     */
    public function getMcAddr()
    {
        return $this->mc_addr;
    }

    /**
     * Multicast address (HEX encoded DevAddr).
     *
     * Generated from protobuf field <code>string mc_addr = 5;</code>
     * @param string $var
     * @return $this
     */
    public function setMcAddr($var)
    {
        GPBUtil::checkString($var, True);
        $this->mc_addr = $var;

        return $this;
    }

    /**
     * Multicast network session key (HEX encoded AES128 key).
     *
     * Generated from protobuf field <code>string mc_nwk_s_key = 6;</code>
     * @return string
     */
    public function getMcNwkSKey()
    {
        return $this->mc_nwk_s_key;
    }

    /**
     * Multicast network session key (HEX encoded AES128 key).
     *
     * Generated from protobuf field <code>string mc_nwk_s_key = 6;</code>
     * @param string $var
     * @return $this
     */
    public function setMcNwkSKey($var)
    {
        GPBUtil::checkString($var, True);
        $this->mc_nwk_s_key = $var;

        return $this;
    }

    /**
     * Multicast application session key (HEX encoded AES128 key).
     *
     * Generated from protobuf field <code>string mc_app_s_key = 7;</code>
     * @return string
     */
    public function getMcAppSKey()
    {
        return $this->mc_app_s_key;
    }

    /**
     * Multicast application session key (HEX encoded AES128 key).
     *
     * Generated from protobuf field <code>string mc_app_s_key = 7;</code>
     * @param string $var
     * @return $this
     */
    public function setMcAppSKey($var)
    {
        GPBUtil::checkString($var, True);
        $this->mc_app_s_key = $var;

        return $this;
    }

    /**
     * Frame-counter.
     *
     * Generated from protobuf field <code>uint32 f_cnt = 8;</code>
     * @return int
     */
    public function getFCnt()
    {
        return $this->f_cnt;
    }

    /**
     * Frame-counter.
     *
     * Generated from protobuf field <code>uint32 f_cnt = 8;</code>
     * @param int $var
     * @return $this
     */
    public function setFCnt($var)
    {
        GPBUtil::checkUint32($var);
        $this->f_cnt = $var;

        return $this;
    }

    /**
     * Multicast group type.
     *
     * Generated from protobuf field <code>.api.MulticastGroupType group_type = 9;</code>
     * @return int
     */
    public function getGroupType()
    {
        return $this->group_type;
    }

    /**
     * Multicast group type.
     *
     * Generated from protobuf field <code>.api.MulticastGroupType group_type = 9;</code>
     * @param int $var
     * @return $this
     */
    public function setGroupType($var)
    {
        GPBUtil::checkEnum($var, \Chirpstack\Api\MulticastGroupType::class);
        $this->group_type = $var;

        return $this;
    }

    /**
     * Data-rate.
     *
     * Generated from protobuf field <code>uint32 dr = 10;</code>
     * @return int
     */
    public function getDr()
    {
        return $this->dr;
    }

    /**
     * Data-rate.
     *
     * Generated from protobuf field <code>uint32 dr = 10;</code>
     * @param int $var
     * @return $this
     */
    public function setDr($var)
    {
        GPBUtil::checkUint32($var);
        $this->dr = $var;

        return $this;
    }

    /**
     * Frequency (Hz).
     *
     * Generated from protobuf field <code>uint32 frequency = 11;</code>
     * @return int
     */
    public function getFrequency()
    {
        return $this->frequency;
    }

    /**
     * Frequency (Hz).
     *
     * Generated from protobuf field <code>uint32 frequency = 11;</code>
     * @param int $var
     * @return $this
     */
    public function setFrequency($var)
    {
        GPBUtil::checkUint32($var);
        $this->frequency = $var;

        return $this;
    }

    /**
     * Ping-slot period (only for Class-B).
     * Deprecated: use class_b_ping_slot_nb_k.
     *
     * Generated from protobuf field <code>uint32 class_b_ping_slot_period = 12;</code>
     * @return int
     */
    public function getClassBPingSlotPeriod()
    {
        return $this->class_b_ping_slot_period;
    }

    /**
     * Ping-slot period (only for Class-B).
     * Deprecated: use class_b_ping_slot_nb_k.
     *
     * Generated from protobuf field <code>uint32 class_b_ping_slot_period = 12;</code>
     * @param int $var
     * @return $this
     */
    public function setClassBPingSlotPeriod($var)
    {
        GPBUtil::checkUint32($var);
        $this->class_b_ping_slot_period = $var;

        return $this;
    }

    /**
     * Class-B ping-slots per beacon period (only for Class-B).
     * Valid options are: 0 - 7;
     * The actual number of ping-slots per beacon period equals to 2^k.
     *
     * Generated from protobuf field <code>uint32 class_b_ping_slot_nb_k = 14;</code>
     * @return int
     */
    public function getClassBPingSlotNbK()
    {
        return $this->class_b_ping_slot_nb_k;
    }

    /**
     * Class-B ping-slots per beacon period (only for Class-B).
     * Valid options are: 0 - 7;
     * The actual number of ping-slots per beacon period equals to 2^k.
     *
     * Generated from protobuf field <code>uint32 class_b_ping_slot_nb_k = 14;</code>
     * @param int $var
     * @return $this
     */
    public function setClassBPingSlotNbK($var)
    {
        GPBUtil::checkUint32($var);
        $this->class_b_ping_slot_nb_k = $var;

        return $this;
    }

    /**
     * Scheduling type (only for Class-C).
     *
     * Generated from protobuf field <code>.api.MulticastGroupSchedulingType class_c_scheduling_type = 13;</code>
     * @return int
     */
    public function getClassCSchedulingType()
    {
        return $this->class_c_scheduling_type;
    }

    /**
     * Scheduling type (only for Class-C).
     *
     * Generated from protobuf field <code>.api.MulticastGroupSchedulingType class_c_scheduling_type = 13;</code>
     * @param int $var
     * @return $this
     */
    public function setClassCSchedulingType($var)
    {
        GPBUtil::checkEnum($var, \Chirpstack\Api\MulticastGroupSchedulingType::class);
        $this->class_c_scheduling_type = $var;

        return $this;
    }

}