oaDualInt Class Reference


Public Methods

 oaDualInt (oaInt4 firstValue=0, oaInt4 secondValue=0)
oaInt4 getFirst () const
oaInt4 getSecond () const
void setFirst (oaInt4 value)
void setSecond (oaInt4 value)
oaBoolean operator== (const oaDualInt &right)
oaBoolean operator!= (const oaDualInt &right)
oaBoolean operator== (const oaDualInt &right) const
oaBoolean operator!= (const oaDualInt &right) const

Friends

class oaChecker< oaDualInt >

Detailed Description

The oaDualInt object specifies an ordered pair of oaInt4 values.

Constructor & Destructor Documentation

oaDualInt::oaDualInt (  oaInt4    firstValue = 0,
oaInt4    secondValue = 0
)  [inline]
 

This is the oaDualInt constructor class.

Parameters:
firstValue The first value of this integer pair.
secondValue The second value of this integer pair.

Member Function Documentation

oaInt4 oaDualInt::getFirst (    )  const [inline]
 

This function returns the first value in the pair.

oaInt4 oaDualInt::getSecond (    )  const [inline]
 

This function returns the second value in the pair.

oaBoolean oaDualInt::operator!= (  const oaDualInt &    right )  const [inline]
 

This comparison operator returns a boolean that indicates whether the specified right dualInt object is not equal to this object.

Parameters:
right dualInt to compare to this dualInt

oaBoolean oaDualInt::operator!= (  const oaDualInt &    right )  [inline]
 

oaBoolean oaDualInt::operator== (  const oaDualInt &    right )  const [inline]
 

This comparison operator returns a boolean that indicates whether the specified right dualInt object is equal to this object or not.

Parameters:
right dualInt to compare to this dualInt

oaBoolean oaDualInt::operator== (  const oaDualInt &    right )  [inline]
 

void oaDualInt::setFirst (  oaInt4    value )  [inline]
 

This function sets the first value in the pair.

Parameters:
value The value to be set as the first value of this pair.

void oaDualInt::setSecond (  oaInt4    value )  [inline]
 

This function sets the second value in the pair.

Parameters:
value The value to be set as the second value of this pair

Friends And Related Function Documentation

friend class oaChecker< oaDualInt > [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.