COVISE Core
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
coStepFile.h
Go to the documentation of this file.
1 /* This file is part of COVISE.
2 
3  You can use it under the terms of the GNU Lesser General Public License
4  version 2.1 or later, see lgpl-2.1.txt.
5 
6  * License: LGPL 2+ */
7 
8 #ifndef _STEP_FILE_H_
9 #define _STEP_FILE_H_
10 
11 #include <covise/covise.h>
12 #include <util/coTypes.h>
13 
14 #define MAX_DELTA 500
15 
16 namespace covise
17 {
18 
20 {
21 
22 private:
23  // skip: number of files to skip
24  // Example: skip = 1 -> image1.png, image3.png, image5.png ...
25  int skip;
26  int delta; // maximal number of files to process
27  int len_nb; // length of the start path
28  int finished; // detects if we are finished
29  int base_number; // starting index
30  int file_index; // current index (is incremented)
31  char *prefix;
32  char *suffix;
33  char *base;
34  bool singleFile; // true if there is only one file
35 
36 public:
37  // Member functions
38 
40  // constructor
41  // creates a new coStepFile
42  // \param filepath the path to the first fileName of
43  // a sequence of files with similar names.
44  // Example: coStepFile myStepFile("image1.png");
45  coStepFile(const char *filepath);
46  ~coStepFile();
47 
49  // gets path to the next file in the sequence
50  // \param resultpath function writes next filename in
51  // sequence to this parameter.
52  void get_nextpath(char **resultpath);
53 
54  void set_delta(int);
55  void getDelta(int *);
56  void set_skip_value(int);
57  void get_skip_value(int *);
58 };
59 }
60 #endif
int delta
Definition: coStepFile.h:26
bool singleFile
Definition: coStepFile.h:34
char * suffix
Definition: coStepFile.h:32
char * prefix
Definition: coStepFile.h:31
#define APIEXPORT
Definition: coExport.h:251
int finished
Definition: coStepFile.h:28
int base_number
Definition: coStepFile.h:29
int file_index
Definition: coStepFile.h:30
Definition: coStepFile.h:19
int len_nb
Definition: coStepFile.h:27
int skip
Definition: coStepFile.h:25
char * base
Definition: coStepFile.h:33