anatomist  5.1.2
3D neuroimaging data viewer
cGetInfo.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 
35 #ifndef ANA_COMMANDS_CGETINFO_H
36 #define ANA_COMMANDS_CGETINFO_H
37 
38 
39 //--- header files ------------------------------------------------------------
40 
44 
45 namespace anatomist
46 {
47 
48  class AWindow;
49  class AObject;
50  class Referential;
51 
52 
53  //--- class declarations ---------------------------------------------------
54 
58  {
59  public:
60  GetInfoCommand( const std::string & filename, CommandContext* context
62  bool objects = false, bool windows = false,
63  bool refs = false, bool trans = false,
64  bool palettes = false, const std::string & nameobj = "",
65  bool namewin = false, bool selects = false,
66  bool link = false, Referential* linkref = 0,
67  bool nameref = false, bool nametrans = false,
68  const std::string & requestid = "", bool version = false,
69  bool listcommands = false, bool aimsinfo = false,
70  bool modinfo = false
71  );
72  virtual ~GetInfoCommand();
73 
74  virtual std::string name() const { return( "GetInfo" ); }
75  virtual void write( Tree & com, Serializer* ser ) const;
77 
78  protected:
79  virtual void doit();
80 
81  private:
82  std::string _filename;
83  bool _objects;
84  bool _windows;
85  bool _refs;
86  bool _trans;
87  bool _palettes;
88  std::string _nameobj;
89  bool _namewin;
90  bool _nameref;
91  bool _nametrans;
92  bool _selects;
93  bool _link;
94  Referential *_linkref;
95  std::string _requestid;
96  carto::Object _result;
97  bool _version;
98  bool _listcommands;
99  bool _aimsinfo;
100  bool _modinfo;
101 
102  friend class StdModule;
103  static Command* read( const Tree & com, CommandContext* context );
104  static bool initSyntax();
105  };
106 
107 }
108 
109 
110 #endif
111 
112 
The abstract base class for commands.
Definition: Command.h:60
Writes information about Anatomist state in a file or pipe.
Definition: cGetInfo.h:58
carto::Object result()
virtual void write(Tree &com, Serializer *ser) const
Print the guts of a command into a Tree given as parent.
GetInfoCommand(const std::string &filename, CommandContext *context=&CommandContext::defaultContext(), bool objects=false, bool windows=false, bool refs=false, bool trans=false, bool palettes=false, const std::string &nameobj="", bool namewin=false, bool selects=false, bool link=false, Referential *linkref=0, bool nameref=false, bool nametrans=false, const std::string &requestid="", bool version=false, bool listcommands=false, bool aimsinfo=false, bool modinfo=false)
virtual std::string name() const
Return the unique name of a class of commands.
Definition: cGetInfo.h:74
virtual void doit()
Do a command.
Referential: marker for transformations, with an associated color.
Definition: Referential.h:55
The abstract base class for usual commands.
Definition: Command.h:104
Serializer is a helper class for pointer serialization.
Definition: Serializer.h:55
The abstract base class used for commands that have to read/write pointers.
Definition: Command.h:128
CommandContext * context()
Definition: Command.h:131
Context for commands processor readers (APipeReader etc)
Definition: context.h:48
static CommandContext & defaultContext()