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 ixnetwork_restpy.base import Base
  from ixnetwork_restpy.files import Files
  
  
  class IgmpHost(Base):
      """IGMP global and per-port settings
      The IgmpHost class encapsulates a required igmpHost resource which will be retrieved from the server every time the property is accessed.
      """
  
      __slots__ = ()
      _SDM_NAME = 'igmpHost'
      _SDM_ATT_MAP = {
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'Enabled': 'enabled',
          'IPDSCP': 'iPDSCP',
          'InterStbStartDelay': 'interStbStartDelay',
          'IntervalInMs': 'intervalInMs',
          'Name': 'name',
          'RatePerInterval': 'ratePerInterval',
          'RowNames': 'rowNames',
          'UnicastMode': 'unicastMode',
      }
  
      def __init__(self, parent):
          super(IgmpHost, self).__init__(parent)
  
      @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 Enabled(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Enabled
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Enabled']))
  
      @property
      def IPDSCP(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Specifies the ToS/DSCP value in the IPv4 Header
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['IPDSCP']))
  
      @property
      def InterStbStartDelay(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Time in milliseconds between Join messages from clients within the same range.
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['InterStbStartDelay']))
  
      @property
      def IntervalInMs(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Time interval used to calculate the rate for triggering an action (rate = count/interval)
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['IntervalInMs']))
  
      @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 RatePerInterval(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): No. of Reports triggered per time interval
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['RatePerInterval']))
  
      @property
      def RowNames(self):
          """
          Returns
          -------
          - list(str): Name of rows
          """
          return self._get_attribute(self._SDM_ATT_MAP['RowNames'])
  
      @property
      def UnicastMode(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Unicast Mode
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['UnicastMode']))
  
      def update(self, Name=None):
          """Updates igmpHost 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, Enabled=None, IPDSCP=None, InterStbStartDelay=None, IntervalInMs=None, RatePerInterval=None, UnicastMode=None):
          """Base class infrastructure that gets a list of igmpHost 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
          - Enabled (str): optional regex of enabled
          - IPDSCP (str): optional regex of iPDSCP
          - InterStbStartDelay (str): optional regex of interStbStartDelay
          - IntervalInMs (str): optional regex of intervalInMs
          - RatePerInterval (str): optional regex of ratePerInterval
          - UnicastMode (str): optional regex of unicastMode
  
          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())
  