oaMarkerDeleteWhen Class Reference

Public Methods
	oaMarkerDeleteWhen (oaMarkerDeleteWhenEnum valueIn)
	oaMarkerDeleteWhen (const oaString &name)
	~oaMarkerDeleteWhen ()
const oaString &	getName () const
	operator oaMarkerDeleteWhenEnum () const

---

Detailed Description

The oaMarkerDeleteWhen class is an enum wrapper class that defines if and when OpenAccess automatically deletes oaMarker objects. Applications choose one of the values below for each marker they create. When a marker is deleted, all objects associated with the marker are updated accordingly. When an object is deleted, the markers associated with it are checked to see if they should be destroyed, based on the value of its deleteWhen attribute.

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

enum oaMarkerDeleteWhenEnum

Enumeration values: oacDeleteOnUnknown  "deleteUnknown" Applications should not use this value oacDeleteOnNever  "deleteNever" A marker with this attribute will only be destroyed when it is explicitly destroyed. The marker will remain even when it has no objects associated with it. oacDeleteOnFirst  "deleteFirst" A marker with this attribute will be destroyed when any of its associated objects is removed. oacDeleteOnLast  "deleteLast" A marker with this attribute will be destroyed when the last object associated with the it is removed. oacDeleteOnModify  "deleteModified" A marker with this attribute will be destroyed when any of its associated objects is modified.

---

Constructor & Destructor Documentation

oaMarkerDeleteWhen::oaMarkerDeleteWhen (  oaMarkerDeleteWhenEnum    valueIn )  [inline]

This function constructs an instance of an oaMarkerDeleteWhen class using the specified oaMarkerDeleteWhenEnum value.

oaMarkerDeleteWhen::oaMarkerDeleteWhen (  const oaString &    name )

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

oaMarkerDeleteWhen::~oaMarkerDeleteWhen (    )  [inline]

This function destroys this oaMarkerDeleteWhen class.

---

Member Function Documentation

const oaString & oaMarkerDeleteWhen::getName (    )  const

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

oaMarkerDeleteWhen::operator oaMarkerDeleteWhenEnum (    )  const [inline]

This operator casts this oaMarkerDeleteWhen object into the corresponding oaMarkerDeleteWhenEnum value.

---

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

• oaMarker.h
• oaDesignEnumWrapper.inl
• oaMarkerDeleteWhen.dox

Return to top of page

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