Doomwad::Sidedefs Class Reference

Inheritance diagram for Doomwad::Sidedefs:

List of all members.

---

Detailed Description

Collection of Sidedef objects.

See also:

Map Linedefs Sectors Sidedef WadEntry

Definition at line 104 of file sidedefs.hpp.

Public Member Functions
virtual bool	setFromLump (const Lump &lump) throw ()
	Convert a Lump to this entry.
	Sidedefs (const Lump &) throw ()
	Construct from a Lump.
	Sidedefs (void) throw ()
	Default constructor.
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	~Sidedefs (void) throw ()
	Destructor.
Static Public Attributes
static const std::string	NAME = "SIDEDEFS"
	Name of an entry.

---

Constructor & Destructor Documentation

Sidedefs::Sidedefs (  const Lump &  lump  )  throw ()

Construct from a Lump. Constructs a Sidedefs object given raw Lump data. The constructor parses the Lump into pieces and creates Sidedefs from them. It then stores them in order inside of itself. Parameters: lump  Source Lump from which to pull Sidedef data. Definition at line 147 of file sidedefs.cpp. References setFromLump().

Sidedefs::~Sidedefs (  void   )  throw () [virtual]

Destructor. Does nothing, but is necessary for inheritance. Definition at line 158 of file sidedefs.cpp.

---

Member Function Documentation

bool Sidedefs::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 163 of file sidedefs.cpp. References Doomwad::Sidedef::read(). Referenced by Sidedefs().

Lump Sidedefs::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 180 of file sidedefs.cpp. References NAME.

std::string Sidedefs::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 191 of file sidedefs.cpp.

---