cmlabs::CMMap Class Reference

#include <CogMapObjects.h>

Inheritance diagram for cmlabs::CMMap:

Collaboration diagram for cmlabs::CMMap:

List of all members.

Public Member Functions

CMMap ()

CMMap (const JString &xml)

CMMap (XMLNode *node)

~CMMap ()

Object * clone () const

bool fromXML (const JString &xml)

bool fromXML (XMLNode *node)

JString toXML ()

JString print ()

JString toHTML ()

Public Attributes

JString id

JString type

JString parentID

CMObject * parent

ObjectDictionary children

Detailed Description

Definition at line 2371 of file CogMapObjects.h.

Constructor & Destructor Documentation

cmlabs::CMMap::CMMap ( )

public overloaded constructor CMMap The CMMap method creates a CMMap with default values

	       new CMMap();

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1287 of file CogMapObjects.cpp.

cmlabs::CMMap::CMMap ( const JString & xml )

public overloaded constructor CMMap The CMMap method creates a new CMMap from raw XML

	       new CMMap(xml);

Parameters:

[in] xml type const JString & raw XML

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1292 of file CogMapObjects.cpp.

cmlabs::CMMap::CMMap ( XMLNode * node )

public overloaded constructor CMMap The CMMap method creates a new CMMap from an XML Node

	       new CMMap(node);

Parameters:

[in,out] node type XMLNode * XML Node containing XML

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1298 of file CogMapObjects.cpp.

cmlabs::CMMap::~CMMap ( )

public virtual destructor ~CMMap The ~CMMap method destroys a CMMap object

	       delete(obj);

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1304 of file CogMapObjects.cpp.

Member Function Documentation

Object * cmlabs::CMMap::clone ( ) const [virtual]

public virtual constant clone The clone method creates an identical object by cloning

	       val = (CMMap*) obj->clone();

Returns:

Object * containing object if successful, or
NULL if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Implements cmlabs::Object.

Definition at line 1307 of file CogMapObjects.cpp.

bool cmlabs::CMMap::fromXML ( const JString & xml ) [virtual]

public virtual overloaded fromXML The fromXML method fills in the object with the content of the XML

	       val = obj->fromXML(xml);

Parameters:

[in] xml type const JString & raw XML

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Reimplemented from cmlabs::Object.

Definition at line 1314 of file CogMapObjects.cpp.

bool cmlabs::CMMap::fromXML ( XMLNode * node ) [virtual]

public virtual fromXML The fromXML method instantiates the object from XML

	       val = obj->fromXML(xmlnode);

Parameters:

[in,out] node type XMLNode * XMLNode containing XML

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Reimplemented from cmlabs::Object.

Definition at line 1326 of file CogMapObjects.cpp.

JString cmlabs::CMMap::toXML ( ) [virtual]

public virtual toXML The toXML method generates the XML representing the object

	       val = obj->toXML();

Returns:

JString containing XML if successful, or
empty string if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Reimplemented from cmlabs::Object.

Definition at line 1336 of file CogMapObjects.cpp.

JString cmlabs::CMMap::print ( ) [virtual]

public constant print The print method creates a string representation of the object

	       val = obj->print();

Returns:

JString containing text if successful, or
empty string if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Reimplemented from cmlabs::Object.

Definition at line 1344 of file CogMapObjects.cpp.

JString cmlabs::CMMap::toHTML ( ) [virtual]

public virtual toHTML The toHTML method creates HTML which represents the object

	       val = obj->toHTML();

Returns:

JString containing HTML string if successful, or
empty string if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Reimplemented from cmlabs::Object.

Definition at line 1340 of file CogMapObjects.cpp.

Member Data Documentation

JString cmlabs::CMMap::id

JString id The id variable contains the id

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 2572 of file CogMapObjects.h.

JString cmlabs::CMMap::type

JString type The type variable contains type

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 2582 of file CogMapObjects.h.

JString cmlabs::CMMap::parentID

JString parentID The parentID variable contains id of the parent object

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 2592 of file CogMapObjects.h.

CMObject* cmlabs::CMMap::parent

CMObject * parent The parent variable contains the pointer to the parent object

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 2602 of file CogMapObjects.h.

ObjectDictionary cmlabs::CMMap::children

ObjectDictionary children The children variable contains the list of children objects

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 2612 of file CogMapObjects.h.

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


Public Member Functions
	CMMap ()
	CMMap (const JString &xml)
	CMMap (XMLNode *node)
	~CMMap ()
Object *	clone () const
bool	fromXML (const JString &xml)
bool	fromXML (XMLNode *node)
JString	toXML ()
JString	print ()
JString	toHTML ()
Public Attributes
JString	id
JString	type
JString	parentID
CMObject *	parent
ObjectDictionary	children