NTV2ACFrameRange Class Reference

AutoCirculate Frame Range. More...

#include <ntv2utils.h>

Public Member Functions
	NTV2ACFrameRange (const UWord inFrameCount=0)
	NTV2ACFrameRange (const UWord inFirstFrame, const UWord inLastFrame)
bool	isCountOnly (void) const
bool	isFrameRange (void) const
UWord	count (void) const
UWord	firstFrame (void) const
UWord	lastFrame (void) const
	operator bool () const
bool	valid (void) const
NTV2ACFrameRange &	makeInvalid (void)
bool	setExactRange (const UWord inFirstFrame, const UWord inLastFrame)
bool	setRangeWithCount (const UWord inCount, const UWord inFirstFrame)
bool	setCountOnly (const UWord inCount)
std::string	setFromString (const std::string &inStr)
std::string	toString (const bool inNormalized=false) const

Detailed Description

AutoCirculate Frame Range.

Definition at line 971 of file ntv2utils.h.

Constructor & Destructor Documentation

NTV2ACFrameRange() [1/2]

NTV2ACFrameRange::NTV2ACFrameRange ( const UWord  inFrameCount = 0 )

inlineexplicit

Definition at line 974 of file ntv2utils.h.

NTV2ACFrameRange() [2/2]

NTV2ACFrameRange::NTV2ACFrameRange ( const UWord  inFirstFrame, const UWord  inLastFrame  )

inlineexplicit

Definition at line 978 of file ntv2utils.h.

Member Function Documentation

count()

UWord NTV2ACFrameRange::count ( void  ) const

inline

Returns

my frame count (if a simple frame count); otherwise zero

Definition at line 984 of file ntv2utils.h.

firstFrame()

UWord NTV2ACFrameRange::firstFrame ( void  ) const

inline

Returns

my first frame (if explicit frame range); otherwise zero

Definition at line 985 of file ntv2utils.h.

isCountOnly()

bool NTV2ACFrameRange::isCountOnly ( void  ) const

inline

Returns

true if I'm a simple frame count

Definition at line 982 of file ntv2utils.h.

isFrameRange()

bool NTV2ACFrameRange::isFrameRange ( void  ) const

inline

Returns

true if I'm a specific frame range

Definition at line 983 of file ntv2utils.h.

lastFrame()

UWord NTV2ACFrameRange::lastFrame ( void  ) const

inline

Returns

my last frame (if explicit frame range); otherwise zero

Definition at line 986 of file ntv2utils.h.

makeInvalid()

NTV2ACFrameRange& NTV2ACFrameRange::makeInvalid ( void  )

inline

Definition at line 994 of file ntv2utils.h.

operator bool()

NTV2ACFrameRange::operator bool ( ) const

inline

Returns

true if valid; otherwise false

Definition at line 987 of file ntv2utils.h.

setCountOnly()

bool NTV2ACFrameRange::setCountOnly ( const UWord  inCount )

inline

Definition at line 1016 of file ntv2utils.h.

setExactRange()

bool NTV2ACFrameRange::setExactRange ( const UWord  inFirstFrame, const UWord  inLastFrame  )

inline

Definition at line 1000 of file ntv2utils.h.

setFromString()

string NTV2ACFrameRange::setFromString

(

const std::string &

inStr

)

Definition at line 4256 of file ntv2utils.cpp.

setRangeWithCount()

bool NTV2ACFrameRange::setRangeWithCount ( const UWord  inCount, const UWord  inFirstFrame  )

inline

Definition at line 1008 of file ntv2utils.h.

toString()

string NTV2ACFrameRange::toString

(

const bool

inNormalized = false

)

const

Definition at line 4306 of file ntv2utils.cpp.

valid()

bool NTV2ACFrameRange::valid ( void  ) const

inline

Definition at line 988 of file ntv2utils.h.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2utils.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2utils.cpp