oaNameType Class Reference


Public Methods

 oaNameType (oaNameTypeEnum valueIn)
 oaNameType (const oaString &name)
 ~oaNameType ()
const oaString & getName () const
 operator oaNameTypeEnum () const

Detailed Description

The oaNameType class is an enum wrapper class that describes the different uses of an oaName object. The nameType is important when determining the syntactic rules for mapping the name object into different nameSpaces. See oaName::getType to see where this is used.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaNameTypeEnum
 

Enumeration values:
oacEmptyNameType  "empty" There is no name stored
oacScalarNameType  "scalarName" This name has no index
oacVectorNameType  "vectorName" This name contains an index range
oacVectorBitNameType  "vectorBitName" This name has a single index number
oacBundleNameType  "bundleName" This name has a list of name components or a repeat count

Constructor & Destructor Documentation

oaNameType::oaNameType (  oaNameTypeEnum    typeIn )  [inline]
 

This function constructs an instance of an oaNameType class using the specified oaNameTypeEnum value.

oaNameType::oaNameType (  const oaString &    name ) 
 

This function constructs an instance of an oaNameType class using the oaNameTypeEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaNameTypeEnum.

Exceptions:
oacInvalidNameTypeName 

oaNameType::~oaNameType (    )  [inline]
 

This function destroys this oaNameType class instance.

Member Function Documentation

const oaString & oaNameType::getName (    )  const
 

This function returns the name string associated with the encapsulated oaNameTypeEnum object.

oaNameType::operator oaNameTypeEnum (    )  const [inline]
 

This operator casts this oaName object into the corresponding oaNameTypeEnum value.

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.