oaTextDisplay.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaTextDisplay.h
//
// This file contains the definitions for the oaTextDisplay class and its
// subclasses oaPropDisplay, oaAttrDisplay, oaTextOverride, oaInstPropDisplay,
// and oaInstAttrDisplay. These classes implement the various types of 
// textDisplay shapes.
//
// *****************************************************************************
// 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-2010 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaTextDisplay_P)
#define oaTextDisplay_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaProp.h"
#include "oaInst.h"
#include "oaText.h"



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



// *****************************************************************************
// oaTextDisplayFormatEnum
// *****************************************************************************
#define oavNumTextDisplayFormats    3

enum oaTextDisplayFormatEnum {
    oacNameTextDisplayFormat        = 0,
    oacValueTextDisplayFormat       = 1,
    oacNameValueTextDisplayFormat   = 2
};



// *****************************************************************************
// oaTextDisplayFormat
// *****************************************************************************
class OA_DESIGN_DLL_API oaTextDisplayFormat {
public:
                            oaTextDisplayFormat(oaTextDisplayFormatEnum valueIn);
                            oaTextDisplayFormat(const oaString &name);
                            ~oaTextDisplayFormat();

    const oaString          &getName() const;

                            operator                oaTextDisplayFormatEnum() const;

private:
    oaTextDisplayFormatEnum value;

    static const oaString   names[];
};



// *****************************************************************************
// oaTextDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaTextDisplay : public oaShape {
public:
    void                            getOrigin(oaPoint &origin) const;
    oaTextAlign                     getAlignment() const;
    oaOrient                        getOrient() const;
    oaFont                          getFont() const;
    oaDist                          getHeight() const;
    oaTextDisplayFormat             getFormat() const;
    oaBoolean                       hasOverbar() const;
    oaBoolean                       isVisible() const;
    oaBoolean                       isDrafting() const;
    void                            getText(oaString &text) const;

    void                            setOrigin(const oaPoint &origin);
    void                            setAlignment(oaTextAlign alignment);
    void                            setOrient(oaOrient orient);
    void                            setFont(oaFont font);
    void                            setHeight(oaDist height);
    void                            setFormat(oaTextDisplayFormat format);
    void                            setOverbar(oaBoolean overbar);
    void                            setVisible(oaBoolean visible);
    void                            setDrafting(oaBoolean drafting);

    static oaTextDisplayCollection  getTextDisplays(const oaObject *object);
};



// *****************************************************************************
// oaPropDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaPropDisplay : public oaTextDisplay {
public:
    static oaPropDisplay    *create(oaProp              *prop,
                                    oaLayerNum          layerNum,
                                    oaPurposeNum        purposeNum,
                                    const oaPoint       &origin,
                                    oaTextAlign         alignment,
                                    oaOrient            orient,
                                    oaFont              font,
                                    oaDist              height,
                                    oaTextDisplayFormat format
                                    = oacNameTextDisplayFormat,
                                    oaBoolean           overbar = false,
                                    oaBoolean           visible = true,
                                    oaBoolean           drafting = true);

    oaProp                  *getProp() const;
};



// *****************************************************************************
// oaAttrDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaAttrDisplay : public oaTextDisplay {
public:
    static oaAttrDisplay    *create(oaObject            *object,
                                    oaAttrType          attribute,
                                    oaLayerNum          layerNum,
                                    oaPurposeNum        purposeNum,
                                    const oaPoint       &origin,
                                    oaTextAlign         alignment,
                                    oaOrient            orient,
                                    oaFont              font,
                                    oaDist              height,
                                    oaTextDisplayFormat format
                                    = oacNameTextDisplayFormat,
                                    oaBoolean           overbar = false,
                                    oaBoolean           visible = true,
                                    oaBoolean           drafting = true);

    void                    getText(const oaNameSpace   &ns,
                                    oaString            &text) const;
    oaObject                *getObject() const;
    oaAttrType              getAttribute() const;
    
    void                    setObject(oaObject  *object);
};



// *****************************************************************************
// oaTextOverride
// *****************************************************************************
class OA_DESIGN_DLL_API oaTextOverride : public oaTextDisplay {
public:
    static oaTextOverride   *create(oaText              *masterText,
                                    oaInst              *inst,
                                    oaLayerNum          layerNum,
                                    oaPurposeNum        purposeNum,
                                    const oaPoint       &origin,
                                    oaTextAlign         alignment,
                                    oaOrient            orient,
                                    oaFont              font,
                                    oaDist              height,
                                    oaTextDisplayFormat format
                                    = oacNameTextDisplayFormat,
                                    oaBoolean           overbar = false,
                                    oaBoolean           visible = true,
                                    oaBoolean           drafting = true);

    oaText                  *getMasterText() const;
    void                    getMasterTextText(oaString &text) const;
    oaInst                  *getInst() const;

    oaBoolean               isBound() const;
};



// *****************************************************************************
// oaInstPropDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaInstPropDisplay : public oaTextDisplay {
public:
    static oaInstPropDisplay    
                            *create(oaInst              *inst,
                                    oaProp              *masterProp,
                                    oaLayerNum          layerNum,
                                    oaPurposeNum        purposeNum,
                                    const oaPoint       &origin,
                                    oaTextAlign         alignment,
                                    oaOrient            orient,
                                    oaFont              font,
                                    oaDist              height,
                                    oaTextDisplayFormat format
                                    = oacNameTextDisplayFormat,
                                    oaBoolean           overbar = false,
                                    oaBoolean           visible = true,
                                    oaBoolean           drafting = true);

    oaProp                  *getMasterProp() const;
    oaInst                  *getInst() const;

    oaBoolean               isBound() const;
};



// *****************************************************************************
// oaInstAttrDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaInstAttrDisplay : public oaTextDisplay {
public:
    static oaInstAttrDisplay    
                            *create(oaInst              *inst,
                                    oaDesignAttrType    masterAttribute,
                                    oaLayerNum          layerNum,
                                    oaPurposeNum        purposeNum,
                                    const oaPoint       &origin,
                                    oaTextAlign         alignment,
                                    oaOrient            orient,
                                    oaFont              font,
                                    oaDist              height,
                                    oaTextDisplayFormat format
                                    = oacNameTextDisplayFormat,
                                    oaBoolean           overbar = false,
                                    oaBoolean           visible = true,
                                    oaBoolean           drafting = true);

    void                    getText(const oaNameSpace   &ns,
                                    oaString            &text) const;
    oaInst                  *getInst() const;
    oaDesignAttrType        getMasterAttribute() const;

    oaBoolean               isBound() const;
};




// *****************************************************************************
// oaTextDisplayIterState
// *****************************************************************************
class OA_DESIGN_DLL_API oaTextDisplayIterState {
public:
                                    oaTextDisplayIterState(const oaObject *objIn);


    virtual oaTextDisplay           *getNext() = 0;
    virtual void                    reset() = 0;
    virtual oaTextDisplayIterState  *copy() = 0;

protected:
    const oaObject                  *object;

    friend class oaTextDisplayIter;
};



// *****************************************************************************
// oaTextDisplayIter
// *****************************************************************************
class OA_DESIGN_DLL_API oaTextDisplayIter {
public:
                            oaTextDisplayIter(oaTextDisplayIterState *sub);
                            oaTextDisplayIter(oaTextDisplayIter &iterIn);

    oaTextDisplayIter       &operator=(const oaTextDisplayIter
                                       &iterIn);

                            ~oaTextDisplayIter();

    oaTextDisplay           *getNext();
    void                    reset();

protected:
    oaTextDisplayIterState  *state;
};



// *****************************************************************************
// oaTextDisplayCollection
// *****************************************************************************
class OA_DESIGN_DLL_API oaTextDisplayCollection {
public:
                            oaTextDisplayCollection(const oaObject *objIn);

                            operator oaTextDisplayIterState *();

    oaUInt4                 getCount();
    oaBoolean               isEmpty();
    oaBoolean               includes(const oaTextDisplay *td);

protected:
    const oaObject          *object;
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaTextDisplay> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaShape             parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacTextDisplayType};
};

template<>
class oaTraits<oaPropDisplay> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaTextDisplay       parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacPropDisplayType};
};

template<>
class oaTraits<oaAttrDisplay> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaTextDisplay       parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAttrDisplayType};
};

template<>
class oaTraits<oaTextOverride> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaTextDisplay       parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacTextOverrideType};
};

template<>
class oaTraits<oaInstPropDisplay> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaTextDisplay       parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacInstPropDisplayType};
};

template<>
class oaTraits<oaInstAttrDisplay> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaTextDisplay       parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacInstAttrDisplayType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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