oaVCMessageType Class Reference

Public Methods
	oaVCMessageType (oaVCMessageTypeEnum valueIn)
	oaVCMessageType (const oaString &name)
	~oaVCMessageType ()
const oaString &	getName () const
	operator oaVCMessageTypeEnum () const

---

Detailed Description

The oaVCMessageType class is an enum wrapper class for oaVCMessageTypeEnum values.

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

enum oaVCMessageTypeEnum

This enumeration represents the types of messages that are passed to the client via the IVCMessageObserver interface. Enumeration values: oacVCMsgTypeInfo  "Info" The message is informational only. This is typically used as the message for information queried from the VC system, for example log information on a controlled file. oacVCMsgTypeWarning  "Warning" This value of the message type is used when the message being sent to the client represents a warning being issued by the VC system. oacVCMsgTypeError  "Error" This value of the message type is used when the message being sent to the client represents an error being issued by the VC system. oacVCMsgTypeStatus  "Status" This value is used to indicate that the message being sent to the client represents status information. For example, if files are being checked out as a result of the current operation, the VC system may send the paths to those files as messages using this message type. oacVCMsgTypeQueryOk  "QueryOk" The message is a request for an Ok or Cancel decision from the client. When this message type is used, the return value of IVCMessageObserver::onMessageOut() is checked by the VC system. One of the values found in oaVCObserverResultEnum is expected, and used to determine if the current operation should continue or be aborted.

---

Constructor & Destructor Documentation

oaVCMessageType::oaVCMessageType (  oaVCMessageTypeEnum    valueIn )  [inline]

This oaVCMessageType constructor takes an oaVCMessageTypeEnum value. Parameters: valueIn  an oaVCMessageTypeEnum value

oaVCMessageType::oaVCMessageType (  const oaString &    name )

This oaVCMessageType constructor takes an oaVCMessageTypeEnum name. Parameters: name  the name associated with an oaVCMessageTypeEnum value Exceptions: oacInvalidVCMessageTypeName

oaVCMessageType::~oaVCMessageType (    )  [inline]

This is the oaVCMessageType destructor.

---

Member Function Documentation

const oaString & oaVCMessageType::getName (    )  const

This function returns the name of the oaVCMessageTypeEnum value set on this oaVCMessageType wrapper object.

oaVCMessageType::operator oaVCMessageTypeEnum (    )  const [inline]

This operator casts this oaVCMessageType object into its corresponding oaVCMessageTypeEnum value.

---

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

• oaVCObserver.h
• oaDMEnumWrapper.inl
• oaVCObserver.dox

Return to top of page

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