oaLayerOp Class Reference


Public Methods

 oaLayerOp (oaLayerOpEnum valueIn)
 oaLayerOp (const oaString &name)
 ~oaLayerOp ()
const oaStringgetName () const
 operator oaLayerOpEnum () const

Detailed Description

The oaLayerOp class encapsulates the enumerated values that describe the different uses of a derived layer object.

enum oaLayerOpEnum
 

Enumeration values:
oacAndLayerOp  "AND"
oacOrLayerOp  "OR"
oacNotLayerOp  "NOT"
oacXorLayerOp  "XOR"
oacTouchingLayerOp  "TOUCHING"
oacButtOnlyLayerOp  "BUTTONLY"
oacUserDefinedLayerOp  "userDefined"
oacInsideLayerOp  "inside"
oacOutsideLayerOp  "outside"
oacOverlappingLayerOp  "overlapping"
oacStraddlingLayerOp  "straddling"
oacAvoidingLayerOp  "avoiding"
oacButtingLayerOp  "butting"
oacCoincidentLayerOp  "coincident"
oacCoincidentOnlyLayerOp  "coincidentOnly"
oacEnclosingLayerOp  "enclosing"
oacButtingOrCoincidentLayerOp  "buttingOrCoincident"
oacButtingOrOverlappingLayerOp  "buttingOrOverlapping"
oacAreaLayerOp  "area"
oacGrowLayerOp  "grow"
oacShrinkLayerOp  "shrink"
oacGrowVerticalLayerOp  "growVertical"
oacGrowHorizontalLayerOp  "growHorizontal"
oacShrinkVerticalLayerOp  "shrinkVertical"
oacShrinkHorizontalLayerOp  "shrinkHorizontal"
oacSelectLayerOp  "oaSelect"


Constructor & Destructor Documentation

oaLayerOp::oaLayerOp oaLayerOpEnum    valueIn [inline]
 

This function constructs an instance of an oaLayerOp class using the specified oaLayerOpEnum value.

oaLayerOp::oaLayerOp const oaString &    name
 

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

Exceptions:
oacInvalidLayerOpName 

oaLayerOp::~oaLayerOp   [inline]
 

This function destroys this oaLayerOp class.


Member Function Documentation

const oaString & oaLayerOp::getName   const
 

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

oaLayerOp::operator oaLayerOpEnum   const [inline]
 

This operator casts this oaLayerOp object into the corresponding oaLayerOpEnum value.


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

Return to top of page