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.

Definition at line 40 of file rtifncts.h.


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 

Definition at line 47 of file rtifncts.h.


Constructor & Destructor Documentation

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

Constructor, default.

Definition at line 55 of file rtifncts.h.

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

Constructor, by member values.

Definition at line 58 of file rtifncts.h.

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

Desctructor.

Definition at line 62 of file rtifncts.h.


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

Definition at line 72 of file rtifncts.h.

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

Convenience method to produce a textual representation of a parameter.

Definition at line 86 of file rtifncts.h.

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

Set to "undefined".

Definition at line 94 of file rtifncts.h.


Member Data Documentation

Name.

Definition at line 98 of file rtifncts.h.

Faudes type.

Definition at line 104 of file rtifncts.h.

IO-Attribute.

Definition at line 107 of file rtifncts.h.


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

libFAUDES 2.14g --- 2009-12-3 --- c++ source docu by doxygen 1.5.6