oaSessionObject.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaSessionObject.h
//
// This file contains the definition for the oaSessionObject class. This is an
// abstract class that is the base for all OpenAccess session objects.
//
// The oaSession database is a VM-only database which serves as a parent to
// session objects: transient objects which are valid across the entire OA
// session.
//
// These session objects may have a persistent representation. In some cases,
// the session objects represent information that is a superset of information
// compiled from the databases which are opened in the OA session.
//
// It is not legal to create properties or appDefs on session objects, nor is
// it legal to add these objects to groups.
// *****************************************************************************
// 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-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaSessionObject_P)
#define oaSessionObject_P



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



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaSession;



// *****************************************************************************
// oaSessionDataTypeEnum
//
// The first entry is a special datatype that is used for the database itself.
// The next six entries are reserved and are common to all databases. They are
// only included for compatibility with other databases. AppDefs, properties
// and groups are illegal on a session database. avatars are not implemented
// on session databases.
//
// Session object tables are dynamically registered on the session database as
// needed, therefore these dataTypes are not pre-defined, but rather dynamically
// allocated.
//
// Note: the number of datatypes should not include the special datatype:
// oacDMSessionDataType.
// *****************************************************************************
#define oavNumSessionDataTypes      23
#define oavNumNewSessionDataTypes   6

enum oaSessionDataTypeEnum {
    oacSessionDataType                      = UINT_MAX,
    oacSessionAppObjectDataType             = UINT_MAX - 1,
    oacSessionPropDataType                  = 0,
    oacSessionGroupDataType                 = 1,
    oacSessionGroupMemDataType              = 2,
    oacSessionAvatarDataType                = 3,
    oacSessionValueDataType                 = 4,
    oacSessionConstraintParamDefDataType    = 5,
    oacSessionConstraintParamDataType       = 6,
    oacSessionConstraintDefDataType         = 7,
    oacSessionConstraintDataType            = 8,
    oacSessionConstraintGroupDataType       = 9,
    oacSessionConstraintGroupMemDataType    = 10,
    oacSessionConstraintGroupHeaderDataType = 11,
    oacLibDefListDataType                   = 12,
    oacLibDefListMemDataType                = 13,
    oacViewTypeDataType                     = 14,
    oacAppDefDataType                       = 15,
    oacAppObjectDefDataType                 = 16,

    oacSessionFeatureDataType               = 17,
    oacSessionFeaturePolicyDataType         = 18,
    oacSessionDerivedLayerParamDefDataType  = 19,
    oacSessionDerivedLayerDefDataType       = 20,
    oacSessionGroupDefDataType              = 21,
    oacSessionConstraintGroupDefDataType    = 22
};



// *****************************************************************************
// oaSessionObject
// *****************************************************************************
class OA_BASE_DLL_API oaSessionObject : public oaObject {
public:
    oaSession               *getSession() const;
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaSessionObject> {
public:
    typedef oaObject        parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacBaseDBType};
    enum {abstractTypeEnumVal = oacSessionObjectType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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