oaSession.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaSession.h
//
// This file contains the definition for the oaSession class and its public
// supporting classes. The oaSession class implements a session database. This
// is a non-persistent database which is used as a parent for session-wide
// information.
//
// A session database is automatically created and maintained as needed by the
// OA implementation. There is only one session database per OA session.
//
// *****************************************************************************
// 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-2010 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaSession_P)
#define oaSession_P



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



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaAppObjectDef;
class oaConstraintParamDef;
class oaConstraintDef;
class oaGroupDef;
class oaConstraintGroupDef;



// *****************************************************************************
// oaThreadUseModel
// *****************************************************************************
class OA_BASE_DLL_API oaThreadUseModel {
public:
                            oaThreadUseModel(oaThreadUseModelEnum valueIn);
                            oaThreadUseModel(const oaString &name);
                            ~oaThreadUseModel();

    const oaString          &getName() const;
    operator                oaThreadUseModelEnum() const;

private:
    static const oaString   *initNames();
    oaThreadUseModelEnum    value;
};



// *****************************************************************************
// oaSession
// *****************************************************************************
class OA_BASE_DLL_API oaSession : public oaSessionObject {
public:
    oaUInt8                                         calcVMSize() const;
    void                                            minimizeVM();

    oaCollection<oaAppDef, oaSession>               getAppDefs();
    oaCollection<oaAppObjectDef, oaSession>         getAppObjectDefs();
    oaCollection<oaConstraintParamDef, oaSession>   getConstraintParamDefs() const;
    oaCollection<oaConstraintDef, oaSession>        getConstraintDefs() const;
    oaCollection<oaDerivedLayerParamDef, oaSession> getDerivedLayerParamDefs() const;
    oaCollection<oaDerivedLayerDef, oaSession>      getDerivedLayerDefs() const;
    oaCollection<oaGroupDef, oaSession>             getGroupDefs() const;
    oaCollection<oaConstraintGroupDef, oaSession>   getConstraintGroupDefs() const;

    void                                            setThreadUseModel(oaThreadUseModel  useModelIn);
    oaThreadUseModel                                getThreadUseModel() const;

    static oaSession                                *get();
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaSession> {
public:
    typedef oaSessionObject parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacSessionType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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