sdBase.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// sdBase.h
//
// This file contains the following class definitions.
//
//  sdObjectType
//      This is the wrapper class for sdObjectTypeEnum. sdObjectTypeEnum
//      defines the different types of sd objects that can be created.
//
//  sdBase
//      This class is the base class for schema definition classes that 
//      collectively define the schema of a system.
//
// *****************************************************************************
// 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 2007 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2007/03/20 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(sdBase_P)
#define sdBase_P



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



// *****************************************************************************
// Declare and define types in the schema definition namespace.
// *****************************************************************************
BEGIN_SD_NAMESPACE



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class sdNameSpace;
class sdVisitor;



// *****************************************************************************
// sdObjectTypeEnum
// *****************************************************************************
#define sdvNumObjectTypes       4

enum sdObjectTypeEnum {
    sdcValueObjectType          = 0,
    sdcAttributeObjectType      = 1,
    sdcRelationshipObjectType   = 2,
    sdcObjectObjectType         = 3
};



// *****************************************************************************
// sdObjectType
// *****************************************************************************
class SD_DLL_API sdObjectType {
public:         
                                sdObjectType(sdObjectTypeEnum valueType);
                                sdObjectType(const std::string &name);
                                ~sdObjectType();

    const std::string           &getName() const;
                                operator                    sdObjectTypeEnum() const;

private:
    static const std::string    *initNames();

    sdObjectTypeEnum            m_value;

    static const std::string    *s_names;
};



// *****************************************************************************
// sdBase
// *****************************************************************************
class SD_DLL_API sdBase {
public:         
    virtual                 ~sdBase();

    sdObjectType            getObjectType() const;
    const sdNameSpace       *getNameSpace() const;

    virtual void            accept(sdVisitor *visitor) = 0;

protected:
                            sdBase(sdObjectType objectType,
                                   sdNameSpace  *nameSpace);
private:
    const sdObjectType      m_objectType;
    const sdNameSpace       *m_nameSpace;
};



END_SD_NAMESPACE

#endif

Return to top of page

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