oaAlignmentType Class Reference


Public Methods

 oaAlignmentType (oaAlignmentTypeEnum typeIn)
 oaAlignmentType (const oaString &name)
 ~oaAlignmentType ()
const oaStringgetName () const
 operator oaAlignmentTypeEnum () const

Detailed Description

The oaAlignmentType class is an enum wrapper class for oaAlignmentTypeEnum values.

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

enum oaAlignmentTypeEnum
 

Enumeration values:
oacInsideAlignmentType  "inside"
oacOutsideAlignmentType  "outside"
oacInsideOutsideAlignmentType  "insideOutside"


Constructor & Destructor Documentation

oaAlignmentType::oaAlignmentType oaAlignmentTypeEnum    typeIn [inline]
 

This is a constructor for the oaAlignmentType wrapper class that takes an enum value as input.

Parameters:
typeIn The type of alignment, which is represented by an oaAlignmentTypeEnum.

oaAlignmentType::oaAlignmentType const oaString &    name
 

This is a constructor for the oaAlignmentType wrapper class, which takes a string value of an oaAlignmentTypeEnum.

Parameters:
name The string value of an oaAlignmnetTypeEnum.
Exceptions:
oacInvalidAlignmentTypeName 

oaAlignmentType::~oaAlignmentType   [inline]
 

This is the destructor for this enum wrapper class.


Member Function Documentation

const oaString & oaAlignmentType::getName   const
 

This function returns the string name that corresponds to an oaAlignmentTypeEnum value.

oaAlignmentType::operator oaAlignmentTypeEnum   const [inline]
 

This function returns the enum value of the enum wrapper class object.


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

Return to top of page