oaManagedType Class Reference


Public Methods

 oaManagedType ()
 oaManagedType (oaTypeEnum valueIn)
 oaManagedType (oaAbstractTypeEnum valueIn)
 oaManagedType (const oaString &name)
 ~oaManagedType ()
const oaStringgetName () const
oaBoolean isConcrete () const
oaAbstractType getAbstractType () const
oaType getConcreteType () const
oaBoolean isValid (oaType testType) const
oaBoolean operator> (const oaManagedType &rhs) const
oaBoolean operator== (const oaManagedType &rhs) const
oaBoolean operator!= (const oaManagedType &rhs) const

Detailed Description

The oaManagedType class is an enum wrapper class for managed enum values, which are comprised of oaTypeEnum (concrete type enum) and oaAbstractTypeEnum (abstract type enum) values.

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


Constructor & Destructor Documentation

oaManagedType::oaManagedType   [inline]
 

This is the default constructor for the oaManagedType class enum wrapper. It constructs an object that encapsulates an oaManagedTypeEnum with the value oacUnknownType.

oaManagedType::oaManagedType oaTypeEnum    valueIn [inline]
 

This constructor for the oaManagedType class takes an oaTypeEnum (concrete type enum) value.

Parameters:
valueIn An oaTypeEnum concrete type enum value.

oaManagedType::oaManagedType oaAbstractTypeEnum    valueIn [inline]
 

This constructor for the oaManagedType class takes an oaAbstractTypeEnum (abstract type enum) value.

Parameters:
valueIn An oaAbstractTypeEnum type value.

oaManagedType::oaManagedType const oaString &    name
 

This function creates an instance of an oaManagedType object using the managed enum value associated with the specified string name. This name must be defined in the legal set of names associated with managed enums -- namely, valid concrete and abstract type enum names.

Parameters:
name The name of the managed enum type.
Exceptions:
oacInvalidObjectTypeName 

oaManagedType::~oaManagedType   [inline]
 

This function destroys this oaManagedType instance.


Member Function Documentation

oaAbstractType oaManagedType::getAbstractType   const [inline]
 

This function returns the abstract type that this class represents.

Exceptions:
oacInvalidAbstractType if this managed type represents a concrete type.

oaType oaManagedType::getConcreteType   const [inline]
 

This function returns the concrete type that this class represents.

Exceptions:
oacInvalidConcreteType if this managed type is not a concrete type.

const oaString & oaManagedType::getName   const
 

This function returns the name associated with this encapsulated oaManagedType object.

oaBoolean oaManagedType::isConcrete   const [inline]
 

This function returns true if this managed type encapsulates a concrete enum type.

oaBoolean oaManagedType::isValid oaType    testType const
 

This function returns true if the specified testType is a valid managed type.

Parameters:
testType The oaType that is being tested to determine whether or not it is a valid managed type.

oaBoolean oaManagedType::operator!= const oaManagedType &    rhs const [inline]
 

This function is the user-defined inequality operator.

Parameters:
rhs The oaManagedType to compare against.

oaBoolean oaManagedType::operator== const oaManagedType &    rhs const [inline]
 

This function is the user-defined equality operator.

Parameters:
rhs The oaManagedType to compare against.

oaBoolean oaManagedType::operator> const oaManagedType &    rhs const [inline]
 

This function is the user-defined greater-than operator.

Parameters:
rhs The oaManagedType to compare against.


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

Return to top of page