|| ||           || Doxygen's  

---

VxStructure.h

/*
 *  Copyright (c) 2000, University of Amsterdam, The Netherlands.
 *  All rights reserved.
 *
 *  Author(s):
 *  Jeroen Vendrig (vendrig@science.uva.nl)
 */

/*
 * JV, 03Jan01, increased efficiency, especially getShots() and getEffects().
 * JV, 03Jan01, added isSequential
 * JV, 04Sep01, made some functions const
 */

#ifndef VxStructure_h
#define VxStructure_h

#pragma warning( disable : 4786 )  


#include <map>
#include <list>
#include "HxString.h"
#include "HxIo.h"
#include "VxSegmentList.h"

struct VxStructureEval
{
    int correct;    // #times that two borders are equal
    int missed;     // #times that a border in Truth was not seen in Found
    int falseAlarm; // #times that a border was seen in Found, but not in Truth 
};


typedef std::map<HxString, VxSegmentList> VxStructureMap;

#define VXBLOCKS    "blocks"
#define VXSHOTS     "shots"
#define VXEFFECTS   "effects"
#define VXSCENES    "scenes"

class VxStructure {
public:
// Creation.
                            VxStructure();

                            VxStructure(const VxStructure& rhs);

                            VxStructure(HxString& base, 
                                std::vector<HxString> extLevels);

                            ~VxStructure();

    VxStructure&            operator=(const VxStructure& rhs);

    bool                    push(const HxString &levelId, const VxSegmentList& segList);

    bool                    push(const HxString &levelId, const HxString& filename);

    void                    replace(const HxString &levelId, 
                                const VxSegmentList& segList);


// Inquiry.
    bool                    exist(const HxString& levelId) const;   

    int                     size(const HxString& levelId) const;

    VxSegmentList           get(const HxString& levelId) const;

    VxSegmentList           get(const HxString& levelId, VxSegment timeSpan, 
                                bool complete=false) const;

    VxSegment               getSegment(const HxString& levelId, int index) const;
    
    VxSegmentList           getWhere(
                                const HxString& levelId, 
                                const HxString& strType, 
                                const int& val) const;
    VxSegmentList           getWhere(
                                const HxString& levelId, 
                                const HxString& strType, 
                                const HxString& val) const;

    VxSegmentList           getShots();
    VxSegmentList           getEffects();                               

    std::list<HxString>     getLevelNames() const;

    int                     mapsToIndex(
                                const HxString& levelId, VxSegment timeSpan) const;
    int                     mapsToIndex(
                                const HxString& levelId, int timeSpan) const;

    VxSegment               mapsToSegment(const HxString& levelId, int timeSpan) const;

    std::list<int>          getSegmentBoundaries(
                                const HxString& levelId, VxSegment timeSpan) const;


    bool                    isContinuous(const HxString& levelId) const;

    bool                    isSequential(const HxString& levelId) const;

    bool                    isParentOf(
                                const HxString& levelId1, const HxString& levelId2) const;

    bool                    isChildOf(
                                const HxString& levelId1, const HxString& levelId2) const;

    VxStructureEval         compare(
                                const HxString& levelId, 
                                const VxSegmentList& foundTruth) const;


// I/O.
    STD_OSTREAM&            put(
                                const HxString& levelId, 
                                STD_OSTREAM& os=STD_COUT) const;

private:
    void                    write(const HxString& levelId, const HxString& filename);
    bool                    read(const HxString& levelId, const HxString& filename);

    struct VxStructureRep{
        VxStructureMap      _map; 
        int                 refCount;
        VxStructureRep()    { refCount = 1;}        
    };

    VxStructureRep*         _data;

};

inline STD_OSTREAM&
operator<<(STD_OSTREAM& os, const VxStructure& vs)
{ 
    
    std::list<HxString> sl=vs.getLevelNames();
    for (std::list<HxString>::iterator it=sl.begin(); it!=sl.end(); it++)
    {
        os << "# Level name: " << *it << STD_ENDL;
        os << vs.get(*it);
    }
    
    return os;
}

#endif

---