oaParamType Class Reference


Public Methods
	oaParamType (oaParamTypeEnum typeIn)
	oaParamType (const oaString &name)
	~oaParamType ()
const oaString &	getName () const
	operator oaParamTypeEnum () const

Detailed Description

The oaParamType class is an enum wrapper class that has values that specify the type of a given oaParam object. See oaParam::getType for its usage.

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

enum oaParamTypeEnum

Enumeration values:

oacIntParamType "intParam"

oacFloatParamType "floatParam"

oacStringParamType "stringParam"

oacAppParamType "appParam"

oacDoubleParamType "doubleParam"

oacBooleanParamType "booleanParam"

oacTimeParamType "timeParam"

Constructor & Destructor Documentation

oaParamType::oaParamType ( oaParamTypeEnum typeIn ) [inline]

This function constructs an instance of an oaParamType class using the specified oaParamTypeEnum value 'typeIn'.

oaParamType::oaParamType ( const oaString & name )

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

Parameters:

name A reference to an oaString object representing a valid parameter type name

Exceptions:

oacInvalidParamTypeName

oaParamType::~oaParamType ( ) [inline]

This is the destructor for this oaParamType object.

Member Function Documentation

const oaString & oaParamType::getName ( ) const

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

oaParamType::operator oaParamTypeEnum ( ) const [inline]

This operator casts this oaParamType object into the corresponding oaParamTypeEnum value.

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

Return to top of page

oaParamType Class Reference

Public Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation