ICMPlugInBase Class Reference

Inheritance diagram for ICMPlugInBase:

Public Methods
virtual	~ICMPlugInBase ()
virtual void	init ()=0
virtual void	getProtocols (oa::oaCMProtocolArray &out) const=0
virtual void	setProtocol (const oa::oaCMProtocol &in)=0
virtual void	discardChangeSet (oa::oaChangeSetBase *in)=0

---

Detailed Description

The ICMPlugInBase is an abstract base class that defines the common interfaces for all Change Management System (CMS) plug-ins. These interfaces let the caller:

• Initialize the plug-in
• Get the array of protocols supported by the plug-in
• Set the protocol that the plug-in should use

The ICMPlugInBase interfaces are used by the oaChangeMgr class.

---

Constructor & Destructor Documentation

virtual ICMPlugInBase::~ICMPlugInBase (    )  [virtual]

---

Member Function Documentation

void ICMPlugInBase::discardChangeSet (  oa::oaChangeSetBase *    in )  [pure virtual]

This interface informs the plug-in of the deletion of a possibly active change set. Parameters: in  A pointer to a change set.

void ICMPlugInBase::getProtocols (  oa::oaCMProtocolArray &    out )  const [pure virtual]

This function returns the array of supported protocols in the out output parameter. Parameters: out  The array of protocols supported by the plug-in.

void ICMPlugInBase::init (    )  [pure virtual]

This function initializes the plug-in so it is ready for use.

void ICMPlugInBase::setProtocol (  const oa::oaCMProtocol &    in )  [pure virtual]

This function specifies the protocol that the plug-in should use. Parameters: in  The protocol to use.

---

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

• oaPlugInCMInterfaces.h
• oaPlugInCMInterfaces.dox

Return to top of page

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