oaMarkerSeverity Class Reference

Public Methods
	oaMarkerSeverity (oaMarkerSeverityEnum valueIn)
	oaMarkerSeverity (const oaString &name)
	~oaMarkerSeverity ()
const oaString &	getName () const
	operator oaMarkerSeverityEnum () const

---

Detailed Description

The oaMarkerSeverity class is an enum wrapper class that defines the severity type on oaMarker objects. Applications choose one of the values below for each marker they create.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaMarkerSeverityEnum

Enumeration values: oacAnnotationMarkerSeverity  "annotation" A marker with this attribute indicates user generated information that is placed on the design. oacInfoMarkerSeverity  "info" A marker with this attribute indicates tool generated information. oacAcknowledgedWarningMarkerSeverity  "acknowledgedWarning" A marker with this attribute indicates a tool generated warning that has been acknowledged by the designer. oacWarningMarkerSeverity  "warning" A marker with this attribute indicates a tool generated warning. oacSignedOffErrorMarkerSeverity  "signedOffError" A marker with this attribute indicates a tool generated error that has been signed-off by the designer. oacErrorMarkerSeverity  "error" A marker with this attribute indicates a tool generated error. oacSignedOffCriticalErrorMarkerSeverity  "signedOffCriticalError" A marker with this attribute indicates a tool generated critical error that has been signed-off by the designer. A critical error usually requires a design review to sign-off, and should not be signed off by a single designer. oacCriticalErrorMarkerSeverity  "criticalError" A marker with this attribute indicates a tool generated critical error. oacFatalErrorMarkerSeverity  "fatalError" A marker with this attribute indicates a tool generated fatal error. Such an error can not be signed off as it will always result in a non- functional/non-manufacturable design.

---

Constructor & Destructor Documentation

oaMarkerSeverity::oaMarkerSeverity (  oaMarkerSeverityEnum    valueIn )  [inline]

This function constructs an instance of an oaMarkerSeverity class using the specified oaMarkerSeverityEnum value.

oaMarkerSeverity::oaMarkerSeverity (  const oaString &    name )

This function constructs an instance of an oaMarkerSeverity class using the oaMarkerSeverityEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaMarkerSeverityEnum. Exceptions: oacInvalidMarkerSeverityTypeName

oaMarkerSeverity::~oaMarkerSeverity (    )  [inline]

This function destroys this oaMarkerSeverity class.

---

Member Function Documentation

const oaString & oaMarkerSeverity::getName (    )  const

This function returns the name string associated with the encapsulated oaMarkerSeverityEnum object.

oaMarkerSeverity::operator oaMarkerSeverityEnum (    )  const [inline]

This operator casts this oaMarkerSeverity object into the corresponding oaMarkerSeverityEnum value.

---

The documentation for this class was generated from the following files:

• oaMarker.h
• oaDesignEnumWrapper.inl
• oaMarkerSeverity.dox

Return to top of page

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