doxygen/html/iparenttochildcontainer_8h_source.html

#pragma once

// iparenttochildcontainer.h

#include "utility/interface/icontainer.h"


namespace itasca {

    class IThing;


    class IParentToChildContainer {

    public:

        inline static const TType type_ = 0x4e95af7a;


        virtual const IContainer::signal_type *getAddedSignalChild() const=0;

        virtual const IContainer::signal_type *getRemovedSignalChild() const=0;

        virtual const IContainer::signal_type *getDestroySignalChild() const=0;

        virtual void                         pushFrontChild(IThing *)=0;

        virtual void                         pushBackChild(IThing *)=0;

        virtual IContainer::IOpaqueIterator *acquireChild(IThing *) const=0;

        virtual void                         releaseChild(IContainer::IOpaqueIterator *i) const=0;

        virtual bool                         atEndChild(IContainer::IOpaqueIterator *i) const=0;

        virtual IThing                      *getChild(IContainer::IOpaqueIterator *i)=0;

        virtual const IThing                *getChild(IContainer::IOpaqueIterator *i) const=0;

        virtual bool                         incrementChild(IContainer::IOpaqueIterator *i) const=0;

        virtual bool                         copyChild(IContainer::IOpaqueIterator *iSrc,IContainer::IOpaqueIterator *iDst) const=0;

        virtual void                         cleanIterators(IThing *)=0;


    };


}

// EoF

itasca::IContainer::IOpaqueIterator
Interface class for iterating through the container that has a null implementation.
Definition icontainer.h:33

itasca::IContainer::signal_type
shared::Signal< const IThing *, const IContainer * > signal_type
Defines the Signal2<> type used for removed, added, and destroy signals sent from the container.
Definition icontainer.h:27

itasca::IParentToChildContainer
Provides a class to use as the parent to a child container, or the main container of all of the child...
Definition iparenttochildcontainer.h:14

itasca::IParentToChildContainer::getDestroySignalChild
virtual const IContainer::signal_type * getDestroySignalChild() const =0

itasca::IParentToChildContainer::releaseChild
virtual void releaseChild(IContainer::IOpaqueIterator *i) const =0
Make the opaque iterator availble.

itasca::IParentToChildContainer::type_
static const TType type_
The type identification number for this class, for use in convert_cast() and convert_getcast().
Definition iparenttochildcontainer.h:17

itasca::IParentToChildContainer::cleanIterators
virtual void cleanIterators(IThing *)=0
Clean up the iterators upon deletion.

itasca::IParentToChildContainer::getChild
virtual IThing * getChild(IContainer::IOpaqueIterator *i)=0
Returns a pointer to the child of the given iterator, or NULL if the iterator does not have a child.

itasca::IParentToChildContainer::acquireChild
virtual IContainer::IOpaqueIterator * acquireChild(IThing *) const =0
Returns an opaque interator pointer to an available (or new) object in the container

itasca::IParentToChildContainer::pushBackChild
virtual void pushBackChild(IThing *)=0
Adds child to the back of the list.

itasca::IParentToChildContainer::copyChild
virtual bool copyChild(IContainer::IOpaqueIterator *iSrc, IContainer::IOpaqueIterator *iDst) const =0
Child shallow copy.

itasca::IParentToChildContainer::getChild
virtual const IThing * getChild(IContainer::IOpaqueIterator *i) const =0
Returns a constant pointer to the child of the given iterdator, or NULL if the iterator does not have...

itasca::IParentToChildContainer::incrementChild
virtual bool incrementChild(IContainer::IOpaqueIterator *i) const =0
Moves child pointer to the next child, incrementing the iterator.

itasca::IParentToChildContainer::getAddedSignalChild
virtual const IContainer::signal_type * getAddedSignalChild() const =0

itasca::IParentToChildContainer::atEndChild
virtual bool atEndChild(IContainer::IOpaqueIterator *i) const =0
Returns true if this child is the last one in the list.

itasca::IParentToChildContainer::getRemovedSignalChild
virtual const IContainer::signal_type * getRemovedSignalChild() const =0

itasca::IParentToChildContainer::pushFrontChild
virtual void pushFrontChild(IThing *)=0
Adds child to the front of the list.

itasca::IThing
Base class for items that will be stored in containers.
Definition ithing.h:30

TType
uint32 TType
class type indicator
Definition basedef.h:46

icontainer.h
Interface for container of IThings.

itasca
namespace Itasca
Definition basememory.cpp:14