# SubstparamNode Class Reference
[Data classes]

`#include <nedelements.h>`

Inheritance diagram for SubstparamNode:

List of all members.

## Detailed Description

GENERATED CLASS.

Represents the <substparam> XML element in memory. DTD declaration:

     <!ELEMENT substparam (expression?)>
     <!ATTLIST substparam
          name                NMTOKEN   REQUIRED
          value               CDATA     IMPLIED
          banner-comment      CDATA     IMPLIED
          right-comment       CDATA     "&#10;" >

## Public Member Functions

Constructors, destructor
| SubstparamNode ()
| SubstparamNode (NEDElement *parent)
virtual | ~SubstparamNode ()
Redefined NEDElement methods, incl. generic access to attributes
virtual const char * | getTagName () const
virtual int | getTagCode () const
virtual int | getNumAttributes () const
virtual const char * | getAttributeName (int k) const
virtual const char * | getAttribute (int k) const
virtual void | setAttribute (int k, const char *val)
virtual const char * | getAttributeDefault (int k) const
Typed access to attributes, children and siblings
const char * | getName () const
void | setName (const char *val)
const char * | getValue () const
void | setValue (const char *val)
const char * | getBannerComment () const
void | setBannerComment (const char *val)
const char * | getRightComment () const
void | setRightComment (const char *val)
virtual SubstparamNode * | getNextSubstparamNodeSibling () const
virtual ExpressionNode * | getFirstExpressionChild () const

## Constructor & Destructor Documentation

SubstparamNode::SubstparamNode | ( |  | ) | `[inline]`

SubstparamNode::SubstparamNode | ( | NEDElement * | parent | ) | `[inline]`

virtual SubstparamNode::~SubstparamNode | ( |  | ) | `[inline, virtual]`

## Member Function Documentation

virtual const char* SubstparamNode::getAttribute | ( | int | k | ) | const`[virtual]`

| Pure virtual method, it should be redefined in subclasses to return the value of the kth attribute (i.e. the attribute with the name getAttributeName(k)). It should return NULL if k is out of range (i.e. negative or greater than getNumAttributes()). Implements NEDElement.

virtual const char* SubstparamNode::getAttributeDefault | ( | int | k | ) | const`[virtual]`

| Pure virtual method, it should be redefined in subclasses to return the default value of the kth attribute, as defined in the DTD. It should return NULL if k is out of range (i.e. negative or greater than getNumAttributes()). Implements NEDElement.

virtual const char* SubstparamNode::getAttributeName | ( | int | k | ) | const`[virtual]`

| Pure virtual method, it should be redefined in subclasses to return the name of the kth attribute as defined in the DTD. It should return NULL if k is out of range (i.e. negative or greater than getNumAttributes()). Implements NEDElement.

const char* SubstparamNode::getBannerComment | ( |  | ) | const`[inline]`

virtual ExpressionNode* SubstparamNode::getFirstExpressionChild | ( |  | ) | const`[virtual]`

const char* SubstparamNode::getName | ( |  | ) | const`[inline]`

virtual SubstparamNode* SubstparamNode::getNextSubstparamNodeSibling | ( |  | ) | const`[virtual]`

virtual int SubstparamNode::getNumAttributes | ( |  | ) | const`[virtual]`

| Pure virtual method, it should be redefined in subclasses to return the number of attributes defined in the DTD. Implements NEDElement.

const char* SubstparamNode::getRightComment | ( |  | ) | const`[inline]`

virtual int SubstparamNode::getTagCode | ( |  | ) | const`[inline, virtual]`

| Overridden in subclasses to return the numeric code (NED_xxx) of the XML element the class represents. Implements NEDElement.

virtual const char* SubstparamNode::getTagName | ( |  | ) | const`[inline, virtual]`

| Overridden in subclasses to return the name of the XML element the class represents. Implements NEDElement.

const char* SubstparamNode::getValue | ( |  | ) | const`[inline]`

virtual void SubstparamNode::setAttribute | ( | int | k,
|  | const char * | val
| ) | `[virtual]`

| Pure virtual method, it should be redefined in subclasses to set the value of the kth attribute (i.e. the attribute with the name getAttributeName(k)). If k is out of range (i.e. negative or greater than getNumAttributes()), the call should be ignored. Implements NEDElement.

void SubstparamNode::setBannerComment | ( | const char * | val | ) | `[inline]`

void SubstparamNode::setName | ( | const char * | val | ) | `[inline]`

void SubstparamNode::setRightComment | ( | const char * | val | ) | `[inline]`

void SubstparamNode::setValue | ( | const char * | val | ) | `[inline]`

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

- nedelements.h