oaGroupType Class Reference


Public Methods

 oaGroupType (oaGroupTypeEnum valueIn)
 oaGroupType (const oaString &name)
 ~oaGroupType ()
const oaStringgetName () const
 operator oaGroupTypeEnum () const

Detailed Description

The oaGroupType class is an enum wrapper that indicates if an oaGroup object is a collection or a set. An object may occur more than once in a collection, but only once in a set (see oaGroup for additional information).

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

enum oaGroupTypeEnum
 

Enumeration values:
oacCollectionGroupType  "collection" An object may occur more than once in the group
oacSetGroupType  "set" Each object may only occur once in the group


Constructor & Destructor Documentation

oaGroupType::oaGroupType oaGroupTypeEnum    valueIn [inline]
 

This function constructs an instance of an oaGroupType class using the specified oaGroupTypeEnum value.

oaGroupType::oaGroupType const oaString &    name
 

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

Exceptions:
oacInvalidGroupTypeName 

oaGroupType::~oaGroupType   [inline]
 

This function destroys this oaGroupType class.


Member Function Documentation

const oaString & oaGroupType::getName   const
 

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

oaGroupType::operator oaGroupTypeEnum   const [inline]
 

This operator casts this oaGroupType into the corresponding oaGroupTypeEnum value.


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

Return to top of page