birdnotes.py: Objects to represent bird note files

This method generates the contained BirdForm objects in order by their key in self.__seqMap, which orders them in the same order they were added.

# - - -   D a y N o t e s . g e n F o r m s S e q

    def genFormsSeq ( self ):
        """Generate contained forms in phylogenetic order.
        """

        #-- 1 --
        # [ keyList  :=  keys from self.txMap in ascending order ]
        keyList  =  self.__seqMap.keys()
        keyList.sort()

        #-- 2 --
        # [ generate the values from self.__txMap in order by the
        #   elements of keyList ]
        for  key in keyList:
            yield  self.__seqMap[key]

        #-- 3 --
        raise StopIteration