libFAUDES

Sections

Index

faudes::Parameter Class Reference

#include <rtifncts.h>

List of all members.


Detailed Description

Structure to model a parameter type within the Signature of a Function.

A Parameter is made of a descriptive name, a faudes type and an io-attribute. The latter specifies whether the parameter is an input or output of the corresponding function.

Public Types

enum  ParamAttr { In, Out, InOut, UnDef }
 A function parameter has has one out of four so called io-attrributes;. More...

Public Member Functions

 Parameter (void)
 Constructor, default.
 Parameter (const std::string &rName, const std::string &rTypeName, ParamAttr attr)
 Constructor, by member values.
 ~Parameter (void)
 Desctructor.
std::string Str (void) const
 Convenience method to produce a textual representation of a parameter.
void Clear ()
 Set to "undefined".

Static Public Member Functions

static std::string AStr (Parameter::ParamAttr attr)
 Convenience method to produce a textual representation of an io attribute.

Public Attributes

std::string mName
 Name.
std::string mTDName
 Faudes type.
ParamAttr mAttr
 IO-Attribute.


Member Enumeration Documentation

A function parameter has has one out of four so called io-attrributes;.

Enumerator:
In 
Out 
InOut 
UnDef 


Constructor & Destructor Documentation

faudes::Parameter::Parameter ( void   )  [inline]

Constructor, default.

faudes::Parameter::Parameter ( const std::string &  rName,
const std::string &  rTypeName,
ParamAttr  attr 
) [inline]

Constructor, by member values.

faudes::Parameter::~Parameter ( void   )  [inline]

Desctructor.


Member Function Documentation

static std::string faudes::Parameter::AStr ( Parameter::ParamAttr  attr  )  [inline, static]

Convenience method to produce a textual representation of an io attribute.

Parameters:
attr Enum value denoting the attribute.
Returns:
Parameter IO attribute as std::string

std::string faudes::Parameter::Str ( void   )  const [inline]

Convenience method to produce a textual representation of a parameter.

void faudes::Parameter::Clear (  )  [inline]

Set to "undefined".


Member Data Documentation

Name.

Faudes type.


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

libFAUDES 2.13a c++ source docu by doxygen 1.5.6