IVCSystem Class Reference

Inheritance diagram for IVCSystem:

IBase


Public Methods

virtual SRef< IString > getName ()=0
virtual bool testCapability (oa::oaUInt4 capability)=0
virtual void getControlledLibs (IDMLibIter *&libs)=0
virtual void newVersionObject (IVersion *&version, const char *displayName=NULL)=0

Detailed Description

This interface is implemented by an object in the version control system that is capable of reporting on general attributes of the system. It is generally a singleton object, meaning that the same instance of the object is returned no matter how many times the plug-in system requests it. However, this behavior is not strictly required.

Member Function Documentation

void IVCSystem::getControlledLibs (  IDMLibIter *&    libs )  [pure virtual]
 

This function passes back an interface pointer to an iterator of IDMLib interface pointers, each of which represents a library that is controlled by this instance of the VC plug-in.

Parameters:
libs A pointer to an IDMLibIter interface. This iterator can be used to access each of the IDMLib pointers for the libraries controlled by this plug-in.

SRef< IString > IVCSystem::getName (    )  [pure virtual]
 

This function returns the name of the Version Control Plug-in that is is serving this component.

void IVCSystem::newVersionObject (  IVersion *&    version,
const char *    displayName = NULL
)  [pure virtual]
 

This function creates a new version object, which is passed back via the "version" parameter. The optional "displayName", if set, is used to seed the version object, and must be in a format that can be interpreted by the version control system. If the "displayName" parameter is not well formed, this function may throw an exception (which must be derived from the IException interface).

Parameters:
version This is the parameter that gets set to the IVersion interface pointer of the newly created version object. Note that (as with all interface output parameters) the reference count on "version" will be incremented by this function prior to returning.
displayName This is a string that the VC system will parse to seed the version object that it creates. The format of this string is entirely determined by the VC system - OA imposes no requirements or restrictions on the value of this parameter.

bool IVCSystem::testCapability (  oa::oaUInt4    capability )  [pure virtual]
 

This function is used to query the VC system about it's support for a predefined set of version control capabilities. This set is given by oaVersionCompEnum.

Parameters:
capability This value must be one of the values found in oaVersionCompEnum. This function must be implemented such that new capability values can be added later without the VC system failing. Typically, the function will return "true" for capabilities that it supports, and "false" for every other case.

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.