SOA::SERVERLIST::ITEM Class Reference

Individual item in list. More...

#include <soa/serverlist.h>

List of all members.

Public Member Functions
	ITEM (const MISTRING &title, const MISTRING &url, bool IsList=false)
	ITEM (const MISTRING &title)
	ITEM (bool IsList, std::vector< MISTRING > additionaltags)
	ITEM (bool IsList=true)
	~ITEM ()
ITEM &	AddChildToBack (const ITEM &item)
ITEM &	AddChildToFront (const ITEM &item)
const MISTRING &	GetAbstract () const
const std::vector< MISTRING >	GetAdditionalTagData () const
const std::vector< MISTRING >	GetAdditionalTagNames () const
const MISTRING &	GetBaseURL () const
const ITEMLIST &	GetItemList () const
ITEM *	GetParent ()
const ITEM *	GetParent () const
const STRUTF8 &	GetService () const
const MISTRING &	GetTitle () const
const MISTRING &	GetURL () const
ITEM &	InsertChild (ITEMLIST::CONST_ITERATOR itInsertBefore, const ITEM &item)
bool	IsList () const
ERRVALUE	Parse (const XMLNODE *xmlnode)
void	RemoveChild (ITEMLIST::CONST_ITERATOR itChild)
void	SetAbstract (const MISTRING &Abstract)
void	SetAdditionalTagData (const std::vector< MISTRING > &additionaltags)
void	SetAdditionalTagNames (const std::vector< MISTRING > &additionaltags)
void	SetBaseURL (const MISTRING &baseurl)
void	SetTitle (const MISTRING &title)
void	SetURL (const MISTRING &url)
void	TransferList (const ITEMLIST &list)
void	TransferList (ITEM &listitem)

---

Detailed Description

Individual item in list.

Contains title and URL for server and/or list of items if is itself a list.

---

Constructor & Destructor Documentation

SOA::SERVERLIST::ITEM::ITEM

(

bool

IsList = true

)

Default constructor.

SOA::SERVERLIST::ITEM::ITEM	(	bool	IsList,
		std::vector< MISTRING >	additionaltags
	)

Constructor that creates an item with additional tags set.

SOA::SERVERLIST::ITEM::ITEM

(

const MISTRING &

title

)

Construct item to use as "list".

SOA::SERVERLIST::ITEM::ITEM	(	const MISTRING &	title,
		const MISTRING &	url,
		bool	IsList = false
	)

Construct item referencing URL.

SOA::SERVERLIST::ITEM::~ITEM

(

)

---

Member Function Documentation

ITEM& SOA::SERVERLIST::ITEM::AddChildToBack

(

const ITEM &

item

)

Add child item to back of list.

ITEM& SOA::SERVERLIST::ITEM::AddChildToFront

(

const ITEM &

item

)

Add child item to front of list.

const MISTRING& SOA::SERVERLIST::ITEM::GetAbstract

(

)

const [inline]

Get abstract for this item.

const std::vector<MISTRING> SOA::SERVERLIST::ITEM::GetAdditionalTagData

(

)

const [inline]

Get the data for additional tags parsed out for this item.

const std::vector<MISTRING> SOA::SERVERLIST::ITEM::GetAdditionalTagNames

(

)

const [inline]

Get the data for additional tags parsed out for this item.

const MISTRING& SOA::SERVERLIST::ITEM::GetBaseURL

(

)

const [inline]

Get item Base URL.

const ITEMLIST& SOA::SERVERLIST::ITEM::GetItemList

(

)

const [inline]

Get list of items under this item.

Should only be used if IsList() returns 'true'.

ITEM* SOA::SERVERLIST::ITEM::GetParent

(

)

[inline]

Get pointer to parent item.

Returns:

NULL for topmost (root) item.

const ITEM* SOA::SERVERLIST::ITEM::GetParent

(

)

const [inline]

Get pointer to parent item.

Returns:

NULL for topmost (root) item.

const STRUTF8& SOA::SERVERLIST::ITEM::GetService

(

)

const [inline]

Get item "service".

Returns:

Service string (eg, WMS, WFS, WCS, etc). Uses STRUTF8 for convenience in comparison.

const MISTRING& SOA::SERVERLIST::ITEM::GetTitle

(

)

const [inline]

Get item title.

const MISTRING& SOA::SERVERLIST::ITEM::GetURL

(

)

const [inline]

Get item URL, will be empty if item is "list".

ITEM& SOA::SERVERLIST::ITEM::InsertChild	(	ITEMLIST::CONST_ITERATOR	itInsertBefore,
		const ITEM &	item
	)

Insert child before specified iterator.

bool SOA::SERVERLIST::ITEM::IsList

(

)

const [inline]

Determine if item is a "list".

ERRVALUE SOA::SERVERLIST::ITEM::Parse

(

const XMLNODE *

xmlnode

)

Parse from XML node.

Does not clear existing values, normally used on newly constructed item.

void SOA::SERVERLIST::ITEM::RemoveChild

(

ITEMLIST::CONST_ITERATOR

itChild

)

Remove child referenced by specified iterator.

void SOA::SERVERLIST::ITEM::SetAbstract

(

const MISTRING &

Abstract

)

[inline]

Set abstract.

void SOA::SERVERLIST::ITEM::SetAdditionalTagData

(

const std::vector< MISTRING > &

additionaltags

)

[inline]

void SOA::SERVERLIST::ITEM::SetAdditionalTagNames

(

const std::vector< MISTRING > &

additionaltags

)

[inline]

Set a stringlist of addition tags to parse out of the server list.

void SOA::SERVERLIST::ITEM::SetBaseURL

(

const MISTRING &

baseurl

)

[inline]

Set Base URL.

void SOA::SERVERLIST::ITEM::SetTitle

(

const MISTRING &

title

)

[inline]

Set URL.

void SOA::SERVERLIST::ITEM::SetURL

(

const MISTRING &

url

)

[inline]

Set URL.

void SOA::SERVERLIST::ITEM::TransferList

(

const ITEMLIST &

list

)

[inline]

Transfer list from specified item to this item.

void SOA::SERVERLIST::ITEM::TransferList

(

ITEM &

listitem

)

Transfer list from specified item to this item.

---

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

• soa/serverlist.h