sdValue.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// sdValue.h
//
// This file contains the definitions for the following classes.
//
//  sdValueSubType
//      This class is a wrapper class for the enumeration sdValueSubTypeEnum.
//
//  sdValue
//      This class represents the value of an attribute. The value can be a POD
//      type or a composite type.
// 
//  sdLeafValue
//      This represents a POD value type of an attribute.
//  
//  sdField
//      This class represents an individual field of an attribute value which is
//      a composite type.
//
//  sdHierValue
//      This represents a composite value type of an attribute.
//
// *****************************************************************************
// 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(sdValue_P)
#define sdValue_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include <vector>
#include "sdBase.h"



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



// *****************************************************************************
// sdValueSubTypeEnum
// *****************************************************************************
#define sdvNumValueSubTypes 2

enum sdValueSubTypeEnum {
    sdcLeafValueSubType = 0,
    sdcHierValueSubType = 1
};



// *****************************************************************************
// sdValueSubType
// *****************************************************************************
class SD_DLL_API sdValueSubType {
public:         
                                sdValueSubType(sdValueSubTypeEnum value);
                                sdValueSubType(const std::string &name);
                                ~sdValueSubType();

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

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

    sdValueSubTypeEnum          m_value;

    static const std::string    *s_names;
};



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

    unsigned int            getId() const;
    const std::string       &getName() const;
    const std::string       &getDescription() const;
    sdValueSubType          getSubType() const;

protected:
                            sdValue(unsigned int        id,
                                    const std::string   &name,
                                    const std::string   &description,
                                    sdValueSubType      subType,
                                    sdNameSpace         *nameSpace);

private:
    const unsigned int      m_id;
    const std::string       &m_name;
    const std::string       m_description;
    const sdValueSubType    m_subType;
};



// *****************************************************************************
// sdLeafValue
// *****************************************************************************
class SD_DLL_API sdLeafValue : public sdValue {
public:
                            sdLeafValue(unsigned int        id,
                                        const std::string   &name,
                                        const std::string   &description,
                                        sdNameSpace         *nameSpace);
    virtual                 ~sdLeafValue();

    virtual void            accept(sdVisitor *visitor);
};



// *****************************************************************************
// sdField
// *****************************************************************************
class SD_DLL_API sdField {
public:         
                            sdField(const std::string   &name,
                                    unsigned int        index,
                                    sdNameSpace         *nameSpace,
                                    const sdValue       *value);
                            ~sdField();

    const std::string       &getName() const;
    unsigned int            getIndex() const;
    const sdNameSpace       *getNameSpace() const;
    const sdValue           *getValue() const;

private:
    const std::string       &m_name;
    const unsigned int      m_index;
    const sdNameSpace       *m_nameSpace;
    const sdValue           *m_value;
};



// *****************************************************************************
// sdHierValue
// *****************************************************************************
class SD_DLL_API sdHierValue : public sdValue {
public:         
    typedef std::vector<sdField*>       FieldVector;
    typedef FieldVector::const_iterator FieldConstIter;

                                        sdHierValue(unsigned int        id,
                                                    const std::string   &name,
                                                    const std::string   &description,
                                                    sdNameSpace         *nameSpace,
                                                    const FieldVector   &fields);
    virtual                             ~sdHierValue();

    FieldConstIter                      begin() const;
    FieldConstIter                      end() const;

    virtual void                        accept(sdVisitor *visitor);

private:
    const FieldVector                   m_fields;
};



END_SD_NAMESPACE

#endif

Return to top of page

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