oaModModuleVectorInstBit Class Reference

Inheritance diagram for oaModModuleVectorInstBit:

oaModModuleBitInst oaModModuleInst oaModInst oaModObject oaDesignObject oaObject


Public Methods

oaModVectorInstDef * getDef () const
oaUInt4 getBitIndex () const
void getName (oaVectorBitName &name) const
void setName (const oaScalarName &baseName, oaUInt4 bitIndex)
void getName (oaSimpleName &name) const
void getName (const oaNameSpace &ns, oaString &name) const

Static Public Methods

oaModModuleVectorInstBit * create (oaModule *module, oaModule *master, const oaScalarName &baseName, oaUInt4 bitIndex)
oaModModuleVectorInstBit * create (oaModule *module, const oaScalarName &masterName, const oaScalarName &baseName, oaUInt4 bitIndex)
oaModModuleVectorInstBit * find (const oaModule *module, const oaScalarName &baseName, oaUInt4 bitIndex)
oaBoolean isValidName (const oaModule *module, const oaScalarName &baseName, oaUInt4 bitIndex)

Detailed Description

The oaModModuleVectorInstBit class implements a single bit of a module vectorInst in a module. VectorInstBits are automatically created and destroyed as vectorInsts are created or destroyed. Implicitly-created vectorInstBits cannot be modified to insure consistency with its defining vectorInst.

Explicitly-created vectorInstBits define a unique bit of a vectorInst definition since the bits of a vectorInst are not allowed to overlap with other vectorInsts.

Member Function Documentation

oaModModuleVectorInstBit * oaModModuleVectorInstBit::create (  oaModule *    module,
const oaScalarName &    masterName,
const oaScalarName &    baseName,
oaUInt4    bitIndex
)  [static]
 

This function creates an oaModModuleVectorInstBit object with the specified attributes. The given baseName and bitIndex are checked if they are legal and do not specify an instance that already exists. This version creates an instance of the master implied by the specified module name.

Parameters:
module The module to create the instance in
masterName The name of the master module
baseName The base name to give the instance
bitIndex The bit index to give the instance
Exceptions:
oacInvalidHierInstName 
oacVectorInstBitNameMatchesAutoName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

oaModModuleVectorInstBit * oaModModuleVectorInstBit::create (  oaModule *    module,
oaModule *    master,
const oaScalarName &    baseName,
oaUInt4    bitIndex
)  [static]
 

This function creates an oaModModuleVectorInstBit object with the specified attributes. The given baseName and bitIndex are checked if they are legal and do not specify an instance that already exists. This version creates an instance of the specified master module.

Parameters:
module The module to create the instance in
master The master module to instantiate
baseName The base name to give the instance
bitIndex The bit index to give the instance
Exceptions:
oacInvalidHierInstName 
oacVectorInstBitNameMatchesAutoName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

oaModModuleVectorInstBit * oaModModuleVectorInstBit::find (  const oaModule *    module,
const oaScalarName &    baseName,
oaUInt4    bitIndex
)  [static]
 

This function searches the specified module looking for a vectorInstBit with the specified name and bitIndex. If the instance is found, it is returned; otherwise, NULL is returned.

Parameters:
module The module to search
baseName The base name of the instance to look for
bitIndex The bit index of the instance to look for

oaUInt4 oaModModuleVectorInstBit::getBitIndex (    )  const
 

This function returns the bitIndex of this vectorInstBit.

oaModVectorInstDef * oaModModuleVectorInstBit::getDef (    )  const
 

This function returns a pointer to the vectorInstDef for this vectorInstBit.

void oaModInst::getName (  const oaNameSpace &    ns,
oaString &    name
)  const
 

This function fills out name with the name of this instance. The name is mapped according to the specified nameSpace.

Parameters:
ns The nameSpace used to map the name
name The returned instance name

void oaModInst::getName (  oaSimpleName &    name )  const
 

This function fills out name with the name of this instance.

Parameters:
name The returned instance name

void oaModModuleVectorInstBit::getName (  oaVectorBitName &    name )  const
 

This function returns the vectorName of this modModuleVectorInstBit.

Parameters:
name The name fo the modModuleVectorInstBit to return

oaBoolean oaModModuleVectorInstBit::isValidName (  const oaModule *    module,
const oaScalarName &    baseName,
oaUInt4    bitIndex
)  [static]
 

This function returns a boolean indicating whether the specified baseName and bitIndex would be valid for an oaModVectorInstBit in the specified module.

Parameters:
module The module to search
baseName The base name to validate
bitIndex The bit index to validate

void oaModModuleVectorInstBit::setName (  const oaScalarName &    baseName,
oaUInt4    bitIndex
) 
 

This function changes the name of this vectorInstBit. An exception is thrown if the new baseName is the name of an existing scalar or array instance or if a vectorInstBit already exists with the new name. An exception is also thrown if the new name would overlap with existing vectorInsts.

Parameters:
baseName The new base name for this instance
bitIndex The new bit index for this instance
Exceptions:
oacCannotSetNameOfImplicitInst 

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.