oaModAssignment.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModAssignment.h
//
// The oaModAssignment class is the base class for all types of logical
// assignments. The oaModAssignment object specifies the value to be
// interpreted as the replacement (or "assignment") of the data specified in
// an oaModNetConnectDef or oaModTermConnectDef object that may exist in a
// logical design hierarchy.
//
// The derived classes include:
//
//  oaModAssignValue
//      This class implements an assignment that specifies the name of a
//      single-bit, explicit net to use as logical replacements for the nets
//      associated with corresponding oaNetConnectDefs or oaTermConnectDefs
//      found in the logical design hierarchy.
//
//  oaModAssignAssignment
//      This class implements an assignment that has an assignmentDef as
//      its value. 
//
// Applications knowing how to traverse the logical hierarchy can search for an
// oaModAssignment on an instance and use the defined value. If no assignment
// is found, the default name specified on the assignmentDef on the
// corresponding oaConnectDef object is to be used. If an oaModAssignValue is
// found, it specifies the name of the net to use with the oaConnectDef. If
// an oaModAssignAssignment is found, the traversal is to continue looking up
// the logical hierarchy using the assignmentDef of the oaAssignAssignment.
//
// *****************************************************************************
// 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(oaModAssignment_P)
#define oaModAssignment_P



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



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



// *****************************************************************************
// oaModAssignment
// *****************************************************************************
class OA_DESIGN_DLL_API oaModAssignment : public oaModObject {
public:
    void                    destroy();

    static oaModAssignment  *find(const oaModInst   *inst,
                                  const oaString    &name);

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

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

    enum {dtIndex = oacAssignmentDataType};
};



// *****************************************************************************
// oaModAssignValue
// *****************************************************************************
class OA_DESIGN_DLL_API oaModAssignValue : public oaModAssignment {
public:
    static oaModAssignValue *create(const oaModInst     *inst,
                                    const oaString      &name,
                                    const oaScalarName  &netName);
    static oaModAssignValue *create(const oaModInst         *inst,
                                    const oaString          &name,
                                    const oaVectorBitName   &netName);

    void                    getValue(oaSimpleName &netName) const;

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



// *****************************************************************************
// oaModAssignAssignment
// *****************************************************************************
class OA_DESIGN_DLL_API oaModAssignAssignment : public oaModAssignment {
public:
    static oaModAssignAssignment    *create(const oaModInst         *inst,
                                            const oaString          &name,
                                            const oaAssignmentDef   &aDef);

    void                            getAssignmentDef(oaAssignmentDef &aDef) const;

    void                            setAssignmentDef(const oaAssignmentDef &aDef);
};



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

template<>
class oaTraits<oaModAssignValue> {
public:
    typedef oaAssignmentModTypeEnum modTypeType;
    typedef oaModAssignment         parentType;
    enum {dtIndex = oacAssignmentDataType};
    enum {dataTypeEnumVal = oacAssignmentDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModAssignValueType};
};

template<>
class oaTraits<oaModAssignAssignment> {
public:
    typedef oaAssignmentModTypeEnum modTypeType;
    typedef oaModAssignment         parentType;
    enum {dtIndex = oacAssignmentDataType};
    enum {dataTypeEnumVal = oacAssignmentDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModAssignAssignmentType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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