oaDMObjectVersionRef Class Reference


Public Methods

 oaDMObjectVersionRef (const oaDMObject *obj, const oaVCVersion &ver)
 oaDMObjectVersionRef (const oaDMObject *obj=NULL)
const oaDMObject *& getObject ()
const oaDMObject * getObject () const
oaVCVersion & getVersion ()
oaVCVersion getVersion () const

Detailed Description

The oaDMObjectVersionRef represents a relationship between an oaDMObject and an oaVCVersion. It is used by the version control API functions to supply version information for a set of objects. See also oaDMObjectVersionRefIter.

Constructor & Destructor Documentation

oaDMObjectVersionRef::oaDMObjectVersionRef (  const oaDMObject *    obj,
const oaVCVersion &    ver
)  [inline]
 

This function is a constructor for the oaDMObjectVersionRef class. It is used to establish a relationship between an oaDMObject and a particular version value.

Parameters:
obj the object to be stored in the object/version relationship
ver the version value to be associated with the given object

oaDMObjectVersionRef::oaDMObjectVersionRef (  const oaDMObject *    obj = NULL )  [inline]
 

This function is a constructor for the oaDMObjectVersionRef class. This form of the constructor is used to construct an empty instance of an oaDMObjectVersionRef or one with a default version.

Parameters:
obj the object to be stored in the object/version relationship

Member Function Documentation

oaDMObject * oaDMObjectVersionRef::getObject (    )  const [inline]
 

This function retrieves a pointer to the object in this class. It can be called from a const instance of the oaDMObjectVersionRef.

oaDMObject *& oaDMObjectVersionRef::getObject (    )  [inline]
 

This function retrieves a reference to the object from this class.

oaVCVersion * oaDMObjectVersionRef::getVersion (    )  const [inline]
 

This function retrieves the version value from this class. It can be called from a const instance of oaDMObjectVersionRef.

oaVCVersion *& oaDMObjectVersionRef::getVersion (    )  [inline]
 

This function retrieves a reference to the version value from this class.

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.