oaPinConnectMethod Class Reference


Public Methods

 oaPinConnectMethod (oaPinConnectMethodEnum valIn)
 oaPinConnectMethod (const oaString &name)
 ~oaPinConnectMethod ()
const oaString & getName ()
 operator oaPinConnectMethodEnum () const
const oaString & getName () const

Detailed Description

The oaPinConnectMethod class is an enum wrapper class that describes the various ways that the pins for a given terminal may connect to their net. See oaTerm::getPinConnectMethod for its usage.

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

enum oaPinConnectMethodEnum
 

Enumeration values:
oacDefaultPinConnectMethod  "default"
oacRingPinConnectMethod  "ring"
oacAbutPinConnectMethod  "abut"
oacFeedthruPinConnectMethod  "feedthru"

Constructor & Destructor Documentation

oaPinConnectMethod::oaPinConnectMethod (  oaPinConnectMethodEnum    typeIn )  [inline]
 

This function constructs an instance of an oaPinConnectMethod class using the specified enum value. The enum values are defined in oaPinConnectMethodEnum.

oaPinConnectMethod::oaPinConnectMethod (  const oaString &    name ) 
 

This function constructs an instance of an oaPinConnectMethod class using the oaPinConnectMethodEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaPinConnectMethodEnum.

Exceptions:
oacInvalidPinConnectMethodName 

oaPinConnectMethod::~oaPinConnectMethod (    )  [inline]
 

This function destroys this oaPinConnectMethod class.

Member Function Documentation

const oaString & oaPinConnectMethod::getName (    )  const
 

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

const oaString & oaPinConnectMethod::getName (    ) 
 

This function is deprecated. Refer to the const version of the getName function.

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

oaPinConnectMethod::operator oaPinConnectMethodEnum (    )  const [inline]
 

This operator casts this oaPinConnectMethod object into the corresponding oaPinConnectMethodEnum value.

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

Return to top of page




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