daeIDRef.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_IDREF_H__
#define __DAE_IDREF_H__

#include <string>
#include <dae/daeTypes.h>
#include <dae/daeElement.h>
class DAE;

class DLLSPEC daeIDRef
{
public:
        enum ResolveState{
                id_empty,
                id_loaded,
                id_pending,
                id_success,
                id_failed_id_not_found,
                id_failed_invalid_id,
                id_failed_invalid_reference,
                id_failed_externalization,
                id_failed_no_document
        };
        
private:
        std::string id;

        daeElement* container;

public:
        daeIDRef();

        daeIDRef(daeString id);
        
        daeIDRef(const daeIDRef& constructFromIDRef);

        daeIDRef(daeElement& container);

        daeString getID() const;

        void setID(daeString ID);

        daeElement* getElement() const;

        daeElement* getContainer() const;

        void setContainer(daeElement* cont);

        void print();

        void reset();

        void initialize();

        bool operator==(const daeIDRef& other) const;

        daeIDRef &operator=( const daeIDRef& other);

        // These methods are only provided for backwards compatibility. Use the listed alternatives.
        daeIDRef &get( daeUInt idx ); // Never should have existed. No alternative.
        size_t getCount() const; // Never should have existed. No alternative.
        daeIDRef& operator[](size_t index); // Never should have existed. No alternative.
        void resolveElement( daeString typeNameHint = NULL ); // Call getElement. No separate "resolve" step needed.
        void resolveID(); // Never should have existed. No alternative.
        void validate(); // Never should have existed. No alternative.
        void copyFrom(const daeIDRef& from); // Use the assignment operator instead.
        ResolveState getState() const; // Never should have existed. No alternative.
};

class DLLSPEC daeIDRefResolver
{
public:
        daeIDRefResolver(DAE& dae);

        virtual ~daeIDRefResolver();
        
        virtual daeElement* resolveElement(const std::string& id, daeDocument* doc) = 0;
                                           

        virtual daeString getName() = 0;

protected:
        DAE* dae;
};


class DLLSPEC daeDefaultIDRefResolver : public daeIDRefResolver
{
public:
        daeDefaultIDRefResolver(DAE& dae);
        ~daeDefaultIDRefResolver();
        virtual daeElement* resolveElement(const std::string& id, daeDocument* doc);
        virtual daeString getName();
};


// This is a container class for storing a modifiable list of daeIDRefResolver objects.
class DLLSPEC daeIDRefResolverList {
public:
        daeIDRefResolverList();
        ~daeIDRefResolverList();

        void addResolver(daeIDRefResolver* resolver);
        void removeResolver(daeIDRefResolver* resolver);

        daeElement* resolveElement(const std::string& id, daeDocument* doc);

private:
        // Disabled copy constructor/assignment operator
        daeIDRefResolverList(const daeIDRefResolverList& resolverList) { };
        daeIDRefResolverList& operator=(const daeIDRefResolverList& resolverList) { return *this; };

        daeTArray<daeIDRefResolver*> resolvers;
};


#endif //__DAE_IDREF_H__

---

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