oaVCSystem Class Reference


Public Methods

void destroy ()
virtual void getName (oaString &name) const=0
virtual oaBoolean testCapability (oaVCCap cap) const=0
virtual oaBoolean getControlledLibs (oaArray< oaLib * > &libs) const=0

Static Public Methods

oaVCSystem * get (const oaChar *name)

Detailed Description

The oaVCSystem class is used to manage and access version control plug-ins through the OpenAccess public interface.

Member Function Documentation

void oaVCSystem::destroy (    ) 
 

This function will destroy this instance of the oaVCSystem object by calling "delete" on it. Since the destructor is virtual, the oaVCSystemPvt destructor will be called first, releasing the IVCSystem interface pointer.

oaVCSystem * oaVCSystem::get (  const oaChar *    name )  [static]
 

This function will get the correct oaVCSystem object (actually, an oaVCSystemPvt class). If a VC system of that name exists, the corresponding oaVCSystem object will be returned to the caller. If not, NULL will be returned.

Parameters:
name Input parameter - name of VC system.

oaBoolean oaVCSystem::getControlledLibs (  oaArray< oaLib * > &    libs )  const [pure virtual]
 

This function will return an array of libraries that are being controlled by this version control system. Note that this isn't all the controlled libraries in this session; if a library is being controlled by a different version control system than the one represented by this instance of oaVCSystem, it will not appear in this list.

Parameters:
libs Output parameter - an array of the libraries controlled by this version control system.

void oaVCSystem::getName (  oaString &    name )  const [pure virtual]
 

This function returns the name of this oaVCSystem object.

Parameters:
name Returned name of this oaVCSystem.

oaBoolean oaVCSystem::testCapability (  oaVCCap    cap )  const [pure virtual]
 

This function is used to determine if a particular capability is supported by the installed version control system.

Parameters:
cap An enumerated value for the capability that is being queried from the version control system.

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.