Ignore:
Timestamp:
25/01/08 14:05:32 (13 years ago)
Author:
domlowe
Message:

Documenting CSML code - not complete

File:
1 edited

Legend:

Unmodified
Added
Removed
  • TI02-CSML/trunk/csml/API/ops_AbstractFeature.py

    r2979 r3267  
    1 ''' ops_AbstractFeature  contains operations for AbstractFeatures''' 
     1''' ops_AbstractFeature  contains operations for AbstractFeatures 
     2These methods are attached to AbstractFeature instances at runtime. 
     3Therefore they are inherited by all feature instances (unless they are overwritten''' 
    24import string 
    35import cdtime 
     
    79 
    810def testmethod(self): 
     11    '''test method''' 
    912    print 'testmethod for abstract feature' 
    1013    return 'testmethod abstract feature' 
    1114 
    1215def getAllowedSubsettings(self): 
     16    '''get the allowed operations 
     17    @return:    list of operations''' 
    1318    return ['none'] 
    1419 
    1520def getDomainUnits(self): 
     21    '''  get the units used in the domain''' 
    1622    return None 
    1723     
    1824def getLongitudeAxis(self): 
     25    ''' get the index of the longitude axis, if one exists''' 
    1926    return None 
    2027 
    2128def getLatitudeAxis(self): 
     29    ''' get the index of the latitude axis, if one exists''' 
    2230    return None 
    2331 
    2432def getTimeAxis(self): 
     33    ''' get the index of the time axis, if one exists''' 
    2534    return None 
    2635 
    2736def getAxisLabels(self): 
     37    ''' get the names of all the axes''' 
    2838    return None 
    2939 
    3040def getBoundingBox(self): 
     41    ''' get the simple boundingBox ''' 
    3142    return None 
    3243 
    3344def getCSMLBoundingBox(self): 
    34     #returns a complete boundingBox object including temporal domain and crs 
     45    ''' returns a complete boundingBox object including temporal domain and crs''' 
    3546    if hasattr(self, 'boundedBy'): 
    3647        return csml.API.csmlbbox.CSMLBoundingBox(self.boundedBy) 
     
    3950     
    4051def getNativeCRS(self): 
    41     #returns the crs of the feature 
     52    ''' returns the crs of the feature ''' 
    4253    return None 
    4354 
    4455def getSliceIndices(self, selection): 
    45     ''' Calculates indices to use in slicing (eg for RawFileExtracts) and adds them to the selection dictionary 
    46     #Doesn't work fully due to lack of proper CRS cataloguing so returns empty lists if error is encountered 
     56    ''' Calculates indices to use in slicing (eg for RawFileExtracts) and adds them to the selection dictionary. Doesn't work fully due to lack of proper CRS cataloguing so returns empty lists if error is encountered 
    4757    ''' 
    4858    selLower=[] 
Note: See TracChangeset for help on using the changeset viewer.