oaDefNS Class Reference

Inheritance diagram for oaDefNS:

oaLefNS oaNameSpace


Protected Methods

virtual oaBoolean isEqual (const oaVectorName &n1, const oaVectorBitName &n2) const
virtual void getInternalVector (const oaChar *in, oaVectorName &out, oaBoolean baseOnly=false) const
virtual void getVectorName (const oaVectorName &in, oaString &out, oaUInt4 &loc) const

Detailed Description

The oaDefNS class implements the DEF nameSpace used in name mapping. The DEF name space reflects the rules for specifying legal names in DEF files. In conjunction with the oaName object, the oaDefNS class facilitates mapping names to and from DEF. See the Name Mapping Section of the Programmers Guide for more information.

The DEF nameSpace does not support vectored or stepped names, though it supports vector bit names. This nameSpace is case sensitive with programmable bus characters. DEF has a programmable hierarchy character. See its parent class oaLefNS for the functions that set and get the bus and hierarchy characters. Since keywords in DEF are position-sensitive, they are valid as names. See the LEF/DEF Name Space Section of the Programmers Guide for a more detailed description of the characteristics of the DEF name space.

Member Function Documentation

virtual void oaDefNS::getInternalVector (  const oaChar *    in,
oaVectorName &    out,
oaBoolean    baseOnly = false
)  const [protected, virtual]
 

This function returns in out, the input string mapped into the internal name space. If the value of baseOnly is false, the string is interpreted as an entire vector name. If the value is true, in is interpreted as the base of the vector bit name. Derived name spaces that support vector names should reimplement this function.

Parameters:
in The input string representing a vector name in this name space
out The output vector name object created from mapping input string into the native name space
baseOnly Determines if the input string is an entire vector name or just the base value
Exceptions:
oacVectorNameInvalid 

Reimplemented from oaLefNS.

virtual void oaDefNS::getVectorName (  const oaVectorName &    in,
oaString &    out,
oaUInt4 &    loc
)  const [protected, virtual]
 

This function returns in the string out, at the location loc, the input vector name in mapped into this name space. It is assumed the input name is in the native name space format. Derived name spaces that support vector names should reimplement this function.

Parameters:
in The input vector name
out The string value of the vector name in this name space
loc The location in out at which the function starts writing
Exceptions:
oacVectorNameInvalid 

Reimplemented from oaLefNS.

oaBoolean oaDefNS::isEqual (  const oaVectorName &    n1,
const oaVectorBitName &    n2
)  const [protected, virtual]
 

This function returns a boolean indicating whether or not the two specified names are equal in this namespace.

Parameters:
n1 The oaVectorName to compare
n2 The oaVectorBitName to compare

Reimplemented from oaLefNS.

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.