oaScanChainSetType Class Reference

Public Methods
	oaScanChainSetType (oaScanChainSetTypeEnum valueIn)
	oaScanChainSetType (const oaString &name)
	~oaScanChainSetType ()
const oaString &	getName () const
	operator oaScanChainSetTypeEnum () const

---

Detailed Description

The oaScanChainSetType is an enum wrapper class that specifies if an oaScanChainSet is ordered.

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

enum oaScanChainSetTypeEnum

Enumeration values: oacOrderedScanChainSetType  "ordered" oacUnorderedScanChainSetType  "unordered"

---

Constructor & Destructor Documentation

oaScanChainSetType::oaScanChainSetType (  oaScanChainSetTypeEnum    typeIn )  [inline]

This function constructs an instance of an oaScanChainSetType class using the specified oaScanChainSetTypeEnum value.

oaScanChainSetType::oaScanChainSetType (  const oaString &    name )

This function constructs an instance of a oaScanChainSetType class using the oaScanChainSetTypeEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaScanChainSetTypeEnum. Exceptions: oacInvalidScanChainSetTypeName

oaScanChainSetType::~oaScanChainSetType (    )  [inline]

This function destroys this scan chain set, removing it from the database.

---

Member Function Documentation

const oaString & oaScanChainSetType::getName (    )  const

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

oaScanChainSetType::operator oaScanChainSetTypeEnum (    )  const [inline]

This operator casts this oaScanChainSetType object into the corresponding oaScanChainSetTypeEnum value.

---

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

• oaScanChainSet.h
• oaDesignEnumWrapper.inl
• oaScanChainSetType.dox

Return to top of page

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