xsil::comment Class Reference
[Xsil document preparation]

#include <comment.hh>

Inheritance diagram for xsil::comment:

xsil::xobj

List of all members.

Public Member Functions

 comment (void)
 comment (const char *Text)
 ~comment (void)
void Spew (Xwriter &xout) const
commentClone (void) const
const char * getText (void) const
const char * getObjType (void) const
void setText (const char *Text)


Detailed Description

XSIL comment field definition. brief XSIL comment field.
Author:
J. Zweizig
Version:
1.1; Modified December 13, 1999

Constructor & Destructor Documentation

xsil::comment::comment ( void   ) 

Default constructer. brief Default constructor.

xsil::comment::comment ( const char *  Text  ) 

Comment constructer. brief Comment constructor.

Parameters:
Text Comment text pointer.

xsil::comment::~comment ( void   ) 

Destructer. brief Destructor.


Member Function Documentation

void xsil::comment::Spew ( Xwriter xout  )  const [virtual]

Write the Comment to an XML file. brief write Comment to an XML file.

Parameters:
xout XSIL writer to receive the comment definition.

Implements xsil::xobj.

comment* xsil::comment::Clone ( void   )  const [virtual]

Clone a comment block. brief Clone the comment object.

Returns:
Pointer to the cloned object.

Implements xsil::xobj.

const char* xsil::comment::getText ( void   )  const

Get the comment text. brief get the comment text.

Returns:
Pointer to the comment text.

const char* xsil::comment::getObjType ( void   )  const [virtual]

Get the object type. brief Get the object type.

Returns:
Pointer to the type string.

Implements xsil::xobj.

void xsil::comment::setText ( const char *  Text  ) 

Set the comment text. brief Set the object text.

Parameters:
Text Pointer to the text string.


The documentation for this class was generated from the following file:
Generated on Sun Mar 8 19:21:48 2009 for dmt by  doxygen 1.5.4