oaLibMode Class Reference


Public Methods

 oaLibMode (oaLibModeEnum valueIn)
 oaLibMode (const oaString &name)
 ~oaLibMode ()
const oaString & getName () const
 operator oaLibModeEnum () const

Detailed Description

oaLibMode is an wrapper class that encapsulates oaLibModeEnum values, which represent the modes available for accessing a library.

enum oaLibModeEnum
 

Enumeration values:
oacSharedLibMode  "shared" This process will share the access to the library with other processes and may write to the library files in it
oacNonSharedLibMode  "nonShared" Only this process will be allowed to access the library and it may write to the library and files in it
oacReadOnlyLibMode  "readOnly" This process will only read the library and its files. Other processes may access the library in read mode as well

Constructor & Destructor Documentation

oaLibMode::oaLibMode (  oaLibModeEnum    valueIn )  [inline]
 

This constructor for the oaLibMode class enum wrapper takes an oaLibMode type as input.

Parameters:
valueIn an oaLibModeEnum value

oaLibMode::oaLibMode (  const oaString &    name ) 
 

This constructor for the oaLibMode class enum wrapper takes an oaLibModeEnum string name as input.

Parameters:
name an oaLibModeEnum string name
Exceptions:
oacInvalidLibModeName the specified oaLibModeEnum string name is invalid

oaLibMode::~oaLibMode (    )  [inline]
 

This is the destructor for the oaLibMode class.

Member Function Documentation

const oaString & oaLibMode::getName (    )  const
 

This function returns the string name of the oaLibModeEnum value for this oaLibMode wrapper object.

oaLibMode::operator oaLibModeEnum (    )  const [inline]
 

This function returns the oaLibModeEnum value for this oaLibMode wrapper object.

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

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.