daeSIDResolver.h

Go to the documentation of this file.

/*
* Copyright 2006 Sony Computer Entertainment Inc.
*
* Licensed under the MIT Open Source License, for details please see license.txt or the website
* http://www.opensource.org/licenses/mit-license.php
*
*/ 

#ifndef __DAE_SIDRESOLVER_H__
#define __DAE_SIDRESOLVER_H__

#include <string>
#include <map>
#include <dae/daeTypes.h>
#include <dae/daeElement.h>


// This is an alternative to the daeSIDResolver class. It's recommended you use
// this class instead. Typical usage: get the element a sid ref points to. For
// example, if you want to find the element with sid 'sampler' using a
// daeElement pointer named 'effect', that would look like this:
//   daeElement* elt = daeSidRef("sampler", effect).resolve().elt
struct DLLSPEC daeSidRef {
        // A helper class for returning all the data retrieved when a sid is resolved.
        struct DLLSPEC resolveData {
                resolveData();
                resolveData(daeElement* elt, daeDoubleArray* array, daeDouble* scalar);

                daeElement* elt;
                daeDoubleArray* array;
                daeDouble* scalar;
        };
        
        daeSidRef();
        daeSidRef(const std::string& sidRef, daeElement* referenceElt, const std::string& profile = "");
        bool operator<(const daeSidRef& other) const;

        resolveData resolve();
                
        std::string sidRef;
        daeElement* refElt;
        std::string profile;
};


class DLLSPEC daeSIDResolver
{
public:
        enum ResolveState{
                target_empty,
                target_loaded,
                sid_failed_not_found,
                sid_success_element,
                sid_success_array,
                sid_success_double
        };

        daeSIDResolver( daeElement *container, daeString target, daeString platform = NULL );

        daeString getTarget() const;
        void setTarget( daeString t );

        daeString getProfile()  const;
        void setProfile( daeString p );

        daeElement* getContainer() const;
        void setContainer(daeElement* element);

        daeElement* getElement();

        daeDoubleArray *getDoubleArray();

        daeDouble *getDouble();

        // This method is deprecated. Don't use it.
        ResolveState getState() const;

private:
        // This data is provided by the user
        std::string     target;
        std::string     profile;        
        daeElement* container;
};


// A class to make sid ref lookups faster. Meant for DOM internal use only.
class DLLSPEC daeSidRefCache {
public:
        daeSidRefCache();
        
        daeSidRef::resolveData lookup(const daeSidRef& sidRef);
        void add(const daeSidRef& sidRef, const daeSidRef::resolveData& data);
        void clear();

        // For debugging/testing
        bool empty();
        int misses();
        int hits();

private:
        std::map<daeSidRef, daeSidRef::resolveData> lookupTable;
        int hitCount;
        int missCount;
};

#endif

---

colladadom
Author(s): Du Hung Hou, Khronos.org, Marcus Barnes, Greg Corson, Herbert Law, Sebastian Schwarz, Steven Thomas, John Hsu (ros package), Tim Field (ros package)
autogenerated on Fri Jan 11 09:24:25 2013