Home > marsbar > @marmoire > clear_item_data.m

clear_item_data

PURPOSE

sets data for item to empty

SYNOPSIS

function [o, errf] = clear_item_data(o, item)

DESCRIPTION

 sets data for item to empty
 FORMAT [o errf] = clear_item_data(o, item);

 o        - object
 item     - name of item to clear data for
 
 Returns
 o        - object with data cleared for this item
 errf     - flag is 1 if data was not cleared for some reason

 $Id$

CROSS-REFERENCE INFORMATION

This function calls:

do_set private function to set data into item

This function is called by:

mars_arm wrapper function for MarsBaR marmoire object
mars_arm_call services callbacks from marmoire object set functions

SOURCE CODE

0001 function [o, errf] = clear_item_data(o, item)
0002 % sets data for item to empty
0003 % FORMAT [o errf] = clear_item_data(o, item);
0004 %
0005 % o        - object
0006 % item     - name of item to clear data for
0007 %
0008 % Returns
0009 % o        - object with data cleared for this item
0010 % errf     - flag is 1 if data was not cleared for some reason
0011 %
0012 % $Id$
0013 
0014 if nargin < 2
0015   error('Need item to clear data');
0016 end
0017 
0018 [o errf] = do_set(o, item, 'clear', [], '');