NumNameSeq Class Reference

Describes a NumName sequence with a head and tail range. More...

#include <numnameseq.h>

Public Types
using	List = promeki::List< NumNameSeq >
	List of NumNameSeq values.

Public Member Functions
	NumNameSeq ()=default
	Default constructor.
	NumNameSeq (const NumName &n, size_t h, size_t t)
	Constructs a NumNameSeq with the given name, head, and tail.
const NumName &	name () const
	Returns the NumName for this sequence.
bool	isValid () const
	Returns true if the sequence is valid.
size_t	length () const
	Returns the number of entries in the sequence.
size_t	head () const
	Returns the head (first) index of the sequence.
size_t	tail () const
	Returns the tail (last) index of the sequence.

Static Public Member Functions
static List	parseList (StringList &input)
	Parses a list of NumNameSeq objects from the string list.

Detailed Description

Describes a NumName sequence with a head and tail range.

Represents a named, numbered file sequence (e.g. "image.0001.exr" through "image.0100.exr") by storing the NumName pattern along with the first and last sequence indices.

Constructor & Destructor Documentation

NumNameSeq()

NumNameSeq::NumNameSeq ( const NumName &  n, size_t  h, size_t  t  )

inline

Constructs a NumNameSeq with the given name, head, and tail.

Parameters

n	The NumName pattern for this sequence.
h	The head (first) index of the sequence.
t	The tail (last) index of the sequence.

Member Function Documentation

head()

size_t NumNameSeq::head ( ) const

inline

Returns the head (first) index of the sequence.

Returns

The starting index.

isValid()

bool NumNameSeq::isValid ( ) const

inline

Returns true if the sequence is valid.

Returns

true if the underlying NumName is valid.

length()

size_t NumNameSeq::length ( ) const

inline

Returns the number of entries in the sequence.

Returns

The count of indices from head through tail, inclusive.

name()

const NumName & NumNameSeq::name ( ) const

inline

Returns the NumName for this sequence.

Returns

A const reference to the NumName pattern.

parseList()

static List NumNameSeq::parseList ( StringList &  input )

static

Parses a list of NumNameSeq objects from the string list.

Any objects that can't be num names will be left in the input list.

Parameters

input

The string list to parse; non-matching entries remain.

Returns

A List of parsed NumNameSeq objects.

tail()

size_t NumNameSeq::tail ( ) const

inline

Returns the tail (last) index of the sequence.

Returns

The ending index.

---

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

• include/promeki/core/numnameseq.h