cmlabs::CMPoint Class Reference

#include <CogMapObjects.h>

Inheritance diagram for cmlabs::CMPoint:

Collaboration diagram for cmlabs::CMPoint:

List of all members.

Public Member Functions

CMPoint ()

~CMPoint ()

CMPoint (const JString &xml)

CMPoint (XMLNode *node)

JString toXML ()

bool fromXML (XMLNode *node)

JString print () const

JString toHTML ()

Object * clone () const

bool reset ()

double operator[] (int n) const

double get (int n) const

double getUncertainty (int n) const

bool set (int n, double value)

bool set (int n, double value, double uncertainty)

bool equals (const Object *o) const

bool equals (const CMPoint &p) const

bool equals (const CMPoint *p) const

bool hasChangedSince (const CMPoint &p)

bool hasChangedSince (const CMPoint *p)

bool addDifference (const CMPoint &p)

bool addDifference (const CMPoint *p)

Public Attributes

double x

double y

double z

double w

double xUncertainty

double yUncertainty

double zUncertainty

double wUncertainty

JString units

JString coordinateSystem

Detailed Description

Definition at line 578 of file CogMapObjects.h.

Constructor & Destructor Documentation

cmlabs::CMPoint::CMPoint ( )

public overloaded constructor CMPoint The CMPoint method creates a CMPoint object

	       obj = new CMPoint();

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 306 of file CogMapObjects.cpp.

cmlabs::CMPoint::~CMPoint ( )

public virtual destructor ~CMPoint The ~CMPoint method destroys a CMPoint

	       delete(obj);

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 311 of file CogMapObjects.cpp.

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

public overloaded constructor CMPoint The CMPoint method constructs a CMPoint from XML

	       new CMPoint(xml);

Parameters:

[in] xml type const JString & Raw XML string

This function doesn't return a value

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 316 of file CogMapObjects.cpp.

cmlabs::CMPoint::CMPoint ( XMLNode * node )

public overloaded constructor CMPoint The CMPoint method constructs a CMPoint from an XMLNode

	       obj->CMPoint();

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

Member Function Documentation

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

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

public virtual fromXML The fromXML method instantiates the CMPoint 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 404 of file CogMapObjects.cpp.

JString cmlabs::CMPoint::print ( ) const

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

Definition at line 466 of file CogMapObjects.cpp.

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

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

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

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

bool cmlabs::CMPoint::reset ( )

public reset The reset method resets the CMPoint to its default value content

	       val = obj->reset();

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 334 of file CogMapObjects.cpp.

double cmlabs::CMPoint::operator[] ( int n ) const

public constant operator [] The operator [] method retrieves the Nth element value

	       val = obj->operator[n];

Parameters:

[in] n type int element position

Returns:

double containing value if successful, or
0 if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 476 of file CogMapObjects.cpp.

double cmlabs::CMPoint::get ( int n ) const

public constant get The get method retrieves the Nth element value

	       val = obj->get(n);

Parameters:

[in] n type int element position

Returns:

double containing value if successful, or
0 if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 480 of file CogMapObjects.cpp.

double cmlabs::CMPoint::getUncertainty ( int n ) const

public constant getUncertainty The getUncertainty method retrieves the uncertainty for the Nth element value

	       val = obj->getUncertainty(n);

Parameters:

[in] n type int element position

Returns:

double containing value if successful, or
0 if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 496 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::set	(	int	n,
		double	value
	)

public overloaded set The set method sets the Nth element value

	       val = obj->set(n, value);

Parameters:

`[in]`	n	type int element position
`[in]`	value	type double value to set

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 513 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::set	(	int	n,
		double	value,
		double	uncertainty
	)

public overloaded set The set method sets the Nth element value and uncertainty

	       val = obj->set(n, value, uncert);

Parameters:

`[in]`	n	type int element position
`[in]`	value	type double value to set
`[in]`	uncertainty	type double uncertainty to set

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 529 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::equals ( const Object * o ) const [virtual]

public virtual overloaded constant equals The equals method tests if two objects are equal

	       val = obj->equals(obj);

Parameters:

[in] o type const Object * object to test

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

bool cmlabs::CMPoint::equals ( const CMPoint & p ) const

public overloaded constant equals The equals method tests if two objects are equal

	       val = obj->equals(point);

Parameters:

[in] p type const CMPoint & point to test

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 347 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::equals ( const CMPoint * p ) const

public overloaded constant equals The equals method tests if two objects are equal

	       val = obj->equals(point);

Parameters:

[in] p type const CMPoint * point to test

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 351 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::hasChangedSince ( const CMPoint & p )

public overloaded hasChangedSince The hasChangedSince method tests if a point has changed

	       val = obj->hasChangedSince(point);

Parameters:

[in] p type const CMPoint & point to test

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 360 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::hasChangedSince ( const CMPoint * p )

public overloaded hasChangedSince The hasChangedSince method tests if a point has changed

	       val = obj->hasChangedSince(point);

Parameters:

[in] p type const CMPoint * point to test

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 364 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::addDifference ( const CMPoint & p )

public overloaded addDifference The addDifference method updates a point with a point update

	       val = obj->addDifference(update);

Parameters:

[in] p type const CMPoint & point update

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 545 of file CogMapObjects.cpp.

bool cmlabs::CMPoint::addDifference ( const CMPoint * p )

public overloaded addDifference The addDifference method updates a point with a point update

	       val = obj->addDifference(point);

Parameters:

[in] p type const CMPoint * point update

Returns:

bool containing true if successful, or
false if unsuccessful.

Remarks:

See also:

Author:: Thor List

Date:: 18-05-2007

Definition at line 549 of file CogMapObjects.cpp.

Member Data Documentation

double cmlabs::CMPoint::x

Definition at line 1032 of file CogMapObjects.h.

double cmlabs::CMPoint::y

Definition at line 1032 of file CogMapObjects.h.

double cmlabs::CMPoint::z

Definition at line 1032 of file CogMapObjects.h.

double cmlabs::CMPoint::w

Definition at line 1032 of file CogMapObjects.h.

double cmlabs::CMPoint::xUncertainty

Definition at line 1033 of file CogMapObjects.h.

double cmlabs::CMPoint::yUncertainty

Definition at line 1033 of file CogMapObjects.h.

double cmlabs::CMPoint::zUncertainty

Definition at line 1033 of file CogMapObjects.h.

double cmlabs::CMPoint::wUncertainty

Definition at line 1033 of file CogMapObjects.h.

JString cmlabs::CMPoint::units

JString units The units variable units in clear text

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1043 of file CogMapObjects.h.

JString cmlabs::CMPoint::coordinateSystem

JString coordinateSystem The coordinateSystem variable name of the coordinate system

Remarks:

Author:: Thor List

Date:: 18-05-2007

Definition at line 1053 of file CogMapObjects.h.

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


Public Member Functions
	CMPoint ()
	~CMPoint ()
	CMPoint (const JString &xml)
	CMPoint (XMLNode *node)
JString	toXML ()
bool	fromXML (XMLNode *node)
JString	print () const
JString	toHTML ()
Object *	clone () const
bool	reset ()
double	operator[] (int n) const
double	get (int n) const
double	getUncertainty (int n) const
bool	set (int n, double value)
bool	set (int n, double value, double uncertainty)
bool	equals (const Object *o) const
bool	equals (const CMPoint &p) const
bool	equals (const CMPoint *p) const
bool	hasChangedSince (const CMPoint &p)
bool	hasChangedSince (const CMPoint *p)
bool	addDifference (const CMPoint &p)
bool	addDifference (const CMPoint *p)
Public Attributes
double	x
double	y
double	z
double	w
double	xUncertainty
double	yUncertainty
double	zUncertainty
double	wUncertainty
JString	units
JString	coordinateSystem