oaView.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaView.h
//
// This file contains the definition for the oaView class and its public
// supporting classes. The oaView class implements an OpenAccess library view
// object. The public supporting classes include:
//
// oaReservedViewType
//
//      This enum wrapper class encapsulates the reserved viewTypes which are
// available. This class may be used to get a predefined viewType.
//
// oaViewType
//      This session object represents the type of a view. The viewType is
// represented by a string. There are 10 reserved viewTypes which represent OA
// databases: "maskLayout", "schematic", "schematicSymbol", "netlist", 
// "oaHierDesign", "wafer", "verilogAMSText", "VHDLAMSText", "verilogText", 
// "VHDLText", and "verilogAText".
//
// *****************************************************************************
// 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-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaView_P)
#define oaView_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaDMModTypes.h"
#include "oaLib.h"



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



// *****************************************************************************
// oaReservedViewTypeEnum
// *****************************************************************************
#define oavNumReservedViewTypes 16
#define oavNumDesignViewTypes   5

enum oaReservedViewTypeEnum {
    oacMaskLayout           = 0,
    oacSchematic            = 1,
    oacSchematicSymbol      = 2,
    oacNetlist              = 3,
    oacWafer                = 4,
    oacVerilogAMSText       = 5,
    oacVHDLAMSText          = 6,
    oacVerilogText          = 7,
    oacVHDLText             = 8,
    oacVerilogAText         = 9,
    oacHierDesign           = 10,
    oacSystemVerilogText    = 11,
    oacSPECTREText          = 12,
    oacSPICEText            = 13,
    oacHSPICEText           = 14,
    oacCDLText              = 15
};



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

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

private:
    static const oaString   *initNames();

    oaReservedViewTypeEnum  value;

    static const oaString   names[];
};



// *****************************************************************************
// oaViewType
// *****************************************************************************
class OA_DM_DLL_API oaViewType : public oaSessionObject {
public:
    static oaViewType                           *create(const oaString &name);
    static oaViewType                           *find(const oaString &name);
    static oaViewType                           *get(oaReservedViewType type);

    void                                        getName(oaString &name) const;

    static oaCollection<oaViewType, oaSession>  getViewTypes();
};



// *****************************************************************************
// oaView
// *****************************************************************************
class OA_DM_DLL_API oaView : public oaDMContainer {
public:
    static oaView                       *find(const oaLib           *lib,
                                              const oaScalarName    &name,
                                              const oaViewType      *viewType);
    static oaView                       *get(const oaLib        *lib,
                                             const oaScalarName &name,
                                             const oaViewType   *viewType);

    void                                destroy();

    void                                getName(oaScalarName &name) const;
    void                                getName(const oaNameSpace   &ns,
                                                oaString            &out) const;

    oaViewType                          *getViewType() const;

    oaCollection<oaCellView, oaView>    getCellViews() const;

    enum {dtIndex = oacViewDataType};
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaView> {
public:
    typedef oaDMContainer       parentType;
    typedef oaViewModTypeEnum   modTypeType;
    enum {dbType = oacLibDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacViewDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacViewType};
    enum {dataTypeEnumVal = oacViewDataType};
};

template<>
class oaTraits<oaViewType> {
public:
    typedef oaSessionObject parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacViewTypeDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacViewTypeType};
    enum {dataTypeEnumVal = oacViewTypeDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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