ICompatibility Class Reference

Inheritance diagram for ICompatibility:

Public Methods
virtual bool	validate ()=0
Static Public Methods
const Guid &	getId ()

---

Detailed Description

This interface class lets a plug-in verify whether or not a version of OpenAccess is compatible with the plug-in.

OpenAccess runs a query to determine if a plug-in has implemented this interface. If implemented, OpenAccess calls the validate function implemented by the plug-in client (the application).

Refer to Compatibility for OpenAccess Applications and Data for information about OpenAccess API compatibility and feature- based compatibility.

---

Member Function Documentation

const Guid & ICompatibility::getId (    )  [inline, static]

This function returns a 128-bit ID value that is used to uniquely identify interfaces in the OpenAccess plug-in system. Reimplemented from IBase.

bool ICompatibility::validate (    )  [pure virtual]

This function validates whether or not this version of OpenAccess is compatible with the plug-in. If it is compatible, true is returned. Otherwise, the validate function might: Return False. OpenAccess throws a generic IPlugInException error about incompatibility between OpenAccess and the plug-in. Throw an IException error that encapsulates the oacInvalidAPIRev error message and provides information about the expected API major and minor revision numbers. Refer to Compatibility for OpenAccess Applications and Data for more information.

---

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

• oaCommonIBase.h
• oaCommonIBase.inl
• oaCommonIBase.dox

Return to top of page

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