oaLibAccess Class Reference


Public Methods

 oaLibAccess (oaLibAccessEnum valueIn)
 oaLibAccess (const oaString &name)
const oaStringgetName () const
 operator oaLibAccessEnum () const

Detailed Description

oaLibAccess is a utility wrapper class that encapsulates oaLibAccessEnum values, which represent different types of library access.

enum oaLibAccessEnum
 

Enumeration values:
oacReadLibAccess  "read"
oacWriteLibAccess  "write"


Constructor & Destructor Documentation

oaLibAccess::oaLibAccess oaLibAccessEnum    valueIn [inline]
 

This oaLibAccess constructor takes an oaLibAccessEnum value as input.

Parameters:
valueIn an oaLibAccessEnum value

oaLibAccess::oaLibAccess const oaString &    name
 

This oaLibAccess constructor takes the oaString name of an oaLibAccessEnum value as input.

Parameters:
name the oaString name of an oaLibAccessEnum value
Exceptions:
oacInvalidLibAccessName 


Member Function Documentation

const oaString & oaLibAccess::getName   const
 

This function returns the string name of the oaLibAccessEnum value set on this oaLibAccess wrapper object.

oaLibAccess::operator oaLibAccessEnum   const [inline]
 

This operator casts this oaLibAccess object into its corresponding oaLibAccessEnum value.


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

Return to top of page