oaVCObserver.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaVCObserver.h
//
// This file contains the definition for the oaVCObserver and assiciated
// classes.
//
// oaVCOperationEnum
// oaVCMessageTypeEnum
// oaVCObserverResultEnum
// oaVCOperation
// oaVCMessageType
// oaVCObserverResult
// oaVCObserver
// oaVCObserverCollection
// oaVCObserverIter
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2008 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaVCObserver_P)
#define oaVCObserver_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaObserver.h"
#include "oaDMObject.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// oaVCOperation
// *****************************************************************************
class OA_DM_DLL_API oaVCOperation {
public:
                            oaVCOperation(oaVCOperationEnum valueIn);
                            oaVCOperation(const oaString &name);
                            ~oaVCOperation();

    const oaString          &getName() const;

                            operator                oaVCOperationEnum() const;

private:
    oaVCOperationEnum       value;

    static const oaString   names[];
};



// *****************************************************************************
// oaVCMessageType
// *****************************************************************************
class OA_DM_DLL_API oaVCMessageType {
public:
                            oaVCMessageType(oaVCMessageTypeEnum valueIn);
                            oaVCMessageType(const oaString &name);
                            ~oaVCMessageType();

    const oaString          &getName() const;

                            operator                oaVCMessageTypeEnum() const;

private:
    oaVCMessageTypeEnum     value;

    static const oaString   names[];
};



// *****************************************************************************
// oaVCObserverResult
// *****************************************************************************
class OA_DM_DLL_API oaVCObserverResult {
public:
                            oaVCObserverResult(oaVCObserverResultEnum valueIn);
                            oaVCObserverResult(const oaString &name);
                            ~oaVCObserverResult();

    const oaString          &getName() const;

                            operator                oaVCObserverResultEnum() const;

private:
    oaVCObserverResultEnum  value;

    static const oaString   names[];
};



// *****************************************************************************
// oaVCObserver
// *****************************************************************************
class OA_DM_DLL_API oaVCObserver : public oaBaseObserver {
public:
                                oaVCObserver(oaUInt4    priorityIn,
                                             oaBoolean  enabledIn = true);
    virtual                     ~oaVCObserver();


    virtual void                onVCPlugInLoad(const oaString &plugInName);

    virtual oaVCObserverResult  onVCMessageOut(const oaString   &plugInName,
                                               oaDMObject       *object,
                                               oaVCOperation    operation,
                                               oaVCMessageType  msgType,
                                               const oaString   &text);


    static void                 invokeVCPlugInLoad(const oaString &plugInName);

    static oaVCObserverResult   invokeVCMessageOut(const oaString   &plugInName,
                                                   oaDMObject       *object,
                                                   oaVCOperation    operation,
                                                   oaVCMessageType  msgType,
                                                   const oaString   &text);

private:
    oaVCObserver                *next;

    static oaVCObserver         *first;

    friend class oaVCObserverCollectionPvt;
};



// *****************************************************************************
// oaVCObserverCollection
// *****************************************************************************
class OA_DM_DLL_API oaVCObserverCollection : public oaObserverCollectionBase {
public:
                            oaVCObserverCollection();
                            oaVCObserverCollection(const oaVCObserverCollection &copy);
    virtual                 ~oaVCObserverCollection();

    oaVCObserverCollection  &operator=(const oaVCObserverCollection &rhs);

    friend class oaVCObserverIter;
};



// *****************************************************************************
// oaVCObserverIter
// *****************************************************************************
class OA_DM_DLL_API oaVCObserverIter : public oaObserverIterBase {
public:
                            oaVCObserverIter(const oaVCObserverCollection &coll);
                            oaVCObserverIter(const oaVCObserverIter &copy);
    virtual                 ~oaVCObserverIter();

    oaVCObserverIter        &operator=(const oaVCObserverIter &rhs);
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.