oaModModuleScalarInst Class Reference

Inheritance diagram for oaModModuleScalarInst:

oaModModuleBitInst oaModModuleInst oaModInst oaModObject oaDesignObject oaObject


Public Methods

void getName (oaScalarName &name) const
void setName (const oaScalarName &name)
void getName (oaSimpleName &name) const
void getName (const oaNameSpace &ns, oaString &name) const

Static Public Methods

oaModModuleScalarInst * create (oaModule *module, oaModule *master, const oaScalarName &name)
oaModModuleScalarInst * create (oaModule *module, oaModule *master)
oaModModuleScalarInst * create (oaModule *module, const oaScalarName &masterModName, const oaScalarName &name)
oaModModuleScalarInst * create (oaModule *module, const oaScalarName &masterModName)
oaModModuleScalarInst * find (const oaModule *module, const oaScalarName &name)
oaBoolean isValidName (const oaModule *module, const oaScalarName &name)

Detailed Description

The oaModModuleScalarInst class implements a scalar instance of a module master in a module hierarchy. The module containing the instance, the instance, and its master are always contained with the same oaDesign.

Member Function Documentation

oaModModuleScalarInst * oaModModuleScalarInst::create (  oaModule *    module,
const oaScalarName &    masterModuleName
)  [static]
 

This function creates an oaModModuleScalarInst object with the specified attributes. This form of the create specifies the name of the master module so that the master module does not need to exist to use it. The name of the instance is automatically generated.

Parameters:
module The module in which to create the instance
masterModuleName The name of the master module

oaModModuleScalarInst * oaModModuleScalarInst::create (  oaModule *    module,
const oaScalarName &    masterModuleName,
const oaScalarName &    name
)  [static]
 

This function creates an oaModModuleScalarInst object with the specified attributes. This form of the create specifies the name of the master module so that the master module does not need to exist to use it.

Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exists with the given name

Parameters:
module The module in which to create the instance
masterModuleName The name of the master module
name The name of the instance
Exceptions:
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

oaModModuleScalarInst * oaModModuleScalarInst::create (  oaModule *    module,
oaModule *    master
)  [static]
 

This function creates an oaModModuleScalarInst object with the specified attributes. This form of the create requires an existing master module. The name of the instance is automatically generated.

Parameters:
module The parent module in which to create the instance
master The master for the instance
Exceptions:
oacModulesNotInSameDesign 

oaModModuleScalarInst * oaModModuleScalarInst::create (  oaModule *    module,
oaModule *    master,
const oaScalarName &    name
)  [static]
 

This function creates an oaModModuleScalarInst object with the specified attributes. This form of the create specifies the master module so that the master module needs to exist to use it.

Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exists with the given name

Parameters:
module The module in which to create the instance
master The master for the instance
name The instance name
Exceptions:
oacModulesNotInSameDesign 
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

oaModModuleScalarInst * oaModModuleScalarInst::find (  const oaModule *    module,
const oaScalarName &    name
)  [static]
 

This function searches the specified module for a module scalar inst with the specified name. The function returns the instance if it finds one. Otherwise, NULL is returned.

Parameters:
module The module in which to search for the instance
name The instance name
Returns:
The oaModModuleScalarInst pointer or NULL

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 oaModModuleScalarInst::getName (  oaScalarName &    name )  const
 

This function returns the name of this scalarModuleInst in the name argument.

oaBoolean oaModModuleScalarInst::isValidName (  const oaModule *    module,
const oaScalarName &    name
)  [static]
 

This function returns a boolean value that indicates if the specified name is valid for a new oaModModuleScalarInst in the specified module.

Parameters:
module The module in which to validate the name
name The instance name to validate

void oaModModuleScalarInst::setName (  const oaScalarName &    name ) 
 

This function changes the name of this instance to the specified name.

Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exists with the given name

Parameters:
name The new name to be set for this instance.
Exceptions:
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

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.