MLE+ Legacy / mlepEncodeRealData.m

function packet = mlepEncodeRealData(vernumber, flag, timevalue, realvalues)
%MLEPENCODEREALDATA Encode real value data to packet.
%   packet = mlepEncodeRealData(vernumber, flag, timevalue, realvalues)
%
%   Encode real value data to a packet (a string) that can be sent to the
%   external program.  This function is a special version of
%   mlepEncodeData in which integer and boolean data does not exist.
%
%   Inputs:
%       vernumber: version of the protocol to be used. Currently, version 1
%                   and 2 are supported.
%       flag: an integer specifying the (status) flag. Refer to the BCVTB
%                   protocol for allowed flag values.
%       timevalue: a real value which is the current simulation time in
%                   seconds.
%       realvalues: a vector of real value data to be sent. Can be empty.
%
%   Output:
%       packet is a string that contains the encoded data.
%
%   See also:
%       MLEPDECODEPACKET, MLEPENCODEDATA, MLEPENCODESTATUS
%
% (C) 2010 by Truong Nghiem (nghiem@seas.upenn.edu)

ni = nargin;
if ni < 4
    error('Not enough arguments: all input arguments are required.');
end

if vernumber <= 2
    if flag == 0
        packet = [sprintf('%d 0 %d 0 0 %20.15e ', vernumber, length(realvalues), timevalue), ...
                  sprintf('%20.15e ', realvalues)];
    else
        % Error
        packet = sprintf('%d %d', vernumber, flag);
    end
else
    packet = '';
end

end

% Protocol Version 1 & 2:
% Packet has the form:
%       v f dr di db t r1 r2 ... i1 i2 ... b1 b2 ...
% where
%   v    - version number (1,2)
%   f    - flag (0: communicate, 1: finish, -10: initialization error,
%                -20: time integration error, -1: unknown error)
%   dr   - number of real values
%   di   - number of integer values
%   db   - number of boolean values
%   t    - current simulation time in seconds (format %20.15e)
%   r1 r2 ... are real values (format %20.15e)
%   i1 i2 ... are integer values (format %d)
%   b1 b2 ... are boolean values (format %d)
%
% Note that if f is non-zero, other values after it will not be processed.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.