sdAttribute.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// sdAttribute.h
//
// This file contains the definitions for the following classes.
//
//  sdAttributeActionType
//      This class is a wrapper around sdAttributeActionTypeEnum. The
//      sdAttributeActionTypeEnum enum defines the various actions that can be
//      performed on an attribute.
// 
//  sdAttributeContainerType 
//      This class is a wrapper around the sdAttributeContainerTypeEnum values.
//      The enum values of sdAttributeContainerTypeEnum define the different
//      ways an attribute can be returned.
//
//  sdAttribute
//      This class represents an attribute of an object in a schema. 
//
// *****************************************************************************
// 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(sdAttribute_P)
#define sdAttribute_P



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



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class sdObject;
class sdValue;



// *****************************************************************************
// sdAttributeActionTypeEnum
// *****************************************************************************
#define sdvNumAttributeActionTypes 4

enum sdAttributeActionTypeEnum {
    sdcGetAttributeActionType   = 1,
    sdcSetAttributeActionType   = 2,
    sdcUnsetAttributeActionType = 4,
    sdcInitAttributeActionType  = 8
};



// *****************************************************************************
// sdAttributeContainerTypeEnum
// *****************************************************************************
#define sdvNumAttributeContainerTypes 3

enum sdAttributeContainerTypeEnum {
    sdcSingleAttributeContainerType     = 0,
    sdcArrayAttributeContainerType      = 1,
    sdcCollectionAttributeContainerType = 2
};



// *****************************************************************************
// sdAttributeActionType
// *****************************************************************************
class SD_DLL_API sdAttributeActionType {
public:         
                                sdAttributeActionType(sdAttributeActionTypeEnum action);
                                sdAttributeActionType(const std::string &name);
                                ~sdAttributeActionType();

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

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

    sdAttributeActionTypeEnum   m_value;

    static const std::string    *s_names;
};



// *****************************************************************************
// sdAttributeContainerType
// *****************************************************************************
class SD_DLL_API sdAttributeContainerType {
public:         
                                    sdAttributeContainerType(sdAttributeContainerTypeEnum container);
                                    sdAttributeContainerType(const std::string &name);
                                    ~sdAttributeContainerType();

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

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

    sdAttributeContainerTypeEnum    m_value;

    static const std::string        *s_names;
};



// *****************************************************************************
// sdAttribute
// *****************************************************************************
class SD_DLL_API sdAttribute : public sdBase {
public:
    typedef std::vector<sdAttributeActionType>  Actions;
    typedef Actions::const_iterator             ActionConstIter;

                                                sdAttribute(unsigned int                id,
                                                            const std::string           &name,
                                                            const std::string           &description,
                                                            const Actions               &actions,
                                                            sdAttributeContainerType    containerType,
                                                            bool                        isObjectIdentifier,
                                                            sdNameSpace                 *nameSpace,
                                                            const sdObject              *object,
                                                            const sdValue               *value);

    virtual                                     ~sdAttribute();

    unsigned int                                getId() const;
    const std::string                           &getName() const;
    const std::string                           &getDescription() const;
    const sdObject                              *getObject() const;
    const sdValue                               *getValue() const;
    ActionConstIter                             begin() const;
    ActionConstIter                             end() const;

    sdAttributeContainerType                    getContainerType() const;

    virtual void                                accept(sdVisitor *visitor);

private:
    const unsigned int                          m_id;
    const std::string                           &m_name;
    const std::string                           m_description;
    const Actions                               m_actions;

    const sdAttributeContainerTypeEnum          m_containerType;

    const sdObject                              *m_object;
    const sdValue                               *m_value;
};



END_SD_NAMESPACE

#endif

Return to top of page

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