object_navigator.hpp

Go to the documentation of this file.

// See ../license.txt for license information.
//
// object_navigator.hpp
//
// 8-Jul-2003  phamilton  Created
//

#ifndef incREFLECT_OBJECT_NAVIGATOR
#define incREFLECT_OBJECT_NAVIGATOR

// forwards
#include <string>
#include "config.hpp"

namespace ph {
namespace common {
class object_base;
};
namespace reflect {

class REFLECT_DECL object_navigator
/**
        Abstract class used to navigate the object tree and return an object.
*/
{
public:
        object_navigator(const ph::common::object_base *root, std::ostream *console) :
                _root(root), _console(console)
                        {};
        virtual ~object_navigator() {};
        
        virtual ph::common::object_base *navigate(const ph::common::object_base *obj, const std::string &path) = 0;
                //!< Return an object given a string path to that object. Subclasses
                //! implement the syntax of the path.
                
protected:
        const ph::common::object_base  *_root;
        std::ostream *_console;
};

class REFLECT_DECL object_navigator_factory
/**
        Abstract class used for a factory to create the object navigators.
*/
{
public:
        object_navigator_factory(std::ostream *console) :
                _console(console)
                        {};
        virtual ~object_navigator_factory() {};
        
        virtual object_navigator *create(const ph::common::object_base *root) = 0;
                //!< Create a new object navigator.
                
protected:
        std::ostream *_console;
};

}; // reflect
}; // ph

#endif // incREFLECT_OBJECT_NAVIGATOR

---