oaEndpointType Class Reference

Public Methods
	oaEndpointType (oaEndpointTypeEnum valueIn)
	oaEndpointType (const oaString &name)
	~oaEndpointType ()
const oaString &	getName () const
	operator oaEndpointTypeEnum () const

---

Detailed Description

The oaEndpointType class is an enum wrapper class that specifies which end is which for the two endpoints of a standard parasitic device. Se oaStdDevice::getNode for one example of its usage.

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

enum oaEndpointTypeEnum

Enumeration values: oacFromEndpointType  "from" oacToEndpointType  "to"

---

Constructor & Destructor Documentation

oaEndpointType::oaEndpointType (  oaEndpointTypeEnum    valueIn )  [inline]

This function constructs an instance of an oaEndpointType class using the specified oaEndpointTypeEnum value.

oaEndpointType::oaEndpointType (  const oaString &    name )

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

oaEndpointType::~oaEndpointType (    )  [inline]

This function destroys this oaEndpointType instance.

---

Member Function Documentation

const oaString & oaEndpointType::getName (    )  const

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

oaEndpointType::operator oaEndpointTypeEnum (    )  const [inline]

This operator casts this oaEndpointType object into the corresponding oaEndpointTypeEnum value.

---

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

• oaDevice.h
• oaDesignEnumWrapper.inl
• oaEndpointType.dox

Return to top of page

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