oaScalarName Class Reference

Inheritance diagram for oaScalarName:

Public Methods
	oaScalarName ()
	oaScalarName (const oaNameSpace &nSpace, const oaChar *in)
	oaScalarName (const oaScalarName &in)
void	init (const oaNameSpace &nSpace, const oaChar *in)
void	get (const oaNameSpace &nSpace, oaString &out) const
void	get (oaString &out) const
oaUInt4	getNumBits () const
oaScalarName &	operator= (const oaScalarName &name)
void	append (const oaNameMem &in)
oaBoolean	operator== (const oaScalarName &name) const
oaBoolean	operator!= (const oaScalarName &name) const
Friends
class	oaNameTbl
class	oaVectorBitName
class	oaVectorName

---

Detailed Description

The oaScalarName utility class represents the name of an object that has no associated index. It is one of the oaName related classes that hold names for objects that can be mapped to various name spaces. Scalar names can be hierarchical. In conjunction with oaNameSpace objects, this class facilitates mapping names from one namespace to another. See the Name Mapping Section in the Programmers Guide for more information about mapping names between different namespaces.

For developers implementing a new namespace, the new namespace must provide support for scalar names.

---

Constructor & Destructor Documentation

oaScalarName::oaScalarName (    )  [inline]

This function constructs an empty oaScalarName object.

oaScalarName::oaScalarName (  const oaNameSpace &    nSpace, const oaChar *    in )

This function constructs an oaScalarName object, evaluating the specified input string in the specified nameSpace. Parameters: nSpace  The nameSpace in which to evaluate the string in  The input string to evaluate Exceptions: oacInvalidNameLength  oacInvalidNameSyntax

oaScalarName::oaScalarName (  const oaScalarName &    name )

This function constructs a copy of an oaScalarName object that is identical to the specified oaScalarName.

---

Member Function Documentation

void oaScalarName::append (  const oaNameMem &    in )

This function appends the specified member to this name. Parameters: in  The member to append.

void oaScalarName::get (  oaString &    out )  const

This function returns this name mapped into the oaNative nameSpace. Parameters: out  The string in which to output the mapped name

void oaScalarName::get (  const oaNameSpace &    nSpace, oaString &    out )  const

This function returns this name mapped into the specified nameSpace. Parameters: nSpace  The nameSpace in which to map this name out  The string in which to output the mapped name

oaUInt4 oaScalarName::getNumBits (    )  const [inline]

This function returns the number of bits this scalar name represents. It returns 0 if this scalar name is empty, and 1 otherwise.

void oaScalarName::init (  const oaNameSpace &    nSpace, const oaChar *    in )

This function initializes the oaScalarName object by clearing previously stored name data, then re-initializes its value to the string specified by in, evaluating it in the specified nameSpace. This allows reuse of the oaName object to improve application performance and capacity. Parameters: nSpace  The nameSpace in which to evaluate the string in  The input string to evaluate Exceptions: oacInvalidNameLength  oacInvalidNameSyntax

oaBoolean oaScalarName::operator!= (  const oaScalarName &    name )  const [inline]

This function compares the specified oaScalarName object with this oaScalarName object. If the two oaScalarName objects are the same, this function returns false; otherwise, this function returns true. Parameters: name  The oaScalarName object to compare

oaScalarName & oaScalarName::operator= (  const oaScalarName &    name )

This function is the assignment operator that copies the specified oaScalarName object and returns it. The function copies all member data so the duplicate does not rely on information from the original.

oaBoolean oaScalarName::operator== (  const oaScalarName &    name )  const [inline]

This function compares the specified oaScalarName object with this oaScalarName object. If the two oaScalarName objects are the same, this function returns true; otherwise, this function returns false. Parameters: name  The oaScalarName object to compare

---

Friends And Related Function Documentation

friend class oaNameTbl [friend]

Reimplemented from oaNameBase.

friend class oaVectorBitName [friend]

friend class oaVectorName [friend]

---

The documentation for this class was generated from the following files:

• oaName.h
• oaName.inl
• oaName.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.