oaOccAssignment.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccAssignment.h
//
// The oaOccAssignment class is the base class for occurrences of all types of
// assignments. The oaOccAssignment object specifies the value to be interpreted
// interpreted as the replacement (or "assignment") of the data specified in
// an oaOccNetConnectDef or oaOccTermConnectDef object that may exist in the
// occurrence view of the design hierarchy.
//
// The derived classes include:
//
//  oaOccAssignValue
//      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 oaOccNetConnectDef or oaOccTermConnectDef
//      objects found in the occurrence view of the design hierarchy.
//
//  oaOccAssignAssignment
//      This class implements an assignment that has an assignmentDef as
//      its value. 
//
// Applications knowing how to traverse the occurrence hierarchy can search for
// an oaOccAssignment on an instance and use the defined value. If no assignment
// is found, the default name specified on the assignmentDef on the
// corresponding oaOccConnectDef object is to be used. If an oaOccAssignValue is
// found, it specifies the name of the net to use with the oaOccConnectDef. If
// an oaOccAssignAssignment is found, the traversal is to continue looking up
// the occurrence hierarchy using the assignmentDef of the
// oaOccAssignAssignment.
//
// *****************************************************************************
// 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(oaOccAssignment_P)
#define oaOccAssignment_P



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



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



// *****************************************************************************
// oaOccAssignment
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccAssignment : public oaOccObject {
public:
    static oaOccAssignment  *find(const oaOccInst   *inst,
                                  const oaString    &name);

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

    enum {dtIndex = oacAssignmentDataType};
};



// *****************************************************************************
// oaOccAssignValue
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccAssignValue : public oaOccAssignment {
public:
    void                    getValue(oaSimpleName &netName) const;
};



// *****************************************************************************
// oaOccAssignAssignment
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccAssignAssignment : public oaOccAssignment {
public:
    void                    getAssignmentDef(oaAssignmentDef &aDef) const;
};



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

template<>
class oaTraits<oaOccAssignValue> {
public:
    typedef oaAssignmentModTypeEnum modTypeType;
    typedef oaOccAssignment         parentType;
    enum {dtIndex = oacAssignmentDataType};
    enum {dataTypeEnumVal = oacAssignmentDataType};
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccAssignValueType};
};

template<>
class oaTraits<oaOccAssignAssignment> {
public:
    typedef oaAssignmentModTypeEnum modTypeType;
    typedef oaOccAssignment         parentType;
    enum {dtIndex = oacAssignmentDataType};
    enum {dataTypeEnumVal = oacAssignmentDataType};
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccAssignAssignmentType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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