# Coriolis Core (CRLCore) Documentation

# Coriolis Core (CRL) Documentation

Static Public Member Functions | List of all members
CRL::CatalogExtension Class Reference

Wrapper to access a Hurricane::Cell Catalog::State. More...

## Static Public Member Functions

static bool | isFeed (const Cell *)
static bool | isPad (const Cell *)
static bool | isGds (const Cell *)
static bool | isDelete (const Cell *)
static bool | isPhysical (const Cell *)
static bool | isLogical (const Cell *)
static unsigned int | getFlags (const Cell *, unsigned int mask=(unsigned int) -1)
static bool | setFlags (const Cell *, unsigned int mask, bool value)
static bool | setFeed (const Cell *, bool value)
static bool | setPad (const Cell *, bool value)
static bool | setGds (const Cell *, bool value)
static bool | setDelete (const Cell *, bool value)
static bool | setPhysical (const Cell *, bool value)
static bool | setLogical (const Cell *, bool value)
static Library * | getLibrary (const Cell *)
static unsigned int | getDepth (const Cell *)
static Library * | setLibrary (const Cell *, Library *library)

## Detailed Description

Wrapper to access a Hurricane::Cell Catalog::State.

Catalog::State are stored inside the AllianceFramework Catalog but also linked in a Property on the Hurricane::Cell for easier access. The CatalogExtension is a small wrapper around the Property mechanism to allow a simpler access.

## Member Function Documentation

## ◆ isFeed()

bool CRL::CatalogExtension::isFeed | ( | const Cell * | cell | ) |

inlinestatic

Returns: true if the Cell is a feed-through.

References CRL::Catalog::State::isFeed().

## ◆ isPad()

bool CRL::CatalogExtension::isPad | ( | const Cell * | cell | ) |

inlinestatic

Returns: true if the Cell is a pad.

References CRL::Catalog::State::isPad().

## ◆ isGds()

bool CRL::CatalogExtension::isGds | ( | const Cell * | cell | ) |

inlinestatic

Returns: true if the Cell is drawn in real layer (i.e. not a symbolic layout, but a GDS).

References CRL::Catalog::State::isGds().

## ◆ isDelete()

bool CRL::CatalogExtension::isDelete | ( | const Cell * | cell | ) |

inlinestatic

Returns: true if the Cell has been deleted from memory.

References CRL::Catalog::State::isDelete().

## ◆ isPhysical()

bool CRL::CatalogExtension::isPhysical | ( | const Cell * | cell | ) |

inlinestatic

Returns: true if the Cell posseses a physical view (layout).

References CRL::Catalog::State::isPhysical().

## ◆ isLogical()

bool CRL::CatalogExtension::isLogical | ( | const Cell * | cell | ) |

inlinestatic

Returns: true if the Cell posseses a logical view (netlist).

References CRL::Catalog::State::isLogical().

## ◆ getFlags()

unsigned int CRL::CatalogExtension::getFlags | ( | const Cell * | cell,
|  | unsigned int | mask = `(unsigned int)-1`
| ) |  |

inlinestatic

Returns: the requested flags states (selected by `mask`, all of them by default).

References CRL::Catalog::State::getFlags().

## ◆ setFlags()

bool CRL::CatalogExtension::setFlags | ( | const Cell * | cell,
|  | unsigned int | mask,
|  | bool | value
| ) |  |

inlinestatic

Returns: true if at least one flag of the indicated by mask is set. (dubious usefulness).

`mask` is used to designate the bits of the flags on which we are going to operate. If `value` is true, then the bits are sets and if `value` is false they are reset.

References CRL::Catalog::State::setFlags().

## ◆ setFeed()

bool CRL::CatalogExtension::setFeed | ( | const Cell * | cell,
|  | bool | value
| ) |  |

inlinestatic

Sets the Feed flag to `value`. Returns true if it is set.

References CRL::Catalog::State::setFeed().

## ◆ setPad()

bool CRL::CatalogExtension::setPad | ( | const Cell * | cell,
|  | bool | value
| ) |  |

inlinestatic

Sets the Pad flag to `value`. Returns true if it is set.

References CRL::Catalog::State::setPad().

## ◆ setGds()

bool CRL::CatalogExtension::setGds | ( | const Cell * | cell,
|  | bool | value
| ) |  |

inlinestatic

Sets the Gds flag to `value`. Returns true if it is set.

References CRL::Catalog::State::setGds().

## ◆ setDelete()

bool CRL::CatalogExtension::setDelete | ( | const Cell * | cell,
|  | bool | value
| ) |  |

inlinestatic

Sets the Delete flag to `value`. Returns true if it is set.

References CRL::Catalog::State::setDelete().

## ◆ setPhysical()

bool CRL::CatalogExtension::setPhysical | ( | const Cell * | cell,
|  | bool | value
| ) |  |

inlinestatic

Sets the Physical flag to `value`. Returns true if it is set.

References CRL::Catalog::State::setPhysical().

## ◆ setLogical()

bool CRL::CatalogExtension::setLogical | ( | const Cell * | cell,
|  | bool | value
| ) |  |

inlinestatic

Sets the Logical flag to `value`. Returns true if it is set.

References CRL::Catalog::State::setLogical().

## ◆ getLibrary()

Hurricane::Library * CRL::CatalogExtension::getLibrary | ( | const Cell * | cell | ) |

inlinestatic

Returns: the associated Hurricane::Library.

References CRL::Catalog::State::getLibrary().

## ◆ getDepth()

unsigned int CRL::CatalogExtension::getDepth | ( | const Cell * | cell | ) |

inlinestatic

Returns: the hierarchical depth of the Cell.

References CRL::Catalog::State::getDepth().

## ◆ setLibrary()

Hurricane::Library * CRL::CatalogExtension::setLibrary | ( | const Cell * | cell,
|  | Hurricane::Library * | library
| ) |  |

inlinestatic

Sets the Library field. Returns the newly affected Library.

References CRL::Catalog::State::setLibrary().

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

- Catalog.h
- Catalog.dox