cmlabs::CMManipulator Class Reference

#include <CogMapObjects.h>

Inheritance diagram for cmlabs::CMManipulator:

Inheritance graph
[legend]
Collaboration diagram for cmlabs::CMManipulator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 CMManipulator ()
 CMManipulator (const JString &xml)
 CMManipulator (XMLNode *node)
 ~CMManipulator ()
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
double open
CMPose pose

Detailed Description

Definition at line 1310 of file CogMapObjects.h.

Constructor & Destructor Documentation

cmlabs::CMManipulator::CMManipulator (  ) 

public overloaded constructor CMManipulator The CMManipulator method constructs a default manipulator

	       new CMManipulator();

This function doesn't return a value

Remarks:
See also:
Author:
Thor List
Date:
18-05-2007

Definition at line 1218 of file CogMapObjects.cpp.

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

public overloaded constructor CMManipulator The CMManipulator method creates a manipulator from raw XML

	       new CMManipulator(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 1223 of file CogMapObjects.cpp.

cmlabs::CMManipulator::CMManipulator ( XMLNode *  node  ) 

public overloaded constructor CMManipulator The CMManipulator method creates a manipulator from an XML Node

	       new CMManipulator(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 1229 of file CogMapObjects.cpp.

cmlabs::CMManipulator::~CMManipulator (  ) 

public virtual destructor ~CMManipulator

	       delete(obj);

This function doesn't return a value

Remarks:
See also:
Author:
Thor List
Date:
18-05-2007

Definition at line 1235 of file CogMapObjects.cpp.

Member Function Documentation

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

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

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

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

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

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

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

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

Member Data Documentation

JString cmlabs::CMManipulator::id

JString id The id variable contains the ID

Remarks:
Author:
Thor List
Date:
18-05-2007

Definition at line 1509 of file CogMapObjects.h.

JString cmlabs::CMManipulator::type

JString type The type variable contains the type

Remarks:
Author:
Thor List
Date:
18-05-2007

Definition at line 1519 of file CogMapObjects.h.

CMObject* cmlabs::CMManipulator::parent

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

Remarks:
Author:
Thor List
Date:
18-05-2007

Definition at line 1529 of file CogMapObjects.h.

Box cmlabs::CMManipulator::boundingbox

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

Remarks:
Author:
Thor List
Date:
18-05-2007

Definition at line 1539 of file CogMapObjects.h.

double cmlabs::CMManipulator::open

double open The open variable provides a measurement of how open the manipulator is

Remarks:
Author:
Thor List
Date:
18-05-2007

Definition at line 1549 of file CogMapObjects.h.

CMPose cmlabs::CMManipulator::pose

CMPose pose The pose variable contains the pose of the object

Remarks:
Author:
Thor List
Date:
18-05-2007

Definition at line 1559 of file CogMapObjects.h.

The documentation for this class was generated from the following files:
Generated on Tue Jul 7 16:24:05 2009 for CoreLibrary by  doxygen 1.5.6