oaCMAttr Class Reference


Public Methods

 oaCMAttr (const oaString &nameIn)
 oaCMAttr (const oaString &nameIn, const oaString &valueIn)
 oaCMAttr (const oaCMAttr &attrIn)
const oaString & getName () const
const oaString & getValue () const
void setValue (const oaString &valueIn)
oaCMAttr & operator= (const oaCMAttr &rhs)
oaBoolean operator== (const oaCMAttr &rhs) const
oaBoolean operator!= (const oaCMAttr &rhs) const
oaBoolean isUnset () const

Friends

class oaArrayBase
class oaArray

Detailed Description

The oaCMAttr class defines an attribute. An attribute is a name and value pair. An attribute can have an unset value.

oaCMAttrArrays are used by oaCMProtocols in the OpenAccess change management system (CMS).

Constructor & Destructor Documentation

oaCMAttr::oaCMAttr (  const oaString &    nameIn ) 
 

This oaCMAttr constructor takes a name only (its value is unset).

Parameters:
nameIn The name to set on this attribute.

oaCMAttr::oaCMAttr (  const oaString &    nameIn,
const oaString &    valueIn
) 
 

This oaCMAttr constructor takes both the name and the value for the attribute as arguments.

Parameters:
nameIn The name to set on this attribute.
valueIn The value to set on this attribute.

oaCMAttr::oaCMAttr (  const oaCMAttr &    attrIn ) 
 

This is the oaCMAttr copy constructor.

Parameters:
attrIn The attribute to copy.

Member Function Documentation

const oaString & oaCMAttr::getName (    )  const
 

This function returns the name of this attribute.

const oaString & oaCMAttr::getValue (    )  const
 

This function returns the value of this attribute.

oaBoolean oaCMAttr::isUnset (    )  const
 

This function returns true if the value of the attribute is not set.

oaBoolean oaCMAttr::operator!= (  const oaCMAttr &    attr )  const
 

This is the oaCMAttr inequality operator. It returns true if either the name or value of the specified attr is not the same as the name or value of this attribute.

Parameters:
attr The attribute to compare to this attribute.

oaCMAttr & oaCMAttr::operator= (  const oaCMAttr &    rhs ) 
 

This is the oaCMAttr assignment operator.

Parameters:
rhs The attribute to assign to this attribute.

oaBoolean oaCMAttr::operator== (  const oaCMAttr &    attr )  const
 

This is the oaCMAttr equality operator. It returns true if the name and value of the specified attr are the same as the name and value of this attribute.

Parameters:
attr The attribute to compare to this attribute.

void oaCMAttr::setValue (  const oaString &    valueIn ) 
 

This function sets the value of this attribute to valueIn.

Parameters:
valueIn The value to set on this attribute.

Friends And Related Function Documentation

friend class oaArray [friend]
 

friend class oaArrayBase [friend]
 

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.