---

CNSCLDocumentationBuffer Class Reference

#include <CNSCLDocumentationBuffer.h>

Inheritance diagram for CNSCLDocumentationBuffer:

List of all members.

Public Methods
	CNSCLDocumentationBuffer (unsigned nWords=4096)
	Default constructor.
	~CNSCLDocumentationBuffer ()
	Destructor.
Private Methods
CNSCLDocumentationBuffer &	operator= (const CNSCLDocumentationBuffer &rhs)
	Assignment.
int	operator== (const CNSCLDocumentationBuffer &rhs) const
	Comparison for equality.
int	operator!= (const CNSCLDocumentationBuffer &rhs) const
	CNSCLDocumentationBuffer (const CNSCLDocumentationBuffer &rhs)
	Copy constructor.

---

Detailed Description

Formats a buffer containing documentation about the packet types which will appear in the current buffer.

Definition at line 294 of file CNSCLDocumentationBuffer.h.

---

Constructor & Destructor Documentation

CNSCLDocumentationBuffer::CNSCLDocumentationBuffer (  unsigned    nWords = 4096 )

Default constructor. Constructs a documentation buffer. The buffer type is set, so once constructed, you only need to call PutEntityString for each documentation string you want inserted in the buffer. Definition at line 291 of file CNSCLDocumentationBuffer.cpp. References PKTDOCBF, and CNSCLOutputBuffer::SetType().

CNSCLDocumentationBuffer::~CNSCLDocumentationBuffer (    )  [inline]

Destructor. Definition at line 302 of file CNSCLDocumentationBuffer.h.

CNSCLDocumentationBuffer::CNSCLDocumentationBuffer (  const CNSCLDocumentationBuffer &    rhs )  [private]

Copy constructor.

---

Member Function Documentation

int CNSCLDocumentationBuffer::operator!= (  const CNSCLDocumentationBuffer &    rhs )  const [private]

CNSCLDocumentationBuffer& CNSCLDocumentationBuffer::operator= (  const CNSCLDocumentationBuffer &    rhs )  [private]

Assignment.

int CNSCLDocumentationBuffer::operator== (  const CNSCLDocumentationBuffer &    rhs )  const [private]

Comparison for equality.

---

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

• CNSCLDocumentationBuffer.h
• CNSCLDocumentationBuffer.cpp

---