oaLibAccessLevel Class Reference


Public Methods

 oaLibAccessLevel (oaLibAccessLevelEnum valueIn)
 oaLibAccessLevel (const oaString &name)
const oaStringgetName () const
 operator oaLibAccessLevelEnum () const

Detailed Description

oaLibAccessLevel a utility enum wrapper class that encapsulates oaLibAccessLevelEnum values, which indicate the current library access level. There are three levels: read, write, and none.

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

enum oaLibAccessLevelEnum
 

Enumeration values:
oacNoLibAccessLevel  "no access"
oacReadLibAccessLevel  "read access"
oacWriteLibAccessLevel  "write access"


Constructor & Destructor Documentation

oaLibAccessLevel::oaLibAccessLevel oaLibAccessLevelEnum    valueIn [inline]
 

This oaLibAccessLevel constructor takes an oaLibAccessLevelEnum value as input.

Parameters:
valueIn an oaLibAccessLevelEnum value

oaLibAccessLevel::oaLibAccessLevel const oaString &    name
 

This oaLibAccessLevel constructor takes an oaLibAccessLevelEnum name as input.

Parameters:
name the name associated with a valid oaLibAccessLevelEnum value
Exceptions:
oacInvalidLibAccessLevelName 


Member Function Documentation

const oaString & oaLibAccessLevel::getName   const
 

This function returns the name associated with the oaLibAccessLevelEnum value set on this oaLibAccessLevel object.

oaLibAccessLevel::operator oaLibAccessLevelEnum   const [inline]
 

This operator casts this oaLibAccessLevel object into its corresponding oaLibAccessLevelEnum value.


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

Return to top of page