outerable_object.hpp

Go to the documentation of this file.

//
// See license.txt for license information.
//
// outerable_object.hpp
//
// 17-Jul-2003  phamilton  Created
//

#ifndef incCOMMON_OUTERABLE_OBJECT
#define incCOMMON_OUTERABLE_OBJECT

namespace ph {
namespace common {

// forwards
class object_base;

class outerable_object_base
/**
        Abstract class representing a an object which has an outer.
*/
{
public:
        virtual ~outerable_object_base() {}
        
        virtual object_base *outer() const = 0;
                //!< return the "outer" object from this one.
                //!
        virtual void outer(object_base *outer) = 0;
                //!< Set the outer object of this object.
                //!
};

class outerable_helper
/**
        A helper class whcih declares a member of the class type to provide the
        outer of an object.
*/
{
public:
        outerable_helper(object_base *outer=0) :
                _outer(outer)
                        {};
                        
        object_base *outer_helper() const 
                { return _outer; }
        void outer_helper(object_base *outer) 
                { _outer = outer; }
                
private:
        object_base *_outer;
};

}; // common
}; // ph

#endif // incCOMMON_OUTERABLE_OBJECT

---