Home > classes > @param > eq.m

eq

PURPOSE ^

EQ overloads the == operator for param objects.

SYNOPSIS ^

function result = eq(c1,c2, varargin)

DESCRIPTION ^

 EQ overloads the == operator for param objects.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: EQ overloads the == operator for param objects.

              All fields are checked.

 CALL:        result = eq(c1,c2)
              result = eq(c1,c2,  exc_list)
              result = eq(c1,c2, 'property1', 'property2')
              result = eq(c1,c2, 'class/property', 'class/property')
              result = eq(c1,c2,  plist('Exceptions', 'exception-list'))

 PLIST:       key:   'Exceptions'
              value:  String or cell-array with exceptions.

 EXAMPLES:    result = eq(c1,c2, 'name', 'created')
              result = eq(c1,c2, 'ao/name')
              result = eq(c1,c2,  plist('Exceptions', 'name'))
              result = eq(c1,c2,  plist('Exceptions', {'name', 'created'}))

 INPUTS:      c1,c2    - input param objects
              exc_list - exception list
                         List of properties which are not checked.

 OUTPUTS:     If the two param objects are considered equal, result == 1,
              otherwise, result == 0.

 VERSION:     $Id: eq.m,v 1.7 2008/02/18 14:41:13 ingo Exp $

 HISTORY:     29-08-2007 M Hewitson
                 Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function result = eq(c1,c2, varargin)
0002 % EQ overloads the == operator for param objects.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: EQ overloads the == operator for param objects.
0007 %
0008 %              All fields are checked.
0009 %
0010 % CALL:        result = eq(c1,c2)
0011 %              result = eq(c1,c2,  exc_list)
0012 %              result = eq(c1,c2, 'property1', 'property2')
0013 %              result = eq(c1,c2, 'class/property', 'class/property')
0014 %              result = eq(c1,c2,  plist('Exceptions', 'exception-list'))
0015 %
0016 % PLIST:       key:   'Exceptions'
0017 %              value:  String or cell-array with exceptions.
0018 %
0019 % EXAMPLES:    result = eq(c1,c2, 'name', 'created')
0020 %              result = eq(c1,c2, 'ao/name')
0021 %              result = eq(c1,c2,  plist('Exceptions', 'name'))
0022 %              result = eq(c1,c2,  plist('Exceptions', {'name', 'created'}))
0023 %
0024 % INPUTS:      c1,c2    - input param objects
0025 %              exc_list - exception list
0026 %                         List of properties which are not checked.
0027 %
0028 % OUTPUTS:     If the two param objects are considered equal, result == 1,
0029 %              otherwise, result == 0.
0030 %
0031 % VERSION:     $Id: eq.m,v 1.7 2008/02/18 14:41:13 ingo Exp $
0032 %
0033 % HISTORY:     29-08-2007 M Hewitson
0034 %                 Creation
0035 %
0036 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0037 
0038 VERSION       = '$Id: eq.m,v 1.7 2008/02/18 14:41:13 ingo Exp $';
0039 CATEGORY      = 'Relational Operator';
0040 DEFAULT_PLIST = plist();
0041 
0042 result = generic_eq(c1, c2, varargin, DEFAULT_PLIST, VERSION, CATEGORY);
0043

Generated on Mon 31-Mar-2008 13:54:54 by m2html © 2003