Conjecture::Region Class Reference

#include <Region.h>

Inheritance diagram for Conjecture::Region:

List of all members.

---

Detailed Description

A sub-region of a Page, usually used to represent the graphical area for a single column in a multi-column image.

****************************************************************

May be sub-divided into a collection of Lines, Words, and/or Glyphs.

Currently expected to be relatively unimportant, and may actually be removed if deemed unnecessary.

Public Member Functions
	Region (Element *parent, const Coord &topleft, const Coord &bottomright)
virtual int	type () const
virtual Region *	asRegion ()
virtual const Region *	asRegion () const
virtual void	printSummary (std::ostream &os=std::cerr, const std::string &indent="", int index=-1) const
Static Public Member Functions
static void	test (int argc=0, const char *argv[]=NULL)

---

Member Function Documentation

virtual Region* Conjecture::Region::asRegion (   )  [inline, virtual]

Allows Image instances to be converted to Region instances safely without requiring explicit down-casting. Reimplemented from Conjecture::Element.

virtual void Conjecture::Region::printSummary (  std::ostream &  os = std::cerr, const std::string &  indent = "", int  index = -1 )  const [virtual]

Print out information about this Element. Reimplemented from Conjecture::Element.

void Conjecture::Region::test (  int  argc = 0, const char *  argv[] = NULL )  [static]

Unit testing method. This static method should create instances of the class (and instances of any other class necessary) and perform tests to ensure that all methods within the class are working as expected. Reimplemented from Conjecture::Element.

virtual int Conjecture::Region::type (   )  const [inline, virtual]

Returns an integer establishing how "small" this image type is, relative to other image types. It has nothing to do with width or height, but instead with the conceptual size of the type itself. All instances of a particular subtype will always return the same value. The code is designed so that Glyph returns a larger number than Word, which is larger than Line, which is larger than Region, which is larger than Page. This allows us to perform some sanity checks on hierarchial decompositions to ensure that we don't make silly structures in which Lines have Glyphs as parents, etc. FUTURE FIX: This method should be pure-virtual, but making it pure-virtual causes compilation failure (pure virtual method invoked in constructor). Reimplemented from Conjecture::Element.

---

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

• Region.h
• Region.cc

---