FileSeq Class Reference

Inheritance diagram for FileSeq:

List of all members.

Public Member Functions
bool	isValid () const override
	Return whether this instance contains a valid file sequence.
FileSequence *	clone () const override
	Return new copy of this class instance.
void	getAsString (std::string &retValue) override
	Get string representation of the file sequence.
void	getDirectory (std::string &retValue) override
	Get the directory portion of file sequence.
void	getPrefix (std::string &retValue) override
	Get the portion of file sequence before the frame number.
void	getSuffix (std::string &retValue) override
	Get the portion of file sequence after the frame number.
unsigned int	getPadding () override
	Get the padding of the file sequence frame number.
void	getResolvedPath (const int frame, std::string &retValue) override
	Get the filename for file sequence with sequence portion replaced by correctly padded frame.
bool	hasFrameSet () override
	Return whether file sequence has explicit frame set.
bool	isFrameInFrameSet (const int frame) override
	Test whether frame is within explicit frame set.
int	getFirstFrameInFrameSet () override
	Return first frame in explicit frame set.
int	getLastFrameInFrameSet () override
	Return last frame in explicit frame set.
void	getNearestFramesInFrameSet (int frame, bool *hasLeft, int *nearestLeft, bool *hasRight, int *nearestRight) override
	Return nearest frame to left and right of frame.
void	getFrameListFromFrameSet (std::vector< int > &returnList) override
	Get frame set as list of integers.

---

Member Function Documentation

void FileSeq::getAsString

(

std::string &

retValue

)

[override, virtual]

Get string representation of the file sequence.

Parameters:

retValue

Set to file sequence string.

Implements Foundry::Katana::FileSequence.

void FileSeq::getDirectory

(

std::string &

retValue

)

[override, virtual]

Get the directory portion of file sequence.

Parameters:

retValue

Set to directory portion of file sequence (e.g. "/a/b/c" for fileseq "/a/b/c/d.#.exr").

Implements Foundry::Katana::FileSequence.

int FileSeq::getFirstFrameInFrameSet

(

)

[override, virtual]

Return first frame in explicit frame set.

Returns:

First (minimum) frame in frame set. If file sequence does not have explicit frame set, always return 0.

Implements Foundry::Katana::FileSequence.

void FileSeq::getFrameListFromFrameSet

(

std::vector< int > &

returnList

)

[override, virtual]

Get frame set as list of integers.

Parameters:

returnList

Fill with integer frame numbers (e.g. [1,2,3,4,5] for "image.1-5#.exr").

Implements Foundry::Katana::FileSequence.

int FileSeq::getLastFrameInFrameSet

(

)

[override, virtual]

Return last frame in explicit frame set.

Returns:

Last (maximum) frame in frame set. If file sequence does not have explicit frame set, always return 0.

Implements Foundry::Katana::FileSequence.

void FileSeq::getNearestFramesInFrameSet	(	int	frame,
		bool *	hasLeft,
		int *	nearestLeft,
		bool *	hasRight,
		int *	nearestRight
	)		[override, virtual]

Return nearest frame to left and right of frame.

Parameters:

frame	Frame number to return nearest frames of.
hasLeft	Set to true if frame exists in list to left of specified frame.
nearestLeft	Set to nearest frame in list to left of specified frame.
hasRight	Set to true if frame exists in list to right of specified frame.
nearestRight	Set to nearest frame in list to right of specified frame.

Set return values to (false, 0, false, 0) if file sequence does not have explicit fram set.

Implements Foundry::Katana::FileSequence.

unsigned int FileSeq::getPadding

(

)

[override, virtual]

Get the padding of the file sequence frame number.

Returns:

Padding amount of file sequence (e.g. 4 for fileseq that expands to image.0001.exr)

Implements Foundry::Katana::FileSequence.

void FileSeq::getPrefix

(

std::string &

retValue

)

[override, virtual]

Get the portion of file sequence before the frame number.

Parameters:

retValue

Set to prefix portion of file sequence (e.g. "/a/b/c/d." for fileseq "/a/b/c/d.#.exr").

Implements Foundry::Katana::FileSequence.

void FileSeq::getResolvedPath	(	const int	frame,
		std::string &	retValue
	)		[override, virtual]

Get the filename for file sequence with sequence portion replaced by correctly padded frame.

Parameters:

frame	The frame to get the filename.
retValue	Set to resolved filename.

Implements Foundry::Katana::FileSequence.

void FileSeq::getSuffix

(

std::string &

retValue

)

[override, virtual]

Get the portion of file sequence after the frame number.

Parameters:

retValue

Set to suffix portion of file sequence (e.g. ".exr" for fileseq "/a/b/c/d.#.exr").

Implements Foundry::Katana::FileSequence.

bool FileSeq::hasFrameSet

(

)

[override, virtual]

Return whether file sequence has explicit frame set.

Returns:

True if file sequence has explicit frame range (set) embedded in it (e.g. "image.1-10#.exr").

Implements Foundry::Katana::FileSequence.

bool FileSeq::isFrameInFrameSet

(

const int

frame

)

[override, virtual]

Test whether frame is within explicit frame set.

Returns:

True if frame is in frame set. If file sequence does not have explicit frame set, always return true.

Implements Foundry::Katana::FileSequence.

---

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

• FileSequencePlugin.h