[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/apps/tutorials/vostut6.cc

Go to the documentation of this file.

/* Sixth VOS tutorial.  Child and Property Listeners

   This tutorial covers:
   - Subclassing ChildChangeListener and PropertyListener
   - Handling notify callbacks
   - The VobjectEvent and PropertyEvent classes
   - Adding listeners to Vobjects

   This file (vostut6.cc) is released into the public domain.  No
   restrictions are placed on its use, distribution or inclusion into
   other works.
*/

#include <vos/vos/vos.hh>

using namespace VUtil;
using namespace VOS;

#ifdef WIN32
#define sleep _sleep
#endif

/* A very useful feature of VOS is the ability to get a notification
   callback when something interesting changes, such as the child list
   of a Vobject or the value of a property.  To handle these
   callbacks, you must subclass the appropriate "Listener" class.  The
   Listener defines certain methods which will be called when various
   events happen.  You must override and implement these methods in
   your own class.
 */


// This should be fairly self-explanatory.  The events signaled by
// notifyInserted, notifyReplaced and notifyRemoved correspond to the
// insertChild, setChild and removeChild methods in Vobject.  The
// VobjectEvent class provides specific information about what has happened.

class TutorialChildListener : public ChildChangeListener
{
public:
    virtual void notifyChildInserted(VobjectEvent& e);
    virtual void notifyChildReplaced(VobjectEvent& e);
    virtual void notifyChildRemoved(VobjectEvent& e);
};

void TutorialChildListener::notifyChildInserted(VobjectEvent& e)
{
    std::cout << "Parent " << e.getParent()->getURL().getString()
              << " has added child " << e.getChild()->getURL().getString()
              << "\n at position " << e.getPosition()
              << " with contextual name \"" << e.getContextualName() << "\"\n";
}

void TutorialChildListener::notifyChildReplaced(VobjectEvent& e)
{
    std::cout << "Parent " << e.getParent()->getURL().getString()
              << " has replaced child " << e.getOldChild()->getURL().getString()
              << "\n with " << e.getNewChild()->getURL().getString()
              << "\n at position " << e.getPosition()
              << " with contextual name \"" << e.getContextualName() << "\"\n";
}

void TutorialChildListener::notifyChildRemoved(VobjectEvent& e)
{
    std::cout << "Parent " << e.getParent()->getURL().getString()
              << " has removed child " << e.getChild()->getURL().getString()
              << "\n from position " << e.getPosition()
              << " (old contextual name \"" << e.getContextualName() << "\")\n";
}


// Similarly, you can ask to receive notification of property changes.

class TutorialPropertyListener : public PropertyListener
{
public:
    virtual void notifyPropertyChange(const PropertyEvent& e);
};


void TutorialPropertyListener::notifyPropertyChange(const PropertyEvent& e)
{
    std::cout << "Property " << e.getProperty()->getURLstr()
              << " has changed value from \"" << e.getOldValue()
              << "\" to \"" << e.getNewValue() << "\"\n";

}

int main(int argc, char** argv)
{
    std::cout << "VOS Tutorial 6\n\n";

    Site localsite;
    localsite.addSiteExtension(new LocalVipSiteExtension());

    vRef<Vobject> sphere = localsite.createVobjectA("sphere");
    vRef<Vobject> tertius = localsite.createVobjectA("tertius");
    vRef<Vobject> quartus = localsite.createVobject<Property>("quartus");
    vRef<Vobject> quintus = localsite.createVobjectA("quintus");
    vRef<Vobject> sextus = localsite.createVobjectA("sextus");
    vRef<Vobject> septimus = localsite.createVobjectA("septimus");

    sphere->insertChild(-1, "position", tertius);
    sphere->insertChild(-1, "orientation", quartus);


    /* This adds the listener.  Whenever the child list for "sphere"
       changes, the TutorialChildListener class will be called.  Also
       note that when you add a listener, it will immediately be
       called with notifyChildInserted() for each child the Vobject
       currently has.
     */
    sphere->addChildListener(new TutorialChildListener());


    // Mess around with sphere's child list.  This is the same
    // sequence of actions from tutorial 4.

    sphere->insertChild(-1, "radius", quintus);
    sphere->insertChild(-1, "position", quartus);
    sphere->insertChild(2, "color", sextus);
    sphere->setChild(4, "mass", septimus);
    sphere->removeChild(sphere->findChild(1));
    sphere->removeChild(sphere->findChild(-1));

    /* You may use listeners on both local and remote Vobjects. When
       you are set up as a listener for the children of a remote
       vobject, that vobject's child list is cached and considered
       "hot" because any changes to the child list are automatically
       pushed to listeners.  This means that calls to methods like
       Vobject::getChildren() will use the cached copy and not have to
       access the network.  This can be a significant performance win
       for certain applications. */


    // Property listeners work similarly to child listeners.  The
    // listener will be called immediately when first added with the
    // initial value of the property, and the called as further
    // updates happen (from a call to write() or replace()).

    vRef<Property> positionproperty = meta_cast<Property>(quartus);

    positionproperty->addPropertyListener(new TutorialPropertyListener());

    positionproperty->replace("1 2 3", "list: float");

    positionproperty->write(2, "4");

    /* Be aware that event notification callbacks will happen in a
       separate thread!  This has the advantage that it doesn't
       interrupt the main thread, but you will need to lock any data
       structures that may be concurrently accessed.  You also need to
       be careful not to stall the task queue (discussed in another
       tutorial).  All VOS classes are threadsafe unless noted
       otherwise (the primary exceptions are vRef<> and the various
       Iterators).
    */

    sleep(1);
}