oaViaDirection Class Reference


Public Methods

 oaViaDirection (oaViaDirectionEnum valueIn)
 oaViaDirection (const oaString &name)
 ~oaViaDirection ()
const oaStringgetName () const
 operator oaViaDirectionEnum () const

Detailed Description

The oaViaDirection class is an enum wrapper class that describes the direction of a via.

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

enum oaViaDirectionEnum
 

Enumeration values:
oacLayer1ToLayer2ViaDirection  This value indicates a via which follows a layer1 to layer2 direction
oacLayer2ToLayer1ViaDirection  This value indicates a via which follows a layer2 to layer1 direction


Constructor & Destructor Documentation

oaViaDirection::oaViaDirection oaViaDirectionEnum    valueIn [inline]
 

This is the first constructor for the oaViaDirection class enum wrapper. It takes an oaViaDirectionEnum type as input.

Parameters:
valueIn An oaViaDirectionEnum value for the specified direction

oaViaDirection::oaViaDirection const oaString &    name
 

This is the second constructor for the oaViaDirection class enum wrapper. It takes oaString type name as input.

Parameters:
name A string name that represents a valid via direction type
Exceptions:
oacInvalidViaDirectionTypeName 

oaViaDirection::~oaViaDirection   [inline]
 

This is the destructor for the oaViaDirection class.


Member Function Documentation

const oaString & oaViaDirection::getName   const
 

This function returns a valid via direction name as a string based on the current via direction that the object represents.

oaViaDirection::operator oaViaDirectionEnum   const [inline]
 

This operator can be used to typecast an existing oaViaDirection object into its corresponding oaViaDirectionEnum value.


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

Return to top of page