TuttleOFX  1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends
sequenceParser::FileObject Class Reference

A container for files, directories and sequences. More...

#include <FileObject.hpp>

Inheritance diagram for sequenceParser::FileObject:
Inheritance graph
[legend]

Public Member Functions

 FileObject ()
 FileObject (const EMaskOptions options)
 FileObject (const boost::filesystem::path &directory, const EMaskType &type, const EMaskOptions &options)
 Construct a FileObject with given informations.
 FileObject (const FileObject &other)
FileObject & operator= (const FileObject &other)
virtual ~FileObject ()
virtual std::ostream & getCout (std::ostream &os) const =0
virtual std::vector
< boost::filesystem::path > 		getFiles () const =0
boost::filesystem::path getDirectory () const
boost::filesystem::path getAbsoluteDirectory () const
void setDirectory (const boost::filesystem::path &p)
void setDirectoryFromPath (const boost::filesystem::path &p)
EMaskOptions getMaskOptions () const
EMaskType getMaskType () const
virtual void clear ()
virtual FileObject * clone () const =0

Protected Member Functions

bool showProperties () const
bool showRelativePath () const
bool showAbsolutePath () const

Protected Attributes

boost::filesystem::path _directory
 directory
EMaskType _type
 specify type of object
EMaskOptions _options
 specify output options of object, common for each objects
std::string _kColorStd
std::string _kColorFolder
std::string _kColorFile
std::string _kColorSequence
std::string _kColorError

Private Member Functions

void init (const boost::filesystem::path &directory, const EMaskType &type, const EMaskOptions &options)
void setColorActive (bool activate=false)

Friends

std::ostream & operator<< (std::ostream &os, const FileObject &fo)

Detailed Description

A container for files, directories and sequences.

Definition at line 13 of file FileObject.hpp.

Constructor & Destructor Documentation

sequenceParser::FileObject::FileObject ( ) [inline]

Definition at line 17 of file FileObject.hpp.

References _directory, _options, _type, sequenceParser::eMaskOptionsColor, sequenceParser::eMaskOptionsNone, sequenceParser::eMaskTypeUndefined, and setColorActive().

Here is the call graph for this function:

sequenceParser::FileObject::FileObject ( const EMaskOptions  options) [inline]

Definition at line 25 of file FileObject.hpp.

References _directory, _options, _type, sequenceParser::eMaskOptionsColor, sequenceParser::eMaskTypeUndefined, and setColorActive().

Here is the call graph for this function:

sequenceParser::FileObject::FileObject ( const boost::filesystem::path &  directory,
const EMaskType &  type,
const EMaskOptions &  options 
) [inline]

Construct a FileObject with given informations.

Definition at line 36 of file FileObject.hpp.

References init().

Here is the call graph for this function:

sequenceParser::FileObject::FileObject ( const FileObject &  other) [inline]

Definition at line 41 of file FileObject.hpp.

References operator=().

Here is the call graph for this function:

sequenceParser::FileObject::~FileObject ( ) [virtual]

Definition at line 5 of file FileObject.cpp.

Member Function Documentation

virtual void sequenceParser::FileObject::clear ( ) [inline, virtual]

Reimplemented in sequenceParser::Sequence, sequenceParser::File, and sequenceParser::Folder.

Definition at line 106 of file FileObject.hpp.

References _directory, _options, _type, sequenceParser::eMaskOptionsDefault, and sequenceParser::eMaskTypeDefault.

virtual FileObject* sequenceParser::FileObject::clone ( ) const [pure virtual]

Implemented in sequenceParser::Sequence, sequenceParser::File, and sequenceParser::Folder.

Referenced by sequenceParser::new_clone().

boost::filesystem::path sequenceParser::FileObject::getAbsoluteDirectory ( ) const [inline]

Definition at line 84 of file FileObject.hpp.

References _directory.

Referenced by tuttle::plugin::WriterPlugin::getAbsoluteDirectory(), and sequenceParser::File::getAbsoluteFilename().

virtual std::ostream& sequenceParser::FileObject::getCout ( std::ostream &  os) const [pure virtual]

Implemented in sequenceParser::Sequence, sequenceParser::File, and sequenceParser::Folder.

Referenced by sequenceParser::operator<<().

boost::filesystem::path sequenceParser::FileObject::getDirectory ( ) const [inline]
Todo:

Definition at line 79 of file FileObject.hpp.

References _directory.

virtual std::vector<boost::filesystem::path> sequenceParser::FileObject::getFiles ( ) const [pure virtual]
Todo:
: can we remove this?

Implemented in sequenceParser::Sequence, sequenceParser::File, and sequenceParser::Folder.

Referenced by removeFileObject().

EMaskOptions sequenceParser::FileObject::getMaskOptions ( ) const [inline]

Definition at line 96 of file FileObject.hpp.

References _options.

EMaskType sequenceParser::FileObject::getMaskType ( ) const [inline]

Definition at line 101 of file FileObject.hpp.

References _type.

Referenced by addListOfSequencesInListOfProcess(), dumpImageProperties(), getAbsoluteFilename(), main(), and removeFileObject().

void sequenceParser::FileObject::init ( const boost::filesystem::path &  directory,
const EMaskType &  type,
const EMaskOptions &  options 
) [inline, private]

Definition at line 117 of file FileObject.hpp.

References _directory, _options, _type, sequenceParser::eMaskOptionsColor, and setColorActive().

Referenced by FileObject().

Here is the call graph for this function:

FileObject& sequenceParser::FileObject::operator= ( const FileObject &  other) [inline]

Definition at line 46 of file FileObject.hpp.

References _directory, _kColorError, _kColorFile, _kColorFolder, _kColorSequence, _kColorStd, _options, and _type.

Referenced by FileObject().

void sequenceParser::FileObject::setColorActive ( bool  activate = false) [inline, private]

Definition at line 125 of file FileObject.hpp.

References _kColorError, _kColorFile, _kColorFolder, _kColorSequence, _kColorStd, sequenceParser::kColorError, sequenceParser::kColorFile, sequenceParser::kColorFolder, sequenceParser::kColorSequence, and sequenceParser::kColorStd.

Referenced by FileObject(), and init().

void sequenceParser::FileObject::setDirectory ( const boost::filesystem::path &  p) [inline]

Definition at line 89 of file FileObject.hpp.

References _directory.

Referenced by copy_sequence(), and sequenceParser::Sequence::Sequence().

void sequenceParser::FileObject::setDirectoryFromPath ( const boost::filesystem::path &  p)

Definition at line 15 of file FileObject.cpp.

References _directory.

Referenced by sequenceParser::Sequence::initFromDetection().

bool sequenceParser::FileObject::showAbsolutePath ( ) const [inline, protected]

Definition at line 157 of file FileObject.hpp.

References _options, and sequenceParser::eMaskOptionsAbsolutePath.

Referenced by sequenceParser::Folder::getCout(), sequenceParser::File::getCout(), and sequenceParser::Sequence::getCout().

bool sequenceParser::FileObject::showProperties ( ) const [inline, protected]

Definition at line 147 of file FileObject.hpp.

References _options, and sequenceParser::eMaskOptionsProperties.

Referenced by sequenceParser::Folder::getCout(), sequenceParser::File::getCout(), and sequenceParser::Sequence::getCout().

bool sequenceParser::FileObject::showRelativePath ( ) const [inline, protected]

Definition at line 152 of file FileObject.hpp.

References _options, and sequenceParser::eMaskOptionsPath.

Referenced by sequenceParser::Folder::getCout(), sequenceParser::File::getCout(), and sequenceParser::Sequence::getCout().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const FileObject &  fo 
) [friend]

Definition at line 9 of file FileObject.cpp.

Field Documentation

boost::filesystem::path sequenceParser::FileObject::_directory [protected]

directory

Definition at line 163 of file FileObject.hpp.

Referenced by clear(), FileObject(), getAbsoluteDirectory(), sequenceParser::Folder::getCout(), sequenceParser::File::getCout(), sequenceParser::Sequence::getCout(), getDirectory(), sequenceParser::Folder::getFiles(), sequenceParser::File::getFiles(), init(), sequenceParser::Sequence::initFromDetection(), operator=(), setDirectory(), and setDirectoryFromPath().

std::string sequenceParser::FileObject::_kColorError [protected]

Definition at line 173 of file FileObject.hpp.

Referenced by sequenceParser::Sequence::getCout(), operator=(), and setColorActive().

std::string sequenceParser::FileObject::_kColorFile [protected]

Definition at line 171 of file FileObject.hpp.

Referenced by sequenceParser::File::getCout(), operator=(), and setColorActive().

std::string sequenceParser::FileObject::_kColorFolder [protected]

Definition at line 170 of file FileObject.hpp.

Referenced by sequenceParser::Folder::getCout(), operator=(), and setColorActive().

std::string sequenceParser::FileObject::_kColorSequence [protected]

Definition at line 172 of file FileObject.hpp.

Referenced by sequenceParser::Sequence::getCout(), operator=(), and setColorActive().

std::string sequenceParser::FileObject::_kColorStd [protected]

Definition at line 169 of file FileObject.hpp.

Referenced by sequenceParser::Folder::getCout(), sequenceParser::File::getCout(), sequenceParser::Sequence::getCout(), operator=(), and setColorActive().

EMaskOptions sequenceParser::FileObject::_options [protected]

specify output options of object, common for each objects

Todo:
Remove this from here!

Definition at line 168 of file FileObject.hpp.

Referenced by sequenceParser::Sequence::checkPattern(), clear(), FileObject(), getMaskOptions(), init(), operator=(), sequenceParser::Sequence::Sequence(), showAbsolutePath(), showProperties(), and showRelativePath().

EMaskType sequenceParser::FileObject::_type [protected]

specify type of object

Definition at line 164 of file FileObject.hpp.

Referenced by clear(), FileObject(), getMaskType(), init(), and operator=().

The documentation for this class was generated from the following files: