oaViaTopology.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaViaTopology.h
//
// This file contains the definitions for the oaViaTopology class and its
// associated classes.
//
//  oaViaTopologyType
//      This is the wrapper class for oaViaTopologyTypeEnum.
//
//  oaViaTopology
//      This utility class represents a bound or unbound oaViaDef or
//      oaViaVariant. It is used to create an oaViaTopologyArray, which is used
//      to create an oaViaTopologyArrayValue.
//
// *****************************************************************************
// 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaViaTopology_P)
#define oaViaTopology_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaViaVariant.h"



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



// *****************************************************************************
// oaViaTopologyTypeEnum
// *****************************************************************************
#define oavNumViaTopologyTypes     2

enum oaViaTopologyTypeEnum {
    oacViaVariantTopologyType   = 0,
    oacViaDefTopologyType       = 1
};



// *****************************************************************************
// oaViaTopologyType
// *****************************************************************************
class OA_TECH_DLL_API oaViaTopologyType {
public:
                            oaViaTopologyType(oaViaTopologyTypeEnum valueIn);
                            oaViaTopologyType(const oaString &name);
                            ~oaViaTopologyType();

    const oaString          &getName() const;
                            operator                oaViaTopologyTypeEnum() const;

private:
    static const oaString   *initNames();

    oaViaTopologyTypeEnum   value;

    static const oaString   *names;
};



// *****************************************************************************
// oaViaTopology
// *****************************************************************************
class OA_TECH_DLL_API oaViaTopology {
public:
                            oaViaTopology();
                            oaViaTopology(oaViaDef *viaDefIn);
                            oaViaTopology(oaViaVariant *viaVariantIn);
                            ~oaViaTopology();

    void                    init(oaViaDef *viaDefIn);
    void                    init(oaViaVariant *viaVariantIn);
    void                    init(const oaString     &topologyName,
                                 oaObject           *ownerDB,
                                 oaViaTopologyType  typeIn);

    void                    getName(oaString &name) const;
    const oaObject          *getOwner() const;
    oaViaDef                *getViaDef() const;
    oaViaVariant            *getViaVariant() const;
    oaViaTopologyType       getType() const;

    oaBoolean               operator==(const oaViaTopology &viaTopology);
    oaBoolean               operator!=(const oaViaTopology &viaTopology);
    oaBoolean               operator==(const oaViaTopology &viaTopology) const;
    oaBoolean               operator!=(const oaViaTopology &viaTopology) const;

private:
    union {
        oaViaDef            *viaDef;
        oaViaVariant        *viaVariant;
    };

    oaObject                *owner;
    oaString                name;
    oaViaTopologyType       type;
};



// *****************************************************************************
// oaViaTopologyArray
// *****************************************************************************
class OA_TECH_DLL_API oaViaTopologyArray : public oaArray<oaViaTopology> {
public:
                            oaViaTopologyArray(oaUInt4 size = 0);
                            oaViaTopologyArray(const oaViaTopologyArray &arrayIn);
};



END_OA_NAMESPACE

#endif

Return to top of page

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