FileSequence.h
Go to the documentation of this file.
//----------------------------------------------------------------------------//
/*
* Copyright (c) 2014 Sony Pictures Imageworks Inc
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution. Neither the name of Sony Pictures Imageworks nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
//----------------------------------------------------------------------------//
//----------------------------------------------------------------------------//
#ifndef _INCLUDED_Field3D_FileSequence_H_
#define _INCLUDED_Field3D_FileSequence_H_
//----------------------------------------------------------------------------//
#include <string>
#include <vector>
//----------------------------------------------------------------------------//
#include "ns.h"
FIELD3D_NAMESPACE_OPEN
//----------------------------------------------------------------------------//
// FileSequence
//----------------------------------------------------------------------------//
class FileSequence
{
public:
// Typedefs ---
typedef std::vector<std::string> StringVec;
// Ctors, dtor ---
FileSequence()
{ }
FileSequence(const std::string &sequence);
size_t size() const
{ return m_filenames.size(); }
const std::string& filename(const size_t idx) const
{ return m_filenames[idx]; }
const StringVec& filenames() const
{ return m_filenames; }
private:
// Data members ------------------------------------------------------------
std::vector<std::string> m_filenames;
};
//----------------------------------------------------------------------------//
FIELD3D_NAMESPACE_HEADER_CLOSE
//----------------------------------------------------------------------------//
#endif // Include guard
FileSequence::filename
const std::string & filename(const size_t idx) const
Returns a single filename.
Definition FileSequence.h:89
FileSequence::size
size_t size() const
Number of files in sequence.
Definition FileSequence.h:85
FileSequence::m_filenames
std::vector< std::string > m_filenames
Stores the resulting filenames.
Definition FileSequence.h:101
FileSequence::filenames
const StringVec & filenames() const
Returns the full list of all filenames.
Definition FileSequence.h:93
FileSequence::FileSequence
FileSequence()
Default constructor. Creates an empty sequence.
Definition FileSequence.h:75
FileSequence::StringVec
std::vector< std::string > StringVec
Definition FileSequence.h:70
FIELD3D_NAMESPACE_OPEN
Definition FieldMapping.cpp:74
ns.h
FIELD3D_NAMESPACE_HEADER_CLOSE
#define FIELD3D_NAMESPACE_HEADER_CLOSE
Definition ns.h:58