oaCMAttr.h

Go to the documentation of this file.

// ****************************************************************************
// ****************************************************************************
// oaCMAttr.h
//
// This file contains the definitions of the oaCMAttr and oaCMAttrArray classes 
//
//  oaCMAttr
//      The oaCMAttr class defines an attribute. An attribute is a name and 
//      value pair. An attribue can have its value unset.
//
//  oaCMAttrArray
//      The oaCMAttrArray is an array of oaCMAttrs. The oaCMAttrArray class is 
//      used in the definition of the oaCMProtocol class.
//
// ****************************************************************************
// 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: 2010/08/09 $
//  $State: $
// ****************************************************************************
// ****************************************************************************



#if !defined(oaCMAttr_P)
#define oaCMAttr_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaArray.h"
#include "oaCMBaseTypes.h"



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



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



// ****************************************************************************
// oaCMAttr
// ****************************************************************************
class OA_CM_DLL_API oaCMAttr {
public:
                            oaCMAttr(const oaString &nameIn);
                            oaCMAttr(const oaString &nameIn,
                                     const oaString &valueIn);
                            oaCMAttr(const oaCMAttr &attrIn);

    const oaString          &getName() const;
    const oaString          &getValue() const;

    void                    setValue(const oaString &valueIn);

    oaCMAttr                &operator=(const oaCMAttr &rhs);
    oaBoolean               operator==(const oaCMAttr &rhs) const;
    oaBoolean               operator!=(const oaCMAttr &rhs) const;

    oaBoolean               isUnset() const;

private:
                            oaCMAttr();

    oaString                m_name;
    oaString                m_value;

    template <class T>
        friend class oaArrayBase;
    template <class T>
        friend class oaArray;
};



// ****************************************************************************
// oaCMAttrArray
// ****************************************************************************
class OA_CM_DLL_API oaCMAttrArray : public oaArray<oaCMAttr> {
public:
                            oaCMAttrArray(oaUInt4 sizeIn = 0);
                            oaCMAttrArray(const oaCMAttrArray &arrayIn);

    oaBoolean               hasUnsetAttrs() const;
    oaUInt4                 findByName(const oaString &nameIn) const;

    oaCMAttrArray           &operator=(const oaCMAttrArray &rhs);
};



END_OA_NAMESPACE

#endif

Return to top of page

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