Changeset 12660

Timestamp:

07/19/12 11:46:26 (13 years ago)

Author:

jschierm

Message:

Python versions of WriteData and pairoptions.

Location:

issm/trunk-jpl/src/m

Files:

• classes/pairoptions.py (modified) (1 diff)
• model/WriteData.m (modified) (2 diffs)
• model/WriteData.py (added)

issm/trunk-jpl/src/m/classes/pairoptions.py

@@ -1 @@
-class pairoptions:
-        #properties
-        def __init__(self,*args):
-                # {{{ Properties
-                if len(args)%2==1:
-                        raise RuntimeError('pairoption error message: an even number of options is required')
-
-                #create a pairoption object
-                if len(args)==0:
-                        self.list=[]
-                else:
-                        self.list=[]
-                        for i in range(int(round(len(args)/2))):
-                                if isinstance(args[2*i],str):
-                                        self.list.append([args[2*i],args[2*i+1]])
+"""
+PAIROPTIONS class definition
+ 
+    Usage:
+       pairoptions=pairoptions();
+       pairoptions=pairoptions('module',true,'solver',false);
+"""
+
+from WriteData import *
+
+class pairoptions(object):
+        def __init__(self,*arg):
+                self.functionname = ''
+                self.list         = {}
+
+#               %get calling function name
+#               a=dbstack;
+#               if length(a)>1,
+#                       self.functionname=a(2).file(1:end-2);
+#               else
+#                       self.functionname='';
+#               end
+
+                #initialize list
+                if not len(arg):
+                        pass    #Do nothing,
+                else:
+                        self.buildlist(*arg)
+        # }}}
+
+        def buildlist(self,*arg):    # {{{
+                """BUILDLIST - build list of objects from input"""
+
+                #check length of input
+                if len(arg) % 2:
+                        raise TypeError('error: an even number of options is required') 
+                numoptions = len(arg)/2
+
+                #go through arg and build list of objects
+                for i in xrange(numoptions):
+                        if isinstance(arg[2*i],str):
+                                self.list[arg[2*i]] = arg[2*i+1];
+                        else:
+                                #option is not a string, ignore it
+                                print "WARNING: option number %d '%s' is not a string and will be ignored." % (i+1,type(arg[2*i]))
+        # }}}
+
+        def addfield(self,field,value):    # {{{
+                """ADDFIELD - add a field to an options list"""
+                if isinstance(field,str):
+                        if field in self.list:
+                                print "WARNING: field '%s' with value=%s exists and will be overwritten with value=%s." % (field,str(self.list[field]),str(value))
+                        self.list[field] = value
+        # }}}
+
+        def addfielddefault(self,field,value):    # {{{
+                """ADDFIELDDEFAULT - add a field to an options list if it does not exist"""
+                if isinstance(field,str):
+                        if not field in self.list:
+                                self.list[field] = value
+        # }}}
+
+        def AssignObjectFields(self,obj2):    # {{{
+                """ASSIGNOBJECTFIELDS - assign object fields from options"""
+                for item in self.list.iteritems():
+                        if item[0] in dir(obj2):
+                                setattr(obj2,item[0],item[1])
+                        else:
+                                print "WARNING: field '%s' is not a property of '%s'." % (item[0],type(obj2))
+                return obj2
+        # }}}
+
+        def changefieldvalue(self,field,newvalue):    # {{{
+                """CHANGEOPTIONVALUE - change the value of an option in an option list"""
+
+                self.list[field]=newvalue;
+        # }}}
+
+#       function obj = deleteduplicates(obj,warn) % {{{
+#       %DELETEDUPLICATES - delete duplicates in an option list
+#
+#               %track the first occurance of each option
+#               [dummy lines]=unique(obj.list(:,1),'first');
+#               clear dummy
+#
+#               %warn user if requested
+#               if warn,
+#                       numoptions=size(obj.list,1);
+#                       for i=1:numoptions,
+#                               if ~ismember(i,lines),
+#                                       disp(['WARNING: option ' obj.list{i,1} ' appeared more than once. Only its first occurence will be kept'])
+#                               end
+#                       end
+#               end
+#
+#               %remove duplicates from the options list
+#               obj.list=obj.list(lines,:);
+#       end % }}}
+
+        def __repr__(self):    # {{{
+                s="   functionname: %s\n" % self.functionname
+                if self.list:
+                        s+="   list: (%ix%i)\n\n" % (len(self.list),2)
+                        for item in self.list.iteritems():
+                                if   isinstance(item[1],str):
+                                        s+="     field: %-10s value: '%s'\n" % (item[0],item[1])
+                                elif isinstance(item[1],(bool,int,long,float)):
+                                        s+="     field: %-10s value: %g\n" % (item[0],item[1])
                                 else:
-                                        #option is not a string, ignore it
-                                        print("%s%i%s"%('buildlist info: option number ',i,' is not a string, it will be ignored'))
-                                        continue
-
-                #}}}
-        def __repr__(obj):
-                # {{{ Display
-                if not obj.list:
-                        string='   list: empty'
-                else:
-                        string="   list: (%i)"%(len(obj.list))
-                        for i in range(len(obj.list)):
-                                if isinstance(obj.list[i][1],str):
-                                        string2="     field: %-10s value: '%s'"%(obj.list[i][0],obj.list[i][1])
-                                elif isinstance(obj.list[i][1],float):
-                                        string2="     field: %-10s value: %g"%(obj.list[i][0],obj.list[i][1])
-                                elif isinstance(obj.list[i][1],int):
-                                        string2="     field: %-10s value: %i"%(obj.list[i][0],obj.list[i][1])
-                                else:
-                                        string2="     field: %-10s value: (%i)"%(len(obj.list[i][1]))
-                                string="%s\n%s"%(string,string2)
-                return string
+                                        s+="     field: %-10s value: %s\n" % (item[0],type(item[1]))
+                else:
+                        s+="   list: empty\n"
+                return s
+        # }}}
+
+        def exist(self,field):    # {{{
+                """EXIST - check if the option exist"""
+
+                #some argument checking: 
+                if field == None or field == '':
+                        raise ValueError('exist error message: bad usage');
+                if not isinstance(field,str):
+                        raise TypeError("exist error message: field '%s' should be a string." % str(field));
+
+                #Recover option
+                if field in self.list:
+                        return True
+                else:
+                        return False
+        # }}}
+
+#       function num = fieldoccurences(obj,field), % {{{
+#       %FIELDOCCURENCES - get number of occurence of a field
+#
+#               %check input 
+#               if ~ischar(field),
+#                       error('fieldoccurences error message: field should be a string');
+#               end
+#
+#               %get number of occurence
+#               num=sum(strcmpi(field,obj.list(:,1)));
+#       end % }}}
+
+        def getfieldvalue(self,field,default=None):    # {{{
+                """
+                GETOPTION - get the value of an option
+        
+                Usage:
+                   value=options.getfieldvalue(field,default)
+         
+                Find an option value from a field. A default option
+                can be given in input if the field does not exist
+         
+                Examples:
+                   value=options.getfieldvalue(options,'caxis')
+                   value=options.getfieldvalue(options,'caxis',[0 2])
+                """
+
+                #some argument checking: 
+                if field == None or field == '':
+                        raise ValueError('getfieldvalue error message: bad usage');
+                if not isinstance(field,str):
+                        raise TypeError("getfieldvalue error message: field '%s' should be a string." % str(field));
+
+                #Recover option
+                if field in self.list:
+                        value=self.list[field]
+                else:
+                        if not default == None:
+                                value=default
+                        else:
+                                raise KeyError("error message: field '%s' has not been provided by user (and no default value has been specified)." % field)
+
+                return value
+        # }}}
+
+        def removefield(self,field,warn):    # {{{
+                """
+                REMOVEFIELD - delete a field in an option list
+         
+                Usage:
+                   obj=removefield(self,field,warn)
+         
+                if warn==1 display an info message to warn user that
+                some of his options have been removed.
+                """
+
+                #check if field exist
+                if field in self.list:
+
+                        #remove duplicates from the options list
+                        del self.list[field]
+
+                        #warn user if requested
+                        if warn:
+                                print "removefield info: option '%s' has been removed from the list of options." % field
+        # }}}
+
+        def marshall(self,fid,firstindex):    # {{{
+
+                for i,item in enumerate(self.list.iteritems()):
+                        name  = item[0]
+                        value = item[1]
+
+                        #Write option name
+                        WriteData(fid,'enum',(firstindex-1)+2*i+1,'data',name,'format','String')
+
+                        #Write option value
+                        if   isinstance(value,str):
+                                WriteData(fid,'enum',(firstindex-1)+2*i+2,'data',value,'format','String')
+                        elif isinstance(value,(bool,int,long,float)):
+                                WriteData(fid,'enum',(firstindex-1)+2*i+2,'data',value,'format','Double')
+                        else:
+                                raise TypeError("Cannot marshall option '%s': format not supported yet." % name)
+        # }}}
+

issm/trunk-jpl/src/m/model/WriteData.m

@@ -35 +35 @@
 %Step 2: write the data itself.
 if     strcmpi(format,'Boolean'),% {{{
-        if(numel(data)~=1), error(['field ' field ' cannot be marshalled as it has more than one element!']); end
+        if(numel(data)~=1), error(['field ' EnumToString(enum) ' cannot be marshalled as it has more than one element!']); end
 
         %first write length of record
@@ -59 +59 @@
         % }}}
 elseif strcmpi(format,'Double'), % {{{
-        if(numel(data)~=1), error(['field ' field ' cannot be marshalled as it has more than one element!']); end
+        if(numel(data)~=1), error(['field ' EnumToString(enum) ' cannot be marshalled as it has more than one element!']); end
 
         %first write length of record