# 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 AvailableTrackingFilter(Base):
    """List of tracking available for filtering.
    The AvailableTrackingFilter class encapsulates a list of availableTrackingFilter resources that are managed by the system.
    A list of resources can be retrieved from the server using the AvailableTrackingFilter.find() method.
    """

    __slots__ = ()
    _SDM_NAME = 'availableTrackingFilter'
    _SDM_ATT_MAP = {
        'Constraints': 'constraints',
        'Name': 'name',
        'TrackingType': 'trackingType',
        'ValueType': 'valueType',
    }

    def __init__(self, parent):
        super(AvailableTrackingFilter, self).__init__(parent)

    @property
    def Constraints(self):
        """
        Returns
        -------
        - list(str): Lists down the constraints associated with the available tracking filter list.
        """
        return self._get_attribute(self._SDM_ATT_MAP['Constraints'])

    @property
    def Name(self):
        """
        Returns
        -------
        - str: Displays the name of the tracking filter.
        """
        return self._get_attribute(self._SDM_ATT_MAP['Name'])

    @property
    def TrackingType(self):
        """
        Returns
        -------
        - str: Indicates the tracking type.
        """
        return self._get_attribute(self._SDM_ATT_MAP['TrackingType'])

    @property
    def ValueType(self):
        """
        Returns
        -------
        - str: Value of tracking to be matched based on operator.
        """
        return self._get_attribute(self._SDM_ATT_MAP['ValueType'])

    def find(self, Constraints=None, Name=None, TrackingType=None, ValueType=None):
        """Finds and retrieves availableTrackingFilter resources from the server.

        All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve availableTrackingFilter resources from the server.
        To retrieve an exact match ensure the parameter value starts with ^ and ends with $
        By default the find method takes no parameters and will retrieve all availableTrackingFilter resources from the server.

        Args
        ----
        - Constraints (list(str)): Lists down the constraints associated with the available tracking filter list.
        - Name (str): Displays the name of the tracking filter.
        - TrackingType (str): Indicates the tracking type.
        - ValueType (str): Value of tracking to be matched based on operator.

        Returns
        -------
        - self: This instance with matching availableTrackingFilter resources retrieved from the server available through an iterator or index

        Raises
        ------
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._select(self._map_locals(self._SDM_ATT_MAP, locals()))

    def read(self, href):
        """Retrieves a single instance of availableTrackingFilter data from the server.

        Args
        ----
        - href (str): An href to the instance to be retrieved

        Returns
        -------
        - self: This instance with the availableTrackingFilter resources from the server available through an iterator or index

        Raises
        ------
        - NotFoundError: The requested resource does not exist on the server
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._read(href)
