MOT_CloneData.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        MOT_CloneData.h
 *
 * COMMENTS:
 *
 */

#ifndef __MOT_CLONEDATA_H__
#define __MOT_CLONEDATA_H__

#include "MOT_API.h"

class MOT_CloneMessage;
class MOT_ConfigureMessage;
class MOT_HipFileMessage;

class MOT_API MOT_CloneData
{
public:
                             MOT_CloneData();
    virtual                 ~MOT_CloneData();

    // Based on the configure specified in the hip file message (which
    // is used to establish a new connection and initialize the replica hip
    // file contents), create a new CloneData object of an appropriate
    // subclass.
    static MOT_CloneData    *createCloneData();

    // Update the configuration of the data object from the options on the
    // message and/or the extra data. This function is called with the
    // initial hip file message, but may also be called with other messages
    // that arive later. This configuration may include which node to use
    // as the data source, a choice of camera, image plane, etc.
    virtual bool             configure(const MOT_ConfigureMessage &msg) = 0;

    // Begins or restarts the creation of the requested data based on the
    // supplied configuration and the current state of the hip file. This
    // method will be called any time a change is made to a node.
    virtual bool             startDataCreation() = 0;

    // Return true if the work started by the most recent startDataCreation
    // call has been completed. In some cases, where the data creation is
    // completely synchronous, this method may simply return true all the
    // time.
    virtual bool             isDataCreationComplete() = 0;

    // Get the current state of the data. If startDataCreation is not
    // synchronous, this method may be called before the data generation
    // is complete. Return true if either the completed data or some
    // intermediate data is put into the message, or false if the message
    // has not been filled.
    virtual bool             getData(MOT_CloneMessage &rmsg) = 0;
};

#endif // __MOT_CLONEDATA_H__