channelfinder::util::ChannelUtil::ChannelUtil Class Reference

List of all members.

Public Member Functions
def	__init__
def	getAllTags
def	getAllProperties
def	getAllPropValues
def	validateChannelsWithTag
def	validateChannelWithProperty
def	channelsValidityCheck

---

Detailed Description

Utiltity class

---

Member Function Documentation

def channelfinder::util::ChannelUtil::ChannelUtil::__init__

(

self

)

Constructor

def channelfinder::util::ChannelUtil::ChannelUtil::channelsValidityCheck	(		cls,
			channels,
			validator
	)

A generic method to validate a set of channels based on a given validator.
The validator needs to provide the logic on how to validate a channel in a validate method.

def channelfinder::util::ChannelUtil::ChannelUtil::getAllProperties	(		cls,
			channels
	)

getAllProperties([Channel]) -> [String]
returns a list of the propertyNames of all the properties on the set of channels

def channelfinder::util::ChannelUtil::ChannelUtil::getAllPropValues	(		cls,
			channels,
			propertyName,
			key = None
	)

given the list of channels return a list of all values

def channelfinder::util::ChannelUtil::ChannelUtil::getAllTags	(		cls,
			channels
	)

getAllTags([Channel]) -> [String]
returns a list of the tagNames of all the tags present on this set of channels

def channelfinder::util::ChannelUtil::ChannelUtil::validateChannelsWithTag	(		cls,
			channels,
			tag
	)

Utility method to validate a group of channel to ensure they all have the tag 'tag'
e.g.
ChannelUtil.validateChannelsWithTag(client.find(name=*), Tag('goldenOrbit','tagOwner'))
this will return True is all channels with any name have the tag 'goldenOrbit'
and false if anyone channel does not have that tag

def channelfinder::util::ChannelUtil::ChannelUtil::validateChannelWithProperty	(		cls,
			channels,
			prop
	)

Utility method to validate a group of channels to ensure they all have the property 'prop'
e.g.
ChannelUtil.validateChannelWithProperty(client.find(ElemName='The Magnet'), Property('length','propOwner','0.3'))

This will return True if all channels with property ElemName with value 'The Magnet' also have the 
property length with value 0.3

---

The documentation for this class was generated from the following file:

• channelfinder/util/ChannelUtil.py