CompoundModuleNode Class Reference
[Data classes]

#include <nedelements.h>

Inheritance diagram for CompoundModuleNode:

List of all members.

---

Detailed Description

GENERATED CLASS.

Represents the <compound-module> XML element in memory. DTD declaration:

 <!ELEMENT compound-module (machines?, params?, gates?,
                   submodules?, connections?, display-string?)>
 <!ATTLIST compound-module
      name                NMTOKEN   #REQUIRED
      source-code         CDATA     #IMPLIED
      banner-comment      CDATA     #IMPLIED
      right-comment       CDATA     "&#10;"
      trailing-comment    CDATA     "&#10;" >
 

Public Member Functions
Constructors, destructor
	CompoundModuleNode ()
	CompoundModuleNode (NEDElement *parent)
virtual	~CompoundModuleNode ()
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 *	getSourceCode () const
void	setSourceCode (const char *val)
const char *	getBannerComment () const
void	setBannerComment (const char *val)
const char *	getRightComment () const
void	setRightComment (const char *val)
const char *	getTrailingComment () const
void	setTrailingComment (const char *val)
virtual CompoundModuleNode *	getNextCompoundModuleNodeSibling () const
virtual MachinesNode *	getFirstMachinesChild () const
virtual ParamsNode *	getFirstParamsChild () const
virtual GatesNode *	getFirstGatesChild () const
virtual SubmodulesNode *	getFirstSubmodulesChild () const
virtual ConnectionsNode *	getFirstConnectionsChild () const
virtual DisplayStringNode *	getFirstDisplayStringChild () const

---

Constructor & Destructor Documentation

CompoundModuleNode::CompoundModuleNode (   )  [inline]

CompoundModuleNode::CompoundModuleNode (  NEDElement *  parent  )  [inline]

virtual CompoundModuleNode::~CompoundModuleNode (   )  [inline, virtual]

---

Member Function Documentation

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

virtual ConnectionsNode* CompoundModuleNode::getFirstConnectionsChild (   )  const [virtual]

virtual DisplayStringNode* CompoundModuleNode::getFirstDisplayStringChild (   )  const [virtual]

virtual GatesNode* CompoundModuleNode::getFirstGatesChild (   )  const [virtual]

virtual MachinesNode* CompoundModuleNode::getFirstMachinesChild (   )  const [virtual]

virtual ParamsNode* CompoundModuleNode::getFirstParamsChild (   )  const [virtual]

virtual SubmodulesNode* CompoundModuleNode::getFirstSubmodulesChild (   )  const [virtual]

const char* CompoundModuleNode::getName (   )  const [inline]

virtual CompoundModuleNode* CompoundModuleNode::getNextCompoundModuleNodeSibling (   )  const [virtual]

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

const char* CompoundModuleNode::getSourceCode (   )  const [inline]

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

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

const char* CompoundModuleNode::getTrailingComment (   )  const [inline]

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

void CompoundModuleNode::setName (  const char *  val  )  [inline]

void CompoundModuleNode::setRightComment (  const char *  val  )  [inline]

void CompoundModuleNode::setSourceCode (  const char *  val  )  [inline]

void CompoundModuleNode::setTrailingComment (  const char *  val  )  [inline]

---

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

• nedelements.h

---