oaSiteRef Class Reference


Public Methods

 oaSiteRef ()
 oaSiteRef (const oaString &siteName, const oaTransform &xform)
 oaSiteRef (const oaSiteRef &siteRefIn)
const oaString & siteName () const
const oaTransform & transform () const
oaString & siteName ()
oaTransform & transform ()
oaSiteRef & operator= (const oaSiteRef &dataIn)
oaBoolean operator== (const oaSiteRef &other)
oaBoolean operator!= (const oaSiteRef &other)
oaBoolean operator== (const oaSiteRef &other) const
oaBoolean operator!= (const oaSiteRef &other) const

Detailed Description

The oaSiteRef class implements a reference by name to a site and its placement. This is used for array sites, where each site that is part of an array site has its own placement.

Constructor & Destructor Documentation

oaSiteRef::oaSiteRef (    ) 
 

oaSiteRef::oaSiteRef (  const oaString &    siteName,
const oaTransform &    xform
) 
 

This function constructs the oaSiteRef object.

oaSiteRef::oaSiteRef (  const oaSiteRef &    siteRefIn ) 
 

This is the copy constructor for the oaSiteRef utility object.

Parameters:
siteRefIn the siteRef to be copied

Member Function Documentation

oaBoolean oaSiteRef::operator!= (  const oaSiteRef &    other )  const
 

This is the inequality operator for the oaSiteRef class. It compares this oaSiteRef object with the specified oaSiteRef object, and returns true if the oaSiteRef objects are unequal.

Parameters:
other The oaSiteRef object to compare

oaBoolean oaSiteRef::operator!= (  const oaSiteRef &    other ) 
 

This operator compares this oaSiteRef with oaSiteRef other and returns true if the oaSiteRef objects are not equal.

oaSiteRef & oaSiteRef::operator= (  const oaSiteRef &    dataIn ) 
 

This is the assignment operator for the oaSiteRef utility object

Parameters:
dataIn the siteRef to be assigned

oaBoolean oaSiteRef::operator== (  const oaSiteRef &    other )  const
 

This is the equality operator for the oaSiteRef class. It compares this oaSiteRef object with the specified oaSiteRef object, and returns true if the oaSiteRef objects are equal.

Parameters:
other The oaSiteRef object to compare

oaBoolean oaSiteRef::operator== (  const oaSiteRef &    other ) 
 

This operator compares this oaSiteRef with oaSiteRef other and returns true if the oaSiteRef objects are equal.

oaString & oaSiteRef::siteName (    )  [inline]
 

This function returns a reference to the siteName value of this oaSiteRef object.

const oaString & oaSiteRef::siteName (    )  const [inline]
 

This function returns the siteName value of this oaSiteRef object.

oaTransform & oaSiteRef::transform (    )  [inline]
 

This function returns a reference to the transform of this oaSiteRef object.

const oaTransform & oaSiteRef::transform (    )  const [inline]
 

This function returns the transform value of this oaSiteRef 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.