oaRowFlipType Class Reference


Public Methods

 oaRowFlipType (oaRowFlipTypeEnum typeIn)
 oaRowFlipType (const oaString &name)
const oaStringgetName () const
 operator oaRowFlipTypeEnum () const

Detailed Description

The oaRowFlipType class is an enum wrapper that indicates whether alternate rows in an oaCoreBoxSpec are flipped with respect to the primary orientation of the sites in that row. See oaCoreBoxSpec::setRowFlipType for an example of its use.

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

enum oaRowFlipTypeEnum
 

Enumeration values:
oacNoRowFlipType  "none"
oacEvenRowFlipType  "even"
oacOddRowFlipType  "odd"


Constructor & Destructor Documentation

oaRowFlipType::oaRowFlipType oaRowFlipTypeEnum    typeIn [inline]
 

This function constructs an instance of an oaRowFlipType object using the specified oaRowFlipTypeEnum value.

oaRowFlipType::oaRowFlipType const oaString &    name
 

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

Exceptions:
oacInvalidCoreRowFlipTypeName 


Member Function Documentation

const oaString & oaRowFlipType::getName   const
 

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

oaRowFlipType::operator oaRowFlipTypeEnum   const [inline]
 

This operator casts this oaRowFlipType object into the corresponding oaRowFlipTypeEnum value.


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

Return to top of page