oaMarker.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaMarker.h
//
// This file contains the definition for the oaMarker class.
//
// Marker objects are associated with zero or more oaDesignObjects and are 
// represented using a point array.  Markers are often used to indicate 
// violations between the specified objects. 
//
// *****************************************************************************
// 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(oaMarker_P)
#define oaMarker_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPointArray.h"
#include "oaFig.h"
#include "oaBlock.h"



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



// *****************************************************************************
// oaMarkerDeleteWhenEnum
// *****************************************************************************
#define oavNumMarkerDeleteWhenTypes    5

enum oaMarkerDeleteWhenEnum {
    oacDeleteOnUnknown  = 0,
    oacDeleteOnNever    = 1,
    oacDeleteOnFirst    = 2,
    oacDeleteOnLast     = 3,
    oacDeleteOnModify   = 4
};



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

    const oaString          &getName() const;

                            operator                oaMarkerDeleteWhenEnum() const;

private:
    oaMarkerDeleteWhenEnum  value;

    static const oaString   names[];
};


// *****************************************************************************
// oaMarkerSeverity
// *****************************************************************************
#define oavNumMarkerSeverityTypes    9

enum oaMarkerSeverityEnum {
    oacAnnotationMarkerSeverity             = 0,
    oacInfoMarkerSeverity                   = 1,
    oacAcknowledgedWarningMarkerSeverity    = 2,
    oacWarningMarkerSeverity                = 3,
    oacSignedOffErrorMarkerSeverity         = 4,
    oacErrorMarkerSeverity                  = 5,
    oacSignedOffCriticalErrorMarkerSeverity = 6,
    oacCriticalErrorMarkerSeverity          = 7,
    oacFatalErrorMarkerSeverity             = 8
};



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

    const oaString          &getName() const;

                            operator                oaMarkerSeverityEnum() const;

private:
    oaMarkerSeverityEnum    value;

    static const oaString   names[];
};



// *****************************************************************************
// oaMarker
// *****************************************************************************
class OA_DESIGN_DLL_API oaMarker : public oaFig {
public:
    static oaMarker                         *create(oaBlock             *block,
                                                    const oaPointArray  &points,
                                                    const oaString      &msg,
                                                    const oaString      &shortMsg,
                                                    const oaString      &tool,
                                                    oaBoolean           isVisible,
                                                    oaBoolean           isClosed,
                                                    oaMarkerSeverity    severity,
                                                    oaMarkerDeleteWhen  deleteWhen
                                                    = oacDeleteOnFirst);

    void                                    transform(oaDouble  scale,
                                                      oaDouble  angle);

    void                                    addObject(oaBlockObject *obj);
    void                                    removeObject(oaBlockObject *obj);

    oaBoolean                               isVisible() const;
    oaBoolean                               isClosed() const;
    oaMarkerSeverity                        getSeverity() const;
    void                                    getPoints(oaPointArray &points) const;
    void                                    getMsg(oaString &msg) const;
    void                                    getShortMsg(oaString &shortMsg) const;
    void                                    getTool(oaString &tool) const;
    oaMarkerDeleteWhen                      getDeleteWhen() const;

    void                                    setIsVisible(oaBoolean val);
    void                                    setIsClosed(oaBoolean val);
    void                                    setSeverity(oaMarkerSeverity severity);
    void                                    setPoints(const oaPointArray &points);
    void                                    setMsg(const oaString &msg);
    void                                    setShortMsg(const oaString &shortMsg);
    void                                    setTool(const oaString &tool);
    void                                    setDeleteWhen(oaMarkerDeleteWhen deleteWhen);

    oaCollection<oaBlockObject, oaMarker>   getObjects() const;

    enum {dtIndex = oacMarkerDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaMarker> {
public:
    typedef oaFig               parentType;
    typedef oaMarkerModTypeEnum modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacMarkerDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacMarkerType};
    enum {dataTypeEnumVal = oacMarkerDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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