anatomist  5.1.2
3D neuroimaging data viewer
cObjectInfo.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_COBJECTINFO_H
36 #define ANA_COMMANDS_COBJECTINFO_H
37 
38 
39 //--- header files ------------------------------------------------------------
40 
43 #include <vector>
44 #include <set>
45 
46 namespace anatomist
47 {
48 
49  class AWindow;
50  class AObject;
51 
52 
53  //--- class declarations ---------------------------------------------------
54 
58  {
59  public:
60  ObjectInfoCommand( const std::string & filename, CommandContext* context,
61  const std::vector<int> & objectIDs, bool nameChildren,
62  bool nameref = false,
63  const std::string & requestid = "",
64  const std::set<std::string> & objfilenames
65  = std::set<std::string>() );
66  virtual ~ObjectInfoCommand();
67 
68  virtual std::string name() const { return( "ObjectInfo" ); }
69  virtual void write( Tree & com, Serializer* ser ) const;
71 
72  protected:
73  virtual void doit();
74 
75  private:
76  std::string _filename;
77  std::vector<int> _objects;
78  bool _nameChildren;
79  bool _nameref;
80  std::string _requestid;
81  carto::Object _result;
82  std::set<std::string> _objfilenames;
83 
84  friend class StdModule;
85  static Command* read( const Tree & com, CommandContext* context );
86  static bool initSyntax();
87  };
88 
89 }
90 
91 
92 #endif
93 
94 
95 
The abstract base class for commands.
Definition: Command.h:60
Writes information about Anatomist state in a file or pipe.
Definition: cObjectInfo.h:58
virtual std::string name() const
Return the unique name of a class of commands.
Definition: cObjectInfo.h:68
virtual void write(Tree &com, Serializer *ser) const
Print the guts of a command into a Tree given as parent.
ObjectInfoCommand(const std::string &filename, CommandContext *context, const std::vector< int > &objectIDs, bool nameChildren, bool nameref=false, const std::string &requestid="", const std::set< std::string > &objfilenames=std::set< std::string >())
virtual void doit()
Do a command.
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