Main Page Modules Class Hierarchy Compound List File List Compound Members

# SubmoduleNode Class Reference

`#include <nedelements.h>`

Inheritance diagram for SubmoduleNode::

List of all members.

## Public Methods

| 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* | getLikeName () const
void | setLikeName (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

## 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-name           NMTOKEN   IMPLIED
          vector-size         CDATA     IMPLIED
          banner-comment      CDATA     IMPLIED
          right-comment       CDATA     "&#10;" >

## Member Function Documentation

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()). Reimplemented from NEDElement.

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()). Reimplemented from NEDElement.

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()). Reimplemented from NEDElement.

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

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

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

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

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

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

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. Reimplemented from NEDElement.

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

- nedelements.h