Cortex  10.0.0-a4
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
IECore::CompoundFrameList Class Reference

#include <CompoundFrameList.h>

+ Inheritance diagram for IECore::CompoundFrameList:

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPED (CompoundFrameList, FrameList)
 
 CompoundFrameList (const std::vector< FrameListPtr > frameLists)
 
std::vector< FrameListPtr > & getFrameLists ()
 
const std::vector< FrameListPtr > & getFrameLists () const
 
void setFrameLists (const std::vector< FrameListPtr > &)
 
void asList (std::vector< Frame > &frames) const override
 
std::string asString () const override
 
bool isEqualTo (ConstFrameListPtr other) const override
 
FrameListPtr copy () const override
 
- Public Member Functions inherited from IECore::FrameList
 IE_CORE_DECLARERUNTIMETYPED (FrameList, RunTimeTyped)
 
void asClumpedList (std::vector< std::vector< Frame > > &clumpedFrames, unsigned int clumpSize) const
 
bool operator== (const FrameList &other) const
 
- Public Member Functions inherited from IECore::RunTimeTyped
 IE_CORE_DECLAREMEMBERPTR (RunTimeTyped)
 
virtual TypeId typeId () const
 
virtual const char * typeName () const
 
virtual bool isInstanceOf (TypeId typeId) const
 
virtual bool isInstanceOf (const char *typeName) const
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 

Static Public Member Functions

static FrameListPtr parse (const std::string &frameList)
 
- Static Public Member Functions inherited from IECore::FrameList
static FrameListPtr parse (const std::string &frameList)
 
- Static Public Member Functions inherited from IECore::RunTimeTyped
static TypeId staticTypeId ()
 Returns the TypeId for this class, without needing an instance.
 
static const char * staticTypeName ()
 Returns the type name for this class, without needing an instance.
 
static TypeId baseTypeId ()
 
static const char * baseTypeName ()
 
static bool inheritsFrom (TypeId typeId)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (const char *typeName)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (TypeId type, TypeId baseType)
 Returns true if type inherits from baseType.
 
static bool inheritsFrom (const char *typeName, const char *baseTypeName)
 Returns true if typeName inherits from baseTypeName.
 
static TypeId baseTypeId (TypeId typeId)
 Returns the base type of the given type, or InvalidTypeId if no such base exists.
 
static const std::vector< TypeId > & baseTypeIds (TypeId typeId)
 
static const std::set< TypeId > & derivedTypeIds (TypeId typeId)
 
static TypeId typeIdFromTypeName (const char *typeName)
 
static const char * typeNameFromTypeId (TypeId typeId)
 
static void registerType (TypeId derivedTypeId, const char *derivedTypeName, TypeId baseTypeId)
 Allows external modules to register their own type ids.
 

Protected Attributes

std::vector< FrameListPtr > m_frameLists
 

Additional Inherited Members

- Public Types inherited from IECore::FrameList
typedef int64_t Frame
 
- Public Types inherited from IECore::RunTimeTyped
typedef RefCounted BaseClass
 A typedef for the class this class derives from. All RunTimeTyped classes define this typedef.
 
- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 
- Protected Types inherited from IECore::FrameList
typedef FrameListPtr(* ParserFn) (const std::string &frameList)
 
- Protected Types inherited from IECore::RunTimeTyped
typedef std::map< TypeId, TypeIdBaseTypeRegistryMap
 
typedef std::map< TypeId, std::vector< TypeId > > BaseTypesRegistryMap
 
typedef std::map< TypeId, std::set< TypeId > > DerivedTypesRegistryMap
 
typedef tbb::spin_rw_mutex Mutex
 
typedef std::map< TypeId, std::string > TypeIdsToTypeNamesMap
 
typedef std::map< std::string, TypeIdTypeNamesToTypeIdsMap
 
- Static Protected Member Functions inherited from IECore::FrameList
static void registerParser (ParserFn fn)
 
- Static Protected Member Functions inherited from IECore::RunTimeTyped
static BaseTypeRegistryMap & baseTypeRegistry ()
 
static DerivedTypesRegistryMap & derivedTypesRegistry ()
 
static BaseTypesRegistryMap & completeBaseTypesRegistry ()
 
static DerivedTypesRegistryMap & completeDerivedTypesRegistry ()
 
static void derivedTypeIdsWalk (TypeId typeId, std::set< TypeId > &)
 
static TypeIdsToTypeNamesMap & typeIdsToTypeNames ()
 
static TypeNamesToTypeIdsMap & typeNamesToTypeIds ()
 
- Static Protected Attributes inherited from IECore::RunTimeTyped
static Mutex g_baseTypeIdsMutex
 
static Mutex g_derivedTypeIdsMutex
 

Detailed Description

The CompoundFrameList class implements the FrameList interface by storing a set of FrameList objects, and returning an order preserving union of all the frames they represent in its asList() method.

Constructor & Destructor Documentation

IECore::CompoundFrameList::CompoundFrameList ( const std::vector< FrameListPtr >  frameLists)

Constructs a CompoundFrameList object given a list of FrameList objects. These can subsequently be accessed and modified via the frameLists method

Member Function Documentation

void IECore::CompoundFrameList::asList ( std::vector< Frame > &  frames) const
overridevirtual

Returns all the frames represented by the FrameLists in self.frameLists. Frames are returned in the order specified by self.frameLists, but duplicate frames will be omitted.

Implements IECore::FrameList.


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