oaAssignment.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaAssignment.h
//
// This file contains the definition of the oaAssignment class, its derived
// classes, and its public supporting classes.
//
// The oaAssignment class is the base class for all types of assignments. The
// oaAssignment object specifies an assignment of the connectivity for a
// oaConnectDef object. The derived classes include:
//
//  oaAssignValue
//      This class implements an assignment that specifies the name of a
//      single-bit net to use as the replacement for the nets associated with
//      corresponding oaNetConnectDef or oaTermConnectDef connection definitions
//      found in the design hierarchy.
//
//  oaAssignAssignment
//      This class implements an assignment that specifies values that override
//      the assignment definition associated with a corresponding
//      oaNetConnectDef or oaTermConnectDef.
//
// Applications knowing how to traverse the connectivity hierarchy search for
// an oaAssignment on an instance and use it to resolve the connectivity
// associated with corresponding oaConnectDef objects. If an oaAssignValue is
// found, it specifies the net name to use for the nets and terminals with the
// corresponding connection definition. If an oaAssignAssignment is found, the
// application continues searching using the information in the found
// assignment. If no oaAssignment is found, the application uses the default
// net name specified in the oaConnectDef object.
//
// *****************************************************************************
// 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 2003-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaAssignment_P)
#define oaAssignment_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaInst.h"
#include "oaAssignmentDef.h"



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



// *****************************************************************************
// oaAssignmentAttrTypeEnum
// *****************************************************************************
#define oavNumAssignmentAttrTypes       1


enum oaAssignmentAttrTypeEnum {    oacNameAssignmentAttrType   = 0};



// *****************************************************************************
// oaAssignmentAttrType
// *****************************************************************************
class OA_DESIGN_DLL_API oaAssignmentAttrType : public oaAttrType {
public:
                                oaAssignmentAttrType(oaAssignmentAttrTypeEnum vIn);
                                oaAssignmentAttrType(const oaString &name);
                                oaAssignmentAttrType(oaAttrType attr);

    virtual const oaString      &getName() const;

    oaAssignmentAttrTypeEnum    getValue() const;

private:
    static const oaString       names[];
};



// *****************************************************************************
// oaAssignment
// *****************************************************************************
class OA_DESIGN_DLL_API oaAssignment : public oaBlockObject {
public:
    void                    destroy();

    static oaAssignment     *find(const oaInst      *inst,
                                  const oaString    &name);

    void                    getName(oaString &name) const;
    oaInst                  *getInst() const;

    void                    setName(const oaString &name);
    void                    setInst(oaInst *inst);

    enum {dtIndex = oacAssignmentDataType};
};



// *****************************************************************************
// oaAssignValue
// *****************************************************************************
class OA_DESIGN_DLL_API oaAssignValue : public oaAssignment {
public:
    static oaAssignValue    *create(const oaInst        *inst,
                                    const oaString      &name,
                                    const oaScalarName  &netName);
    static oaAssignValue    *create(const oaInst            *inst,
                                    const oaString          &name,
                                    const oaVectorBitName   &netName);

    void                    getValue(oaSimpleName &netName) const;

    void                    setValue(const oaScalarName &netName);
    void                    setValue(const oaVectorBitName &netName);
};



// *****************************************************************************
// oaAssignAssignment
// *****************************************************************************
class OA_DESIGN_DLL_API oaAssignAssignment : public oaAssignment {
public:
    static oaAssignAssignment   *create(const oaInst            *inst,
                                        const oaString          &name,
                                        const oaAssignmentDef   &aDef);

    void                        getAssignmentDef(oaAssignmentDef &aDef) const;

    void                        setAssignmentDef(const oaAssignmentDef &aDef);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaAssignment> {
public:
    typedef oaBlockObject           parentType;
    typedef oaAssignmentModTypeEnum modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {isMultiDomain = true};
    enum {dtIndex = oacAssignmentDataType};
    enum {dataTypeEnumVal = oacAssignmentDataType};
    enum {abstractTypeEnumVal = oacAssignmentType};
};

template<>
class oaTraits<oaAssignValue> {
public:
    typedef oaAssignmentModTypeEnum modTypeType;
    typedef oaAssignment            parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacAssignmentDataType};
    enum {dataTypeEnumVal = oacAssignmentDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAssignValueType};
};

template<>
class oaTraits<oaAssignAssignment> {
public:
    typedef oaAssignmentModTypeEnum modTypeType;
    typedef oaAssignment            parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacAssignmentDataType};
    enum {dataTypeEnumVal = oacAssignmentDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAssignAssignmentType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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