oaCMProtocol.h

Go to the documentation of this file.

// ****************************************************************************
// ****************************************************************************
// oaCMProtocol.h
//
// This file contains the definitions of the oaCMProtocol and oaCMProtocolArray 
// classes 
//
//  oaCMProtocol
//      The oaCMProtocol class defines a specific protocol. A protocol has a 
//      name, plug-in name, an array of fixed attributes and an array of 
//      modifiable attributes.
//
//  oaCMProtocolArray
//      The oaCMProtocolArray is an array of oaCMProtocols. A oaCMProtocolArray
//      generally represents the array of oaCMProtocols supported by a plug-in
//      from which the application can choose one.
//
// ****************************************************************************
// 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(oaCMProtocol_P)
#define oaCMProtocol_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaString.h"
#include "oaCMAttr.h"



// *****************************************************************************
// Define names in the OA namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// ****************************************************************************
// oaCMProtocol
// ****************************************************************************
class OA_CM_DLL_API oaCMProtocol {
public:
                            oaCMProtocol();
                            oaCMProtocol(const oaString &nameIn,
                                         const oaString &plugInNameIn);
                            oaCMProtocol(const oaString         &nameIn,
                                         const oaString         &plugInNameIn,
                                         const oaCMAttrArray    &fixedAttrsIn,
                                         const oaCMAttrArray    &modAttrsIn);
                            oaCMProtocol(const oaCMProtocol &protocolIn);

    const oaString          &getName() const;
    const oaString          &getPlugInName() const;
    const oaCMAttrArray     &getFixedAttrs() const;
    const oaCMAttrArray     &getModAttrs() const;

    void                    setFixedAttrs(const oaCMAttrArray &arrayIn);
    void                    setModAttrs(const oaCMAttrArray &arrayIn);

    oaBoolean               hasUnsetAttrs() const;
    oaBoolean               match(const oaCMProtocol &protoIn) const;

    const oaCMAttr          *findAttr(const oaString &name) const;

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

private:
    oaString                m_name;
    oaString                m_plugInName;
    oaCMAttrArray           m_fixedAttrs;
    oaCMAttrArray           m_modAttrs;
};



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

    oaUInt4                 findByName(const oaString   &nameIn,
                                       const oaString   &plugInNameIn) const;
    oaBoolean               validate(const oaCMProtocol &protoIn) const;

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



END_OA_NAMESPACE

#endif

Return to top of page

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