Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Doomwad::Nodes Class Reference

Inheritance diagram for Doomwad::Nodes:

Doomwad::WadEntry List of all members.

Detailed Description

Collection of Node objects.

See also:
Map Node Segs WadEntry

Definition at line 152 of file nodes.hpp.

Public Member Functions

 Nodes (const Lump &) throw ()
 Construct from a Lump.
 Nodes (void) throw ()
 Default constructor.
virtual bool setFromLump (const Lump &lump) throw ()
 Convert a Lump to this entry.
virtual Lump toLump (void) const throw ()
 Convert this entry to a Lump.
virtual std::string toString (void) const throw ()
 Convert this entry to a std::string.
virtual ~Nodes (void) throw ()
 Destructor.

Static Public Attributes

static const std::string NAME = "NODES"
 Name of an entry.


Constructor & Destructor Documentation

Nodes::Nodes const Lump lump  )  throw ()
 

Construct from a Lump.

Constructs a Nodes object given raw Lump data. The constructor parses the Lump into pieces and creates Node objects from them. It then stores them in order inside of itself.

Parameters:
lump Source Lump from which to pull Node data.

Definition at line 178 of file nodes.cpp.

References setFromLump().


Member Function Documentation

bool Nodes::setFromLump const Lump lump  )  throw () [virtual]
 

Convert a Lump to this entry.

Lumps should not know about specific data structures. Those structures know about Lumps, including how to convert from them.

Setting from a Lump involves parsing that Lump's contents to see if they are valid. If they are, then this object will contain what you expect it to. If not, it will return false and the atomic operation will not succeed.

Parameters:
lump Reference to a source Lump object.
Returns:
True if successful, false if not.

Implements Doomwad::WadEntry.

Definition at line 192 of file nodes.cpp.

References Doomwad::Node::read().

Referenced by Nodes().

Lump Nodes::toLump void   )  const throw () [virtual]
 

Convert this entry to a Lump.

Each subclass must be able to convert itself to a Lump for storage in a Wad.

Returns:
Lump containing the raw file representation of this entry.

Implements Doomwad::WadEntry.

Definition at line 212 of file nodes.cpp.

References NAME.

std::string Nodes::toString void   )  const throw () [virtual]
 

Convert this entry to a std::string.

The exact implementation varies by the exact concrete class, but the idea is to convert the entry into a summary to be displayed to the user. Please note that converting to a string may lose information. This is not serialization in the purest sense of the word, this is merely a quick and dirty user-readable summary of the entry.

True serialization is achieved by converting a Lump object and using its stream I/O functions to read and write.

Returns:
std::string containing a summary of this entry.

Implements Doomwad::WadEntry.

Definition at line 224 of file nodes.cpp.


Generated on Fri Jun 10 19:38:52 2005 for libdoomwad by  doxygen 1.4.0