INodePrivate.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  MargretAlbrecht
//  $Header$
//
//  License: This file is published under the license of the EMVA GenICam  Standard Group.
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'.
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
//
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD  GROUP
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL,
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  LIMITED TO,
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  DATA, OR PROFITS;
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#ifndef GENAPI_INODEPRIVATE_H
#define GENAPI_INODEPRIVATE_H

#include "../GenApiDll.h"
#include "../Types.h"
#include "../INode.h"
#include "../INodeMap.h"
#include "NodeMapData/NodeData.h"

#include <vector>
#include <set>
#include <list>

struct NodeID_t;
class CProperty;

namespace GENAPI_NAMESPACE
{
    //*************************************************************
    // INodePrivate interface
    //*************************************************************

    GENICAM_INTERFACE INodePrivate;
    GENICAM_INTERFACE INodeMapPrivate;

    typedef std::vector< INodePrivate* > NodePrivateVector_t;

    GENICAM_INTERFACE GENAPI_DECL_ABSTRACT INodePrivate : public INode
    {
        /**** Methods to create nodes ****/

        virtual void Initialize(GENAPI_NAMESPACE::INodeMapPrivate* const pNodeMap, CNodeData::ENodeType_t NodeType, NodeID_t &NodeID) = 0;

        virtual CNodeData::ENodeType_t GetNodeType() = 0;

        virtual NodeID_t GetNodeID() = 0;

        virtual void FinalConstruct() = 0;

        virtual void SetProperty(CProperty &Property) = 0;

        // BEWARE: PropertyLsit contains pointers to CProperty objects on the heap. the caller is responsible for deleting them
        //         e.g. by calling CNodeData::FreePropertiesList( PropertyList )
        virtual bool GetProperty(CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const = 0;

        /**** Methods to handle callbacks ****/

        enum ESetInvalidMode
        {
            simOnlyMe,  
            simAll,  
            simDependentsAfterWrite, // !< Invalidate all of its dependents but not itself after a write of a terninal node
            simDependents // !< Invalidate all of its dependents but not itself
        };

        virtual void SetInvalid(ESetInvalidMode simMode) = 0;

        virtual void CollectCallbacksToFire(std::list<CNodeCallback*> &CallbacksToFire, bool allDependents = false) = 0;

        virtual bool IsTerminalNode() const = 0;
        
        virtual void GetTerminalNodes(NodeList_t &) const = 0;


        virtual bool Poll( int64_t ElapsedTime ) = 0;

    };


}

#endif // ifndef GENAPI_INODEPRIVATE_H