buffer.m

Buffer is an object oriented buffer implementation.

classdef  buffer < handle
    % buffer is the class definition for buffer classes. Buffer is used by
  
    % ==================================================
    % DATA MEMBERS
    % ==================================================
     properties (SetAccess='public')
         buff
         wPtr
         bufferSize
     end
     
    % ==================================================
    % PRIVATE METHODS
    % ==================================================
    methods (Access='private')
    
    end    
    % ==================================================
    % PUBLIC METHODS
    % ==================================================
    methods
        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
        %%% Constructor  %%%%%%%%%%%%%%%%%%%
        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
        function  b = buffer(bufferSize)
            
            b.buff = zeros(1,bufferSize);
            b.wPtr = 1;
            b.bufferSize = bufferSize;
            
        end
        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
        %%% write      %%%%%%%%%%%%%%%%%%%
        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
        function write(b,inData)
            if (b.wPtr-1 + length(inData) > b.bufferSize)
                error('Buffer size is exceeded!');
            else
                b.buff(b.wPtr:b.wPtr + length(inData)-1) = inData;
                b.wPtr = b.wPtr + length(inData);
            end
        end
        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
        %%% read      %%%%%%%%%%%%%%%%%%%
        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
        function dataOut= read(b, nRqst)
            dataOut = b.buff(1:nRqst);
            b.buff(1:b.bufferSize-nRqst) =  b.buff(nRqst+1:end);
            b.wPtr = b.wPtr - nRqst;
            
        end
        function nb = numOfElements(b)
            nb = (b.wPtr-1);
        end
    end    
end