oaTermType Class Reference


Public Methods

 oaTermType (oaTermTypeEnum valueIn)
 oaTermType (const oaString &name)
 ~oaTermType ()
const oaStringgetName ()
 operator oaTermTypeEnum () const
const oaStringgetName () const

Detailed Description

The oaTermType class encapsulates the enumerated values that describe the different uses of an oaTerm object.

enum oaTermTypeEnum
 

Enumeration values:
oacInputTermType  "input"
oacOutputTermType  "output"
oacInputOutputTermType  "inputOutput"
oacSwitchTermType  "switch"
oacJumperTermType  "jumper"
oacUnusedTermType  "unused"
oacTristateTermType  "tristate"


Constructor & Destructor Documentation

oaTermType::oaTermType oaTermTypeEnum    valueIn [inline]
 

This function constructs an instance of an oaTermType class using the specified oaTermTypeEnum value.

oaTermType::oaTermType const oaString &    name
 

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

Exceptions:
oacInvalidTermTypeName This exception is thrown if no matching name is found

oaTermType::~oaTermType   [inline]
 

This function destroys this oaTermType class.


Member Function Documentation

oaString & oaTermType::getName   const
 

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

const oaString & oaTermType::getName  
 

This function is deprecated. Use the const version of oaTermType::getName instead.

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

oaTermType::operator oaTermTypeEnum   const [inline]
 

This operator casts this oaTermType object into the corresponding oaTermTypeEnum value.


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

Return to top of page