find.py

Go to the documentation of this file.

#
# This file was generated using xslt from its XML file
#
# Copyright 2009, Associated Universities Inc., Washington DC
#
import sys
import os
from  casac import *
import string
from taskinit import casalog
#from taskmanager import tm
import task_find
def find(matchstring=''):

        """Find string in tasks, task names, parameter names:

       Find string in tasks, task names, parameter names:

        Lists the following:
                1) All of the task names that have the string
                2) All of the tasks whose  contents (e.g., documentation,
                parameters, etc) have the string
                3) All of the parameter names that have the string

       Keyword arguments:
       matchstring -- String to match in the documentation
               default: ''; example: matchstring='vis'
 
        """

#
#    The following is work around to avoid a bug with current python translation
#
        mytmp = {}

        mytmp['matchstring'] = matchstring
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'find.xml')

        casalog.origin('find')
        if trec.has_key('find') and casac.utils().verify(mytmp, trec['find']) :
            result = task_find.find(matchstring)

        else :
          result = False
        return result