Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members  

mpcl::text::codegen::TVariableString Class Reference

#include <variable_string.hh>

List of all members.

Public Types

enum  EType { eNormal, eOptional, eFile }
 Variable type type. More...


Public Methods

 TVariableString (void)
 Builds a new instance.

 TVariableString (const char *pkcTEXT)
 TVariableString (const char *pkcTEXT, size_t zMAX_LENGTH)
 TVariableString (const TString &rkySOURCE, EType eSOURCE_TYPE=eNormal)
 TVariableString (const TVariableString &rkySOURCE_VARIABLE)
void setType (EType eSOURCE_TYPE)
TVariableString & operator= (const TVariableString &rkySOURCE_VARIABLE)
TVariableString & operator= (const TString &rkySOURCE)
EType type (void) const

Protected Attributes

EType eType
 Variable type.

Detailed Description

Variable string for pattern based code generator.
See also:
TPatternBasedCodeGenerator.

Definition at line 48 of file variable_string.hh.

Member Enumeration Documentation

enum mpcl::text::codegen::TVariableString::EType
 

Variable type type.

Enumeration values:
eNormal  Variables that must be present in the clause body.
eOptional  These variables doesn't need to be present.
eFile  Variables that are going to hold file data.

Definition at line 54 of file variable_string.hh.

Referenced by TVariableString().

Constructor & Destructor Documentation

mpcl::text::codegen::TVariableString::TVariableString (  const char *    pkcTEXT )  [inline]
 

Builds a new instance from pkcTEXT.

Parameters:
pkcTEXT  Source text.

Definition at line 83 of file variable_string.hh.

References eNormal, eType, and mpcl::text::TString.

mpcl::text::codegen::TVariableString::TVariableString (  const char *    pkcTEXT,
size_t    zMAX_LENGTH
)  [inline]
 

Builds a new instance from pkcTEXT with maximum zMAX_LENGTH length.

Parameters:
pkcTEXT  Source text.
zMAX_LENGTH  Maximum length readable from pkcTEXT.

Definition at line 93 of file variable_string.hh.

References eNormal, eType, and mpcl::text::TString.

mpcl::text::codegen::TVariableString::TVariableString (  const TString &    rkySOURCE,
EType    eSOURCE_TYPE = eNormal
)  [inline]
 

Builds a new instance from rkySOURCE with type eSOURCE_TYPE.

Parameters:
rkySOURCE  Source string.
eSOURCE_TYPE  Source variable type.

Definition at line 102 of file variable_string.hh.

References eNormal, eType, EType, and mpcl::text::TString.

mpcl::text::codegen::TVariableString::TVariableString (  const TVariableString &    rkySOURCE_VARIABLE )  [inline]
 

Builds a new instance from rkySOURCE_VARIABLE.

Parameters:
rkySOURCE_VARIABLE  Source instance.

Definition at line 110 of file variable_string.hh.

References eType, and mpcl::text::TString.

Member Function Documentation

mpcl::text::codegen::TVariableString & mpcl::text::codegen::TVariableString::operator= (  const TString &    rkySOURCE ) 
 

Copies rkySOURCE string onto this.

Parameters:
rkySOURCE  Source string.
Returns:
This instance.

Definition at line 54 of file variable_string.cc.

References mpcl::text::TString.

mpcl::text::codegen::TVariableString & mpcl::text::codegen::TVariableString::operator= (  const TVariableString &    rkySOURCE_VARIABLE ) 
 

Copies rkySOURCE_VARIABLE instance onto this.

Parameters:
rkySOURCE_VARIABLE  Source instance.
Returns:
This instance.

Definition at line 43 of file variable_string.cc.

References eType.

void mpcl::text::codegen::TVariableString::setType (  EType    eSOURCE_TYPE ) 
 

Sets variable type.

Parameters:
eSOURCE_TYPE  Source variable type.

Definition at line 34 of file variable_string.cc.

References eType.

mpcl::text::codegen::TVariableString::EType mpcl::text::codegen::TVariableString::type (  void    )  const
 

Returns variable type.

Returns:
Variable type.

Definition at line 68 of file variable_string.cc.

References eType.

The documentation for this class was generated from the following files:
Generated on Mon Oct 13 02:35:26 2003 for MPCL by doxygen1.2.18