oaBitOrder Class Reference


Public Methods

 oaBitOrder (oaBitOrderEnum valueIn)
 oaBitOrder (const oaString &name)
const oaStringgetName () const
 operator oaBitOrderEnum () const

Detailed Description

The oaBitOrder class encapsulates the enumerated values that specify the bit order for the following vectored objects:

For example, A[9:1] and A[0:7] are both legal bus names. oaBitOrder provides information about whether the vector definition should be interpreted as A[9:0] or A[0:9]. The bit order of an explicit vector definition is independent of the order within individual objects with the same base name. For example, the bit order of an explicit oaBusNetDef is independent of the order within individual oaBusNets with the same base name. Verilog requires a single wire declaration for a given base name, and the range of that declaration covers all of the bit indices used by the sub-ranges that correspond to oaBusNets.

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

enum oaBitOrderEnum
 

Enumeration values:
oacNoneBitOrder  "none"
Specifies that the bus definition has no bit order.
oacAscendingBitOrder  "ascending"
Specifies that the bus definition has an ascending bit order. The interpretation of the range of the bits in the bus definition should be from minIndex to maxIndex.
oacDescendingBitOrder  "descending"
Specifies that the bus definition has a descending bit order. The interpretation of the range of the bits in the bus definition should be from maxIndex to minIndex.


Constructor & Destructor Documentation

oaBitOrder::oaBitOrder oaBitOrderEnum    valueIn [inline]
 

This function constructs an instance of an oaBitOrder object using the specified oaBitOrderEnum value.

oaBitOrder::oaBitOrder const oaString &    name
 

This function constructs an instance of an oaBitOrder object using the oaBitOrderEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaBitOrderEnum.

Exceptions:
oacInvalidBitOrderName 


Member Function Documentation

const oaString & oaBitOrder::getName   const
 

This function returns the name string associated with the encapsulated oaBitOrderEnum value.

oaBitOrder::operator oaBitOrderEnum   const [inline]
 

This operator casts this oaBitOrder into its corresponding oaBitOrderEnum value.


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

Return to top of page