cmlabs::CMPose Class Reference

#include <CogMapObjects.h>

Inheritance diagram for cmlabs::CMPose:

Collaboration diagram for cmlabs::CMPose:

List of all members.

Public Member Functions

CMPose ()

CMPose (const JString &xml)

CMPose (XMLNode *node)

~CMPose ()

Object * clone () const

bool fromXML (const JString &xml)

bool fromXML (XMLNode *node)

JString toXML ()

JString print ()

JString toHTML ()

Public Attributes

JString id

JString type

CMObject * parent

Box boundingbox

PointFloat gazedirection

Detailed Description

Definition at line 1059 of file CogMapObjects.h.

Constructor & Destructor Documentation

cmlabs::CMPose::CMPose ( )

public overloaded constructor CMPose The CMPose method constructs a CMPose object

	       new CMPose();

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1149 of file CogMapObjects.cpp.

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

public overloaded constructor CMPose The CMPose method constructs a new CMPose from raw XML

	       new CMPose(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 1154 of file CogMapObjects.cpp.

cmlabs::CMPose::CMPose ( XMLNode * node )

public overloaded constructor CMPose The CMPose method constructs a new CMPose from an XML Node

	       new CMPose(node);

Parameters:

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

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1160 of file CogMapObjects.cpp.

cmlabs::CMPose::~CMPose ( )

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

	       delete(obj);

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1166 of file CogMapObjects.cpp.

Member Function Documentation

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

public virtual constant clone The clone method creates an identical copy of the object

	       val = (CMPose*) 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 1169 of file CogMapObjects.cpp.

bool cmlabs::CMPose::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 1176 of file CogMapObjects.cpp.

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

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

	       val = obj->fromXML(node);

Parameters:

[in,out] node type XMLNode * XML Node 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 1188 of file CogMapObjects.cpp.

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

public virtual toXML The toXML method creates XML that represents the full object content

	       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 1198 of file CogMapObjects.cpp.

JString cmlabs::CMPose::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 1206 of file CogMapObjects.cpp.

JString cmlabs::CMPose::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 1202 of file CogMapObjects.cpp.

Member Data Documentation

JString cmlabs::CMPose::id

JString id The id variable contains the ID

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1265 of file CogMapObjects.h.

JString cmlabs::CMPose::type

JString type The type variable contains the type

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1275 of file CogMapObjects.h.

CMObject* cmlabs::CMPose::parent

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

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1285 of file CogMapObjects.h.

Box cmlabs::CMPose::boundingbox

Box boundingbox The boundingbox variable contains the bounding box of the object

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1295 of file CogMapObjects.h.

PointFloat cmlabs::CMPose::gazedirection

PointFloat gazedirection The gazedirection variable contains the gaze direction of the object

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1305 of file CogMapObjects.h.

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


Public Member Functions
	CMPose ()
	CMPose (const JString &xml)
	CMPose (XMLNode *node)
	~CMPose ()
Object *	clone () const
bool	fromXML (const JString &xml)
bool	fromXML (XMLNode *node)
JString	toXML ()
JString	print ()
JString	toHTML ()
Public Attributes
JString	id
JString	type
CMObject *	parent
Box	boundingbox
PointFloat	gazedirection