Field3D
FileSequence.h
Go to the documentation of this file.
1 //----------------------------------------------------------------------------//
2 
3 /*
4  * Copyright (c) 2014 Sony Pictures Imageworks Inc
5  *
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in the
16  * documentation and/or other materials provided with the
17  * distribution. Neither the name of Sony Pictures Imageworks nor the
18  * names of its contributors may be used to endorse or promote
19  * products derived from this software without specific prior written
20  * permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
33  * OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 //----------------------------------------------------------------------------//
37 
43 //----------------------------------------------------------------------------//
44 
45 #ifndef _INCLUDED_Field3D_FileSequence_H_
46 #define _INCLUDED_Field3D_FileSequence_H_
47 
48 //----------------------------------------------------------------------------//
49 
50 #include <string>
51 #include <vector>
52 
53 //----------------------------------------------------------------------------//
54 
55 #include "ns.h"
56 
58 
59 //----------------------------------------------------------------------------//
60 // FileSequence
61 //----------------------------------------------------------------------------//
62 
64 {
65 
66 public:
67 
68  // Typedefs ---
69 
70  typedef std::vector<std::string> StringVec;
71 
72  // Ctors, dtor ---
73 
76  { }
82  FileSequence(const std::string &sequence);
83 
85  size_t size() const
86  { return m_filenames.size(); }
87 
89  const std::string& filename(const size_t idx) const
90  { return m_filenames[idx]; }
91 
93  const StringVec& filenames() const
94  { return m_filenames; }
95 
96 private:
97 
98  // Data members ------------------------------------------------------------
99 
101  std::vector<std::string> m_filenames;
102 
103 };
104 
105 //----------------------------------------------------------------------------//
106 
108 
109 //----------------------------------------------------------------------------//
110 
111 #endif // Include guard
FIELD3D_NAMESPACE_HEADER_CLOSE
#define FIELD3D_NAMESPACE_HEADER_CLOSE
Definition: ns.h:58
FileSequence
Definition: FileSequence.h:63
FileSequence::m_filenames
std::vector< std::string > m_filenames
Stores the resulting filenames.
Definition: FileSequence.h:101
FileSequence::FileSequence
FileSequence()
Default constructor. Creates an empty sequence.
Definition: FileSequence.h:75
ns.h
FileSequence::filename
const std::string & filename(const size_t idx) const
Returns a single filename.
Definition: FileSequence.h:89
FileSequence::StringVec
std::vector< std::string > StringVec
Definition: FileSequence.h:70
FileSequence::filenames
const StringVec & filenames() const
Returns the full list of all filenames.
Definition: FileSequence.h:93
FIELD3D_NAMESPACE_OPEN
Definition: FieldMapping.cpp:74
FileSequence::size
size_t size() const
Number of files in sequence.
Definition: FileSequence.h:85