oaDMObjectStatusRef Class Reference


Public Methods

 oaDMObjectStatusRef (oaDMObject *obj=NULL, oaUInt4 stat=0)
oaDMObject *& getObject ()
oaDMObject * getObject () const
oaUInt4 & getStatus ()
oaUInt4 getStatus () const

Detailed Description

The oaDMObjectStatusRef represents a relationship between an oaDMObject and a status bitfield. It is used by the version control API functions to supply status information for a set of objects. See also oaDMObjectStatusRefIter.

Constructor & Destructor Documentation

oaDMObjectStatusRef::oaDMObjectStatusRef (  oaDMObject *    obj = NULL,
oaUInt4    stat = 0
)  [inline]
 

This function is the constructor for the oaDMObjectStatusRef class.

Parameters:
obj the object to be stored in the object/status relationship
stat the status value to be associated with the given object

Member Function Documentation

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

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

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

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

oaUInt4 oaDMObjectStatusRef::getStatus (    )  const [inline]
 

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

oaUInt4 & oaDMObjectStatusRef::getStatus (    )  [inline]
 

This function retrieves a reference to the status 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.