oaVCVersion Class Reference


Public Methods

 oaVCVersion ()
 oaVCVersion (const oaChar *sysName, const oaChar *displayName=NULL)
 oaVCVersion (const oaVCVersion &ver)
 ~oaVCVersion ()
void getVCSystemName (oaString &sysName) const
void setDisplayName (const oaChar *sysName, const oaChar *displayName)
void getDisplayName (oaString &name) const
oaVersionComp compare (const oaVCVersion *other) const
oaVCVersion & operator= (const oaVCVersion &ver)
void * getRaw () const

Detailed Description

The oaVCVersion class manages an IVersion interface pointer as an abstraction for the OpenAccess public API. The real work is done by a derived oaVCVersionPvt class to prevent dependencies from the OpenAccess public API on the plug-in interfaces.

Constructor & Destructor Documentation

oaVCVersion::oaVCVersion (    ) 
 

This is the default constructor for the oaVCVersion class.

oaVCVersion::oaVCVersion (  const oaChar *    sysName,
const oaChar *    displayName = NULL
) 
 

This constructor for the oaVCVersion class finds the version control interface (if any) from the sysName passed in and creates an IVersion interface from that, using the display name. If the version control system of the given name doesn't exist, the "info" member will be NULL.

Parameters:
sysName VC system name.
displayName Optional VC display name.

oaVCVersion::oaVCVersion (  const oaVCVersion &    ver ) 
 

This is the copy constructor for the oaVCVersion constructor.

Parameters:
ver The version object to use to create the copy.

oaVCVersion::~oaVCVersion (    ) 
 

This is the oaVCVersion destructor.

Member Function Documentation

oaVersionComp oaVCVersion::compare (  const oaVCVersion *    other )  const
 

This function compares two versions. This is a legal operation even if the version objects were generated from different version control systems. In that case, the most likely return value will be "oacVersionCompIncompatable".

Parameters:
other A pointer to another version object to compare to this one.

void oaVCVersion::getDisplayName (  oaString &    name )  const
 

This function returns the display name of this version object.

Parameters:
name Returned display name of this version object.

void * oaVCVersion::getRaw (    )  const [inline]
 

This function returns an IVersion pointer to the version object referenced by this object.

This function is useful when using the oaVCVersionIter::getNext() function -- when the getRaw() function returns a NULL pointer, the iteration is finished.

void oaVCVersion::getVCSystemName (  oaString &    sysName )  const
 

This function returns the version control system name of the version object.

Parameters:
sysName Returned system name of the version object.

oaVCVersion & oaVCVersion::operator= (  const oaVCVersion &    ver ) 
 

This function is the assignment operator for the oaVCVersion class. It copies the IVersion pointer and adds a reference to it.

Parameters:
ver An oaVCVersion object to assign to this instance.

void oaVCVersion::setDisplayName (  const oaChar *    sysName,
const oaChar *    displayName
) 
 

This function sets the display name of this version object by calling into the VC system and having it create a new version object.

Parameters:
sysName System name of this version object.
displayName Display name to set on this version object.

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.