Skip to content

Commit

Permalink
Update help strings; tweaked some types to not display class constant…
Browse files Browse the repository at this point in the history
…s when printed.
  • Loading branch information
Kristoffer Langeland Knudsen committed Jun 23, 2020
1 parent 62722ab commit 6926aa2
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 17 deletions.
25 changes: 12 additions & 13 deletions +gadgetron/+external/Connection.m
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
classdef Connection < handle
% CONNECTION Represents a connection to an ISMRMRD client.
%
% CONNECTION objects are created by the Gadgetron Foreign Interface,
% representing communication with the ISMRMRD client.
% CONNECTION objects are created by the Gadgetron External Language
% Interface, representing communication with the ISMRMRD client.
%
% CONNECTION Properties:
%
Expand All @@ -26,8 +26,8 @@
% through the 'next' and 'send' methods. Configuration and ISMRMRD
% Header metadata is exposed thorugh properties.
%
% Each connection maintains a set of readers (each consuming an
% ISMRMRD binary data, producung a workable item), and a set of writers
% Each connection maintains a set of readers (each consuming ISMRMRD
% binary data, producung a workable item), and a set of writers
% (each consuming items, producing ISMRMRD binary data).
%
% Applying a filter causes next to only return suitable items. Should
Expand Down Expand Up @@ -71,13 +71,13 @@ function delete(self)
% Calling NEXT will produce the next item available on a
% connection. When next is called, and ISMRMRD Message ID
% (MID) is read from the connection. This MID is used to
% select an appropriate reader, which in turn reads the next
% select an appropriate reader, which in turn reads the
% item from the connection. The item is returned to the
% caller. Calling next when no more items are available
% throws a Connection:noNextItem exception.
%
% item = connection.NEXT() produces the available next item.
% If no item is ready, next will block until an item is
% item = connection.NEXT() produces the next available item.
% If no item is ready, next will block until an item becomes
% available.
%
% [item, MID] = connection.NEXT() provides the next item,
Expand All @@ -99,9 +99,9 @@ function delete(self)
function send(self, item)
% SEND Send an item to the client.
%
% connection.SEND(item) will cause the connection to examine
% select an appropriate writer, and send the serialized item
% back to the client.
% connection.SEND(item) causes the connection to examine the
% item, select an appropriate writer, and use the writer to
% serialize the item back to the client.

for writer = self.writers.asarray
if writer.accepts(item), writer.write(self.socket, item); return, end
Expand All @@ -113,7 +113,7 @@ function send(self, item)

function filter(self, f)
% FILTER Set the connection filter.
% Setting a filter limits which items can be returned
% Setting a filter limits which items can be returned from
% subsequent calls to next.
%
% connection.FILTER(@predicate) ensures that next will only
Expand Down Expand Up @@ -146,8 +146,7 @@ function add_reader(self, slot, reader)
% connection.ADD_READER(slot, @reader_function) registers a
% reader function with the connection. Whenever an ISMRMRD
% message with MID==slot is received, reader_function will be
% invoked to deserialize the ISMRMRD binary data, and return
% a useful item.
% invoked to read and deserialize the ISMRMRD binary data.

self.readers(uint32(slot)) = reader;
end
Expand Down
2 changes: 1 addition & 1 deletion +gadgetron/+types/Acquisition.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
classdef Acquisition

properties (Access = public, Constant)
properties (Access = public, Hidden, Constant)
% Acquisition flags
ACQ_FIRST_IN_ENCODE_STEP1 = bitshift(uint64(1), 0)
ACQ_LAST_IN_ENCODE_STEP1 = bitshift(uint64(1), 1)
Expand Down
2 changes: 1 addition & 1 deletion +gadgetron/+types/Image.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
classdef Image

properties (Access = public, Constant)
properties (Access = public, Hidden, Constant)
% Image constants
USHORT = uint16(1);
SHORT = uint16(2);
Expand Down
4 changes: 2 additions & 2 deletions gadgetron.prj
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<param.description>This Gadgetron interface is based on ISMRMRD Datatypes, fascilitating direct communication with Gadgetron, or other ISMRMRD-based applications.
NOTE: Requires Gadgetron 4.1 or newer.</param.description>
<param.screenshot>${PROJECT_ROOT}/gadgetron-logo.png</param.screenshot>
<param.version>2.0.12</param.version>
<param.version>2.0.13</param.version>
<param.output>${PROJECT_ROOT}/gadgetron.mltbx</param.output>
<param.products.name />
<param.products.id />
Expand Down Expand Up @@ -127,7 +127,7 @@ NOTE: Requires Gadgetron 4.1 or newer.</param.description>
<vista>false</vista>
<linux>true</linux>
<solaris>false</solaris>
<osver>5.6.15-300.fc32.x86_64</osver>
<osver>5.6.18-300.fc32.x86_64</osver>
<os32>false</os32>
<os64>true</os64>
<arch>glnxa64</arch>
Expand Down

0 comments on commit 6926aa2

Please sign in to comment.