oaViaParamType Class Reference


Public Methods
	oaViaParamType (oaViaParamTypeEnum valueIn)
	oaViaParamType (const oaString &name)
	~oaViaParamType ()
const oaString &	getName () const
	operator oaViaParamTypeEnum () const

Detailed Description

The oaViaParamType class is an enum wrapper class for oaViaParamTypeEnum values.

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

enum oaViaParamTypeEnum

Note: The oacCutSizeViaParamType is deprecated. Instead, the oacCutWidthViaParamType and oacCutHeightViaParamType enumerations are used. These have the advantage of not requiring a 1:1 aspect ratio.
Enumeration values:

oacLayer1EncViaParamType "layer1Enc"

oacLayer2EncViaParamType "layer2Enc"

oacImplant1EncViaParamType "implant1Enc"

oacImplant2EncViaParamType "implant2Enc"

oacLayer1OffsetViaParamType "layer1Offset"

oacLayer2OffsetViaParamType "layer2Offset"

oacCutSpacingViaParamType "cutSpacing"

oacOriginOffsetViaParamType "originOffset"

oacCutSizeViaParamType "cutSize"

oacCutLayerViaParamType "cutLayer"

oacCutColumnsViaParamType "cutColumns"

oacCutRowsViaParamType "cutRows"

oacCutWidthViaParamType "cutWidth"

oacCutHeightViaParamType "cutHeight"

Constructor & Destructor Documentation

oaViaParamType::oaViaParamType ( oaViaParamTypeEnum valueIn ) [inline]

This function constructs an instance of an oaViaParamType object using the specified oaViaParamTypeEnum value.

Parameters:

valueIn A value from the enumerated list representing via parameter types that this object represents

oaViaParamType::oaViaParamType ( const oaString & name )

This function constructs an instance of an oaViaParamType object using the oaViaParamTypeEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaViaParamTypeEnum.

Parameters:

name A reference to an oaString object representing a valid oaViaParamTypeEnum name

Exceptions:

oacInvalidViaParamTypeName

oaViaParamType::~oaViaParamType ( ) [inline]

This function destroys an oaViaParamType object.

Member Function Documentation

const oaString & oaViaParamType::getName ( ) const

This function returns the string name associated with the encapsulated oaViaParamTypeEnum object set on this oaViaParamType.

oaViaParamType::operator oaViaParamTypeEnum ( ) const [inline]

This operator returns the oaViaParamTypeEnum set on this oaViaParamType.

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

Return to top of page

oaViaParamType Class Reference

Public Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation