oaMutex.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaMutex.h
//
// This file contains the definitions for the oaMutexBase, oaMutex and 
// derived classes.
//
// oaMutex:
//  This is an abstract base class for the oaMutex lock object which defines
//  the common interfaces for the lock object.
//
// oaSpinMutex:
//  This is an abstract base class for the oaSpinMutex object which defines
//  the common interfaces for a spin lock object.
//  
// oaRWLock:
//  This is an abstract base class for the oaRWLock object which defines
//  the common interfaces for a read/write lock object.
//
// *****************************************************************************
// 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 2003-2008 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaMutexPvt_P)
#define oaMutexPvt_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseTypes.h"



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



// *****************************************************************************
// oaMutexBase
// *****************************************************************************
class OA_BASE_DLL_PVT oaMutexBase {
public:
    virtual oaBoolean       isLockEnabled() const = 0;
    virtual void            setLockEnabled(oaBoolean onOrOff) = 0;

    virtual oaUInt8         calcVMSize() const = 0;

protected:
    virtual                 ~oaMutexBase();
};



// *****************************************************************************
// oaMutex
// *****************************************************************************
class OA_BASE_DLL_PVT oaMutex : virtual public oaMutexBase {
public:
    virtual void            lock() = 0;
    virtual void            unlock() = 0;

protected:
                            oaMutex();
    virtual                 ~oaMutex();

                            oaMutex(const oaMutex &src);
    oaMutex                 &operator=(const oaMutex &src);
};



// *****************************************************************************
// oaSpinMutex
// *****************************************************************************
class OA_BASE_DLL_PVT oaSpinMutex : virtual public oaMutexBase {
public:
    virtual void            lock() = 0;
    virtual void            unlock() = 0;

protected:
                            oaSpinMutex();
    virtual                 ~oaSpinMutex();

                            oaSpinMutex(const oaSpinMutex &src);
    oaSpinMutex             &operator=(const oaSpinMutex &src);
};



// *****************************************************************************
// oaRWLock
// *****************************************************************************
class OA_BASE_DLL_PVT oaRWLock : virtual public oaMutexBase {
public:
    enum oaRWLockTypeEnum {
        oacWriteLockTypeEnum    = 0,
        oacReadLockTypeEnum     = 1
    };

    virtual void            lock(oaRWLockTypeEnum type) = 0;
    virtual void            unlock(oaRWLockTypeEnum type) = 0;

protected:
                            oaRWLock();
    virtual                 ~oaRWLock();

                            oaRWLock(const oaRWLock &src);
    oaRWLock                &operator=(const oaRWLock &src);
};



END_OA_NAMESPACE

#endif

Return to top of page

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