Changes between Version 4 and Version 5 of csmlapi


Ignore:
Timestamp:
23/08/06 12:50:31 (13 years ago)
Author:
domlowe
Comment:

[DS] Further edits to CSML API

Legend:

Unmodified
Added
Removed
Modified
  • csmlapi

    v4 v5  
    3030 
    3131 == AbstractFeature() == 
    32 ''getAllowedSubsettings(self)'' 
     32#this is the base class for all features 
     33 === ''methods:'' === 
     34''getAllowedSubsettings(self):'' 
    3335#returns a list of subsetting operations avalable: ['none'] for AbstractFeature 
    3436 
    3537 == AbstractFileExtract() == 
     38#this is the base class for all file extract classes 
     39 
     40 === ''methods:'' === 
    3641''getData(self,  fileposition=None, times=None, **kwargs):'' 
    3742#Given a file extract, get the data for that extract.  
     
    3944Note fileposition is for when a file extract describes multiple files. Kwargs contains a dimensional subsetting request e.g. (X=blah, Y=blah, Z=blah) 
    4045 
     46 == GridSeriesFeature(!AbstractFeature) ==  
     47 === ''methods:'' === 
     48''getAllowedSubsettings(self):'' 
     49#returns a list of subsetting operations avalable: ['subsetToGridSeries','subsetTo...'?]   
     50 
     51''getDomainReference(self):'' 
     52#Returns a dictionary containing times that make up the domain reference. Of the form: ['t':times] 
     53 
     54''getDomainComplement(self):'' 
     55#Returns a dictionary containing axis values. Of the form [AxisName:Values] 
     56 
     57''getDomain(self):'' 
     58#Returns a dictionary containing both the domain refernce and the domain complement. 
     59 
     60''subsetToGridSeries(self,, timeSubset,  csmlpath=None, ncpath=None,**kwargs):'' 
     61#kwargs contains subset requets 
     62#Returns a path to a subsetted CSML file, a subsetted NetCDF file and also the size of the data returned. 
    4163 
    4264 
    43  
    44  
     65To be continued...