text: # MIT LICENSE
  #
  # Copyright 1997 - 2020 by IXIA Keysight
  #
  # Permission is hereby granted, free of charge, to any person obtaining a copy
  # of this software and associated documentation files (the "Software"),
  # to deal in the Software without restriction, including without limitation
  # the rights to use, copy, modify, merge, publish, distribute, sublicense,
  # and/or sell copies of the Software, and to permit persons to whom the
  # Software is furnished to do so, subject to the following conditions:
  #
  # The above copyright notice and this permission notice shall be included in
  # all copies or substantial portions of the Software.
  #
  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  # THE SOFTWARE. 
  from uhd_restpy.base import Base
  from uhd_restpy.files import Files
  
  
  class OfSwitchQueues(Base):
      """OF Switch Port Queues configuration
      The OfSwitchQueues class encapsulates a required ofSwitchQueues resource which will be retrieved from the server every time the property is accessed.
      """
  
      __slots__ = ()
      _SDM_NAME = 'ofSwitchQueues'
      _SDM_ATT_MAP = {
          'Active': 'active',
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'MaxRate': 'maxRate',
          'MinRate': 'minRate',
          'Name': 'name',
          'ParentPort': 'parentPort',
          'QueueId': 'queueId',
          'QueueProperty': 'queueProperty',
          'SwitchIndex': 'switchIndex',
      }
  
      def __init__(self, parent):
          super(OfSwitchQueues, self).__init__(parent)
  
      @property
      def Active(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Activate/Deactivate Configuration
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Active']))
  
      @property
      def Count(self):
          """
          Returns
          -------
          - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group.
          """
          return self._get_attribute(self._SDM_ATT_MAP['Count'])
  
      @property
      def DescriptiveName(self):
          """
          Returns
          -------
          - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context.
          """
          return self._get_attribute(self._SDM_ATT_MAP['DescriptiveName'])
  
      @property
      def MaxRate(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Specify the maximum data rate guaranteed.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['MaxRate']))
  
      @property
      def MinRate(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Specify the minimum data rate guaranteed.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['MinRate']))
  
      @property
      def Name(self):
          """
          Returns
          -------
          - str: Name of NGPF element, guaranteed to be unique in Scenario
          """
          return self._get_attribute(self._SDM_ATT_MAP['Name'])
      @Name.setter
      def Name(self, value):
          self._set_attribute(self._SDM_ATT_MAP['Name'], value)
  
      @property
      def ParentPort(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Parent port index.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['ParentPort']))
  
      @property
      def QueueId(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Specify the queue identifier for the packets.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['QueueId']))
  
      @property
      def QueueProperty(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Configure the queue property from the options
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['QueueProperty']))
  
      @property
      def SwitchIndex(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Index of the OF Switch.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SwitchIndex']))
  
      def update(self, Name=None):
          """Updates ofSwitchQueues resource on the server.
  
          This method has some named parameters with a type: obj (Multivalue).
          The Multivalue class has documentation that details the possible values for those named parameters.
  
          Args
          ----
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
  
          Raises
          ------
          - ServerError: The server has encountered an uncategorized error condition
          """
          return self._update(self._map_locals(self._SDM_ATT_MAP, locals()))
  
      def get_device_ids(self, PortNames=None, Active=None, MaxRate=None, MinRate=None, ParentPort=None, QueueId=None, QueueProperty=None, SwitchIndex=None):
          """Base class infrastructure that gets a list of ofSwitchQueues device ids encapsulated by this object.
  
          Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object.
  
          Args
          ----
          - PortNames (str): optional regex of port names
          - Active (str): optional regex of active
          - MaxRate (str): optional regex of maxRate
          - MinRate (str): optional regex of minRate
          - ParentPort (str): optional regex of parentPort
          - QueueId (str): optional regex of queueId
          - QueueProperty (str): optional regex of queueProperty
          - SwitchIndex (str): optional regex of switchIndex
  
          Returns
          -------
          - list(int): A list of device ids that meets the regex criteria provided in the method parameters
  
          Raises
          ------
          - ServerError: The server has encountered an uncategorized error condition
          """
          return self._get_ngpf_device_ids(locals())
  