ODIN
Public Member Functions | Public Attributes | Friends | List of all members
Protocol Class Reference

Protocol proxy. More...

#include <protocol.h>

Inheritance diagram for Protocol:
Inheritance graph
[legend]

Public Member Functions

 Protocol (const STD_string &label="unnamedProtocol")
 
 Protocol (const Protocol &p)
 
Protocoloperator= (const Protocol &p)
 
bool operator< (const Protocol &rhs) const
 
bool operator== (const Protocol &rhs) const
 
- Public Member Functions inherited from LDRblock
 LDRblock (const STD_string &title="Parameter List")
 
 LDRblock (const LDRblock &block)
 
 ~LDRblock ()
 
LDRblockoperator= (const LDRblock &block)
 
LDRblockmerge (LDRblock &block, bool onlyUserPars=true)
 
LDRblockunmerge (LDRblock &block)
 
STD_string printval (const STD_string &parameterName, bool append_unit=false) const
 
bool parseval (const STD_string &parameterName, const STD_string &value)
 
int parseblock (const STD_string &source, const LDRserBase &serializer=LDRserJDX())
 
unsigned int numof_pars () const
 
LDRbaseget_parameter (const STD_string &ldrlabel)
 
bool parameter_exists (const STD_string &ldrlabel) const
 
LDRblockset_prefix (const STD_string &prefix)
 
LDRblockset_embedded (bool embedded)
 
bool is_embedded () const
 
LDRbaseoperator[] (unsigned int i)
 
const LDRbaseoperator[] (unsigned int i) const
 
LDRbaseget_parameter_by_id (int id)
 
LDRblockcreate_copy (const LDRblock &src)
 
LDRblockappend_copy (const LDRbase &src)
 
LDRblockcopy_ldr_vals (const LDRblock &src)
 
bool operator== (const LDRblock &rhs) const
 
bool operator< (const LDRblock &rhs) const
 
bool compare (const LDRblock &rhs, const STD_list< STD_string > *exclude=0, double accuracy=0.0) const
 
STD_string print (const LDRserBase &serializer=LDRserJDX()) const
 
LDRbaseset_parmode (parameterMode parameter_mode)
 
LDRbaseset_filemode (fileMode file_mode)
 
STD_string get_parx_code (parxCodeType type) const
 
STD_ostream & print2stream (STD_ostream &os, const LDRserBase &serializer) const
 
bool parsevalstring (const STD_string &, const LDRserBase *ser=0)
 
bool parse (STD_string &parstring, const LDRserBase &serializer)
 
STD_string printvalstring (const LDRserBase *ser=0) const
 
LDRbasecreate_copy () const
 
STD_string get_typeInfo (bool parx_equivtype=false) const
 
int load (const STD_string &filename, const LDRserBase &serializer=LDRserJDX())
 
int write (const STD_string &filename, const LDRserBase &serializer=LDRserJDX()) const
 
- Public Member Functions inherited from LDRbase
virtual double get_minval () const
 
virtual double get_maxval () const
 
bool has_minmax () const
 
const STD_string & get_description () const
 
LDRbaseset_description (const STD_string &descr)
 
virtual svector get_alternatives () const
 
const STD_string & get_unit () const
 
LDRbaseset_unit (const STD_string &un)
 
virtual parameterMode get_parmode () const
 
virtual fileMode get_filemode () const
 
virtual GuiProps get_gui_props () const
 
virtual LDRbaseset_gui_props (const GuiProps &)
 
JcampDxProps get_jdx_props () const
 
LDRbaseset_jdx_props (const JcampDxProps &jp)
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 
- Public Member Functions inherited from List< I, P, R >
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (R item)
 
Listremove (R item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () const
 

Public Attributes

System system
 
Geometry geometry
 
SeqPars seqpars
 
LDRblock methpars
 
Study study
 

Friends

class SeqMethod
 

Additional Inherited Members

- Public Types inherited from List< I, P, R >
typedef STD_list< P >::iterator iter
 
typedef STD_list< P >::const_iterator constiter
 
- Protected Member Functions inherited from LDRblock
LDRblockappend_member (LDRbase &ldr, const STD_string ldrlabel="")
 

Detailed Description

Protocol proxy.

Class to hold the whole MR Protocol, that is system, geometry and seqpars

Definition at line 33 of file protocol.h.

Constructor & Destructor Documentation

◆ Protocol() [1/2]

Protocol::Protocol ( const STD_string &  label = "unnamedProtocol")

Create a default protocol with the given label for the sequence with label 'seqid'

◆ Protocol() [2/2]

Protocol::Protocol ( const Protocol p)
inline

Copy constructor

Definition at line 46 of file protocol.h.

Member Function Documentation

◆ operator<()

bool Protocol::operator< ( const Protocol rhs) const

Special comparison operator for Protocol which does not consider 'AcquisitionStart' and 'offsetSlice' so that tempo-spatial data has the 'same' protocol. This behaviour is required in FileIO::autoread.

◆ operator=()

Protocol& Protocol::operator= ( const Protocol p)

Assignment operator

◆ operator==()

bool Protocol::operator== ( const Protocol rhs) const
inline

Special comparison operator for Protocol which does not consider 'AcquisitionStart' and 'offsetSlice' so that tempo-spatial data has the 'same' protocol. This behaviour is required in FileIO::autoread.

Definition at line 67 of file protocol.h.

Member Data Documentation

◆ geometry

Geometry Protocol::geometry

geometry

Definition at line 83 of file protocol.h.

◆ methpars

LDRblock Protocol::methpars

method-specific parameters

Definition at line 93 of file protocol.h.

◆ seqpars

SeqPars Protocol::seqpars

sequence parameters

Definition at line 88 of file protocol.h.

◆ study

Study Protocol::study

study information

Definition at line 98 of file protocol.h.

◆ system

System Protocol::system

system configuration

Definition at line 78 of file protocol.h.


The documentation for this class was generated from the following file: