oaVCObserverResult Class Reference


Public Methods

 oaVCObserverResult (oaVCObserverResultEnum valueIn)
 oaVCObserverResult (const oaString &name)
 ~oaVCObserverResult ()
const oaString & getName () const
 operator oaVCObserverResultEnum () const

Detailed Description

The oaVCObserverResult class is an enum wrapper class for oaVCObserverResultEnum values.

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

enum oaVCObserverResultEnum
 

This enumeration contains the legal responses to a oacVCMsgTypeQueryOk message type. The appropriate value is passed by the client as the return value from the IVCMessageObserver::onMessageOut() call.

Enumeration values:
oacVCObserverResultOk  "Ok" Proceed with the current operation.
oacVCObserverResultAbort  "Abort" Abort the current operation.

Constructor & Destructor Documentation

oaVCObserverResult::oaVCObserverResult (  oaVCObserverResultEnum    valueIn )  [inline]
 

This oaVCObserverResult constructor takes an oaVCObserverResultEnum value.

Parameters:
valueIn an oaVCObserverResultEnum value

oaVCObserverResult::oaVCObserverResult (  const oaString &    name ) 
 

This oaVCObserverResult constructor takes an oaVCObserverResult name.

Parameters:
name the name associated with an oaVCObserverResult value
Exceptions:
oacInvalidVCObserverResultName 

oaVCObserverResult::~oaVCObserverResult (    )  [inline]
 

This is the oaVCObserverResult destructor.

Member Function Documentation

const oaString & oaVCObserverResult::getName (    )  const
 

This function returns the string name of the oaVCObserverResultEnum value set on this oaVCObserverResult wrapper object.

oaVCObserverResult::operator oaVCObserverResultEnum (    )  const [inline]
 

This operator casts this oaVCObserverResult object into its corresponding oaVCObserverResultEnum value.

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.