# SubmoduleNode Class Reference
[Data classes]

`#include <nedelements.h>`

Inheritance diagram for SubmoduleNode:

List of all members.

## Detailed Description

GENERATED CLASS.

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

     <!ELEMENT submodule (expression?, substmachines*, substparams*,
                          gatesizes*, display-string?)>
     <!ATTLIST submodule
          name                NMTOKEN   REQUIRED
          type-name           NMTOKEN   REQUIRED
          like-param          NMTOKEN   IMPLIED
          vector-size         CDATA     IMPLIED
          banner-comment      CDATA     IMPLIED
          right-comment       CDATA     "&#10;" >

## Public Member Functions

Constructors, destructor
| SubmoduleNode ()
| SubmoduleNode (NEDElement *parent)
virtual | ~SubmoduleNode ()
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 * | getTypeName () const
void | setTypeName (const char *val)
const char * | getLikeParam () const
void | setLikeParam (const char *val)
const char * | getVectorSize () const
void | setVectorSize (const char *val)
const char * | getBannerComment () const
void | setBannerComment (const char *val)
const char * | getRightComment () const
void | setRightComment (const char *val)
virtual SubmoduleNode * | getNextSubmoduleNodeSibling () const
virtual ExpressionNode * | getFirstExpressionChild () const
virtual SubstmachinesNode * | getFirstSubstmachinesChild () const
virtual SubstparamsNode * | getFirstSubstparamsChild () const
virtual GatesizesNode * | getFirstGatesizesChild () const
virtual DisplayStringNode * | getFirstDisplayStringChild () const

## Constructor & Destructor Documentation

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

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

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

## Member Function Documentation

virtual const char* SubmoduleNode::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* SubmoduleNode::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* SubmoduleNode::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* SubmoduleNode::getBannerComment | ( |  | ) | const`[inline]`

virtual DisplayStringNode* SubmoduleNode::getFirstDisplayStringChild | ( |  | ) | const`[virtual]`

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

virtual GatesizesNode* SubmoduleNode::getFirstGatesizesChild | ( |  | ) | const`[virtual]`

virtual SubstmachinesNode* SubmoduleNode::getFirstSubstmachinesChild | ( |  | ) | const`[virtual]`

virtual SubstparamsNode* SubmoduleNode::getFirstSubstparamsChild | ( |  | ) | const`[virtual]`

const char* SubmoduleNode::getLikeParam | ( |  | ) | const`[inline]`

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

virtual SubmoduleNode* SubmoduleNode::getNextSubmoduleNodeSibling | ( |  | ) | const`[virtual]`

virtual int SubmoduleNode::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* SubmoduleNode::getRightComment | ( |  | ) | const`[inline]`

virtual int SubmoduleNode::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* SubmoduleNode::getTagName | ( |  | ) | const`[inline, virtual]`

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

const char* SubmoduleNode::getTypeName | ( |  | ) | const`[inline]`

const char* SubmoduleNode::getVectorSize | ( |  | ) | const`[inline]`

virtual void SubmoduleNode::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 SubmoduleNode::setBannerComment | ( | const char * | val | ) | `[inline]`

void SubmoduleNode::setLikeParam | ( | const char * | val | ) | `[inline]`

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

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

void SubmoduleNode::setTypeName | ( | const char * | val | ) | `[inline]`

void SubmoduleNode::setVectorSize | ( | const char * | val | ) | `[inline]`

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

- nedelements.h