OmgLayer Class Reference
[Library]

#include <omglayer.h>

Inheritance diagram for OmgLayer:

[legend]Collaboration diagram for OmgLayer:

[legend]List of all members.

---

Detailed Description

An abstract base class for any class that is serialiseable to xml.

Author:

Tim Sutton

Definition at line 29 of file omglayer.h.

Public Types
enum	LayerType { MASK, MAP, FORMAT }
Public Member Functions
	OmgLayer ()
	~OmgLayer ()
	OmgLayer (const OmgLayer &theLayer)
OmgLayer &	operator= (const OmgLayer &theLayer)
QString	name () const
bool	isCategorical () const
LayerType	type () const
void	setName (QString theName)
void	setCategorical (bool theFlag)
void	setType (LayerType theType)
QString	toXml () const
bool	fromXml (const QString theXml)
Private Attributes
bool	mCategoricalFlag
QString	mName
LayerType	mType

---

Member Enumeration Documentation

enum OmgLayer::LayerType

Enumeration of possible types a layer can be. Note that format is used when specifying the output cellsize and extents for a model. Enumeration values: MASK  MAP  FORMAT  Definition at line 45 of file omglayer.h.

---

Constructor & Destructor Documentation

OmgLayer::OmgLayer (   )

Constructor . Definition at line 20 of file omglayer.cpp.

OmgLayer::~OmgLayer (   )

Desctructor . Definition at line 24 of file omglayer.cpp.

OmgLayer::OmgLayer (  const OmgLayer &  theLayer  )

copy constructor Definition at line 29 of file omglayer.cpp. References mCategoricalFlag, mName, and mType.

---

Member Function Documentation

bool OmgLayer::fromXml (  const QString  theXml  )  [inline, virtual]

Read this object from xml and return result as true for success, false for failure. See also: OmgSerialisable Implement this!!! Implements OmgSerialisable. Definition at line 87 of file omglayer.h.

bool OmgLayer::isCategorical (   )  const

Whether this layer represents categorical data in discrete cless or a continuous surface Definition at line 57 of file omglayer.cpp. References mCategoricalFlag. Referenced by OmgLayerSetManager::selectLayerSet().

QString OmgLayer::name (   )  const

The name of this layer - usually a full pathname and file name though this may vary depending on the OmgModellerAdapter implementations Definition at line 47 of file omglayer.cpp. References mName. Referenced by OmgLayerSet::addLayer(), OmgLayerSet::maskName(), OmgLayerSet::nameList(), OmgModel::outputFormatLayerName(), OmgLayerSet::removeLayer(), OmgLayerSetManager::selectLayerSet(), OmgModel::toHtml(), OmgLayerSet::toHtml(), OmgModel::toModelProjectionXml(), OmgModel::toPrintHtml(), OmgModel::toString(), OmgLayerSet::toString(), and OmgLayerSet::toXml().

OmgLayer & OmgLayer::operator= (  const OmgLayer &  theLayer  )

Assignement operator Definition at line 36 of file omglayer.cpp. References mCategoricalFlag, mName, and mType.

void OmgLayer::setCategorical (  bool  theFlag  )

Set the categorical flag See also: isCategorical() Definition at line 62 of file omglayer.cpp. References mCategoricalFlag. Referenced by OmgModel::fromXml(), OmgLayerSet::fromXml(), OmgLayerSetManager::on_pbnApply_clicked(), OmgModel::setCreationLayerNames(), OmgModel::setcreationMaskLayerName(), OmgModel::setOutputFormatLayerName(), OmgModel::setProjectionLayerNames(), and OmgModel::setProjectionMaskLayerName().

void OmgLayer::setName (  QString  theName  )

Set the layerName See also: name() Definition at line 52 of file omglayer.cpp. References mName. Referenced by OmgModel::fromXml(), OmgLayerSet::fromXml(), OmgLayerSetManager::on_pbnApply_clicked(), OmgModel::setCreationLayerNames(), OmgModel::setcreationMaskLayerName(), OmgModel::setOutputFormatLayerName(), OmgModel::setProjectionLayerNames(), and OmgModel::setProjectionMaskLayerName().

void OmgLayer::setType (  LayerType  theType  )

Set the layer type See also: layerType() Definition at line 72 of file omglayer.cpp. References mType. Referenced by OmgLayerSetManager::on_pbnApply_clicked().

QString OmgLayer::toXml (   )  const [virtual]

Return an xml representation of this layer this class is not fully serialiseable (yet??) Implements OmgSerialisable. Definition at line 77 of file omglayer.cpp. References mCategoricalFlag, and mName. Referenced by OmgModel::toXml(), and OmgLayerSet::toXml().

OmgLayer::LayerType OmgLayer::type (   )  const

The type of this layer. Note that type 'FORMAT' is used when specifying the output cellsize and extents for a model. Definition at line 67 of file omglayer.cpp. References mType.

---

Member Data Documentation

bool OmgLayer::mCategoricalFlag [private]

A flag to store whehter this layer contains categorical or continuous data Definition at line 87 of file omglayer.h. Referenced by isCategorical(), OmgLayer(), operator=(), setCategorical(), and toXml().

QString OmgLayer::mName [private]

The name for this layer - usually a full path and filename Definition at line 92 of file omglayer.h. Referenced by name(), OmgLayer(), operator=(), setName(), and toXml().

LayerType OmgLayer::mType [private]

The type / role of this layer - mask / map / output format specifier Definition at line 94 of file omglayer.h. Referenced by OmgLayer(), operator=(), setType(), and type().

---

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

• lib/omglayer.h
• lib/omglayer.cpp

---