% NE overloads the ~= operator for ltpda objects.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% DESCRIPTION: NE overloads the ~= operator for ltpda objects.
%
% CALL:        result = ne(obj1,obj2)
%              result = ne(obj1,obj2,  exc_list)
%              result = ne(obj1,obj2, 'property1', 'property2')
%              result = ne(obj1,obj2, 'class/property', 'class/property')
%              result = ne(obj1,obj2,  plist('Exceptions', 'exception-list'))
%
% PLIST:       key:   'Exceptions'
%              value:  String or cell-array with exceptions.
%
% EXAMPLES:    result = ne(obj1,obj2, 'name', 'created')
%              result = ne(obj1,obj2, 'ao/name')
%
% INPUTS:      obj1,obj2 - input objects
%              exc_list  - exception list
%                          List of properties which are not checked.
%
% OUTPUTS:     If the two objects are considered equal, result == false,
%              otherwise, result == true.
%
% <a href="matlab:utils.helper.displayMethodInfo('ltpda_obj', 'ne')">Parameters Description</a>
%
% VERSION:     $Id: ne.m,v 1.13 2011/04/08 08:56:37 hewitson Exp $
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

function result = ne(obj1, obj2, varargin)

  % Check if this is a call for parameters
  hh = {obj1, obj2, varargin{:}};
  if utils.helper.isinfocall(hh{:})
    result = getInfo(varargin{1});
    return
  end

  if eq(obj1, obj2, varargin{:})
    result = false;
  else
    result = true;
  end
end

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%                               Local Functions                               %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% FUNCTION:    getInfo
%
% DESCRIPTION: Get Info Object
%
% HISTORY:     11-07-07 M Hewitson
%                Creation.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

function ii = getInfo(varargin)
  if nargin == 1 && strcmpi(varargin{1}, 'None')
    sets = {};
    pl   = [];
  else
    sets = {'Default'};
    pl   = getDefaultPlist;
  end
  % Build info object
  ii = minfo(mfilename, 'ltpda_obj', 'ltpda', utils.const.categories.relop, '$Id: ne.m,v 1.13 2011/04/08 08:56:37 hewitson Exp $', sets, pl);
  ii.setModifier(false);
  ii.setArgsmin(2);
end

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% FUNCTION:    getDefaultPlist
%
% DESCRIPTION: Get Default Plist
%
% HISTORY:     11-07-07 M Hewitson
%                Creation.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

function plout = getDefaultPlist()
  persistent pl;  
  if exist('pl', 'var')==0 || isempty(pl)
    pl = buildplist();
  end
  plout = pl;  
end

function pl = buildplist()
  pl = plist.EMPTY_PLIST;
end

