source: issm/trunk/src/m/classes/massconaxpby.m@ 20500

%MASSCONAXPBY class definition
%
%   Usage:
%      massconaxpby=massconaxpby();
%      massconsumaxpby=massconaxpby('name','MassCon58+35','namex','MassCon58','alpha',.5,'namey','MassCon35','beta',.5); 
% 
%   where name is the name of the massconaxpby object, namex is the name of the first masscon, namey the name of the second masscon and alpha,beta the 
%         multiplicators. The meaning of axpby here is: resulting masscon is the linear combination (alpha *x + beta * y) 
%         of two masscons.
%
%   See also: MASSCON

classdef massconaxpby
        properties (SetAccess=public)
                %masscon axpby
                name              = '';
                definitionenum   = NaN; %enum that identifies this output definition uniquely, from Outputdefinition[1-10]Enum
                namex              = '';
                namey              = '';
                alpha              = NaN;
                beta              = NaN;
        end
        
        methods
                function self = massconaxpby(varargin) % {{{
                        if nargin==0,
                                self=setdefaultparameters(self);
                        else
                                %use provided options to change fields
                                options=pairoptions(varargin{:});

                                %get names
                                self.name=getfieldvalue(options,'name','');
                                self.definitionenum=getfieldvalue(options,'definitionenum');
                                self.namex=getfieldvalue(options,'namex');
                                self.namey=getfieldvalue(options,'namey');

                                %get multiplicators: 
                                self.alpha=getfieldvalue(options,'alpha');
                                self.beta=getfieldvalue(options,'beta');


                        end
                end % }}}
                function self = setdefaultparameters(self) % {{{
                end % }}}
                function md = checkconsistency(self,md,solution,analyses) % {{{

                        if ~ischar(self.name), error('masscon error message: ''name'' field should be a string!'); end
                        if ~ischar(self.namex), error('masscon error message: ''namex'' field should be a string!'); end
                        if ~ischar(self.namey), error('masscon error message: ''namey'' field should be a string!'); end
                        
                        md = checkfield(md,'fieldname','self.definitionenum','field',self.definitionenum,'values',[Outputdefinition1Enum:Outputdefinition100Enum]);

                        md = checkfield(md,'fieldname','self.alpha','field',self.alpha,'NaN',1,'Inf',1,'size',[1 1]);
                        md = checkfield(md,'fieldname','self.betaa','field',self.beta,'NaN',1,'Inf',1,'size',[1 1]);

                end % }}}
                function md = disp(self) % {{{
                
                        disp(sprintf('   Misfit:\n'));

                        fielddisplay(self,'name','name');
                        fielddisplay(self,'definitionenum','enum that identifies this output definition uniquely, from Outputdefinition[1-10]Enum');
                        fielddisplay(self,'namex','identifier for the first masscon');
                        fielddisplay(self,'alpha','first masscon multiplicator');
                        fielddisplay(self,'namey','identifier for the second masscon');
                        fielddisplay(self,'beta','second masscon multiplicator');

                end % }}}
                function md = marshall(self,md,fid) % {{{

                WriteData(fid,'object',self,'fieldname','name','format','String');
                WriteData(fid,'object',self,'fieldname','definitionenum','format','Integer');
                WriteData(fid,'object',self,'fieldname','namex','format','String');
                WriteData(fid,'object',self,'fieldname','namey','format','String');
                WriteData(fid,'object',self,'fieldname','alpha','format','Double');
                WriteData(fid,'object',self,'fieldname','beta','format','Double');

                end % }}}
        end
end