---

Path Class Reference
[Data classes]

Path to an object record in a data archive. More...

#include <Path.h>

Inheritance diagram for Path:

List of all members.

Public Methods
	Path (const char *path=0)
	Create a new Path using a path string.
	Path (ObjectID path)
	Create a new Path from an Object ID.
virtual	~Path ()
void	setPath (ObjectID path)
	Assign to a specific Object ID.
void	setPath (const char *path)
	Assign to an object path string (after converting to an Object ID).
void	setNone ()
	Assign to Object ID 0 (no-path).
const ObjectID	getPath () const
	Get the path's Object ID.
virtual void	serialize (Archive &)
	Serialize to or from a data archive.
bool	isNone () const
	Test for 'no-path' (Object ID == 0).
bool	operator== (Path const &p) const
	Test for equality of two paths.
bool	operator!= (Path const &p) const
	Test for equality of two paths.
virtual std::string	asString () const
	String representation.
virtual std::string	typeString () const
	Return a string representation of the type.
virtual void	parseXML (const char *cdata)
	Parse cdata from within the XML tags for this object.
virtual void	convertXML ()
	Convert XML data to internal format prior to serialization.
Protected Attributes
ObjectID	_path

---

Detailed Description

Path to an object record in a data archive.

Object paths use '.' to separate path elements, and uniquely identify objects in a data archive. Path objects store the path as a 64-bit hash of the path string, called an Object ID.

Author:

Mark Rose <mrose@stm.lbl.gov>

---

Constructor & Destructor Documentation

Path::Path (  const char *    path = 0 )  [inline, explicit]

Create a new Path using a path string.

Path::Path (  ObjectID    path )  [inline, explicit]

Create a new Path from an Object ID.

virtual Path::~Path (    )  [inline, virtual]

---

Member Function Documentation

std::string Path::asString (    )  [virtual]

String representation. Implements BaseType. Reimplemented in LinkBase.

void BaseType::convertXML (    )  [virtual, inherited]

Convert XML data to internal format prior to serialization. This method is currently only called by the XML parser for Object classes. If another BaseType class requires this method, a call must be added to the appropriate XML handler in the parser.

const ObjectID Path::getPath (    )  const [inline]

Get the path's Object ID.

bool Path::isNone (    )  const [inline]

Test for 'no-path' (Object ID == 0).

bool Path::operator!= (  Path const &    p )  const [inline]

Test for equality of two paths.

bool Path::operator== (  Path const &    p )  const [inline]

Test for equality of two paths.

void BaseType::parseXML (  const char *    cdata )  [virtual, inherited]

Parse cdata from within the XML tags for this object. Reimplemented in SimDate, EnumLink, GeoPos, LLA, UTM, Matrix3, Quat, Real, and Vector3.

void Path::serialize (  Archive &    )  [virtual]

Serialize to or from a data archive. Reimplemented from BaseType. Reimplemented in LinkBase.

void Path::setNone (    )  [inline]

Assign to Object ID 0 (no-path).

NAMESPACE_SIMDATA void Path::setPath (  const char *    path )

Assign to an object path string (after converting to an Object ID).

void Path::setPath (  ObjectID    path )  [inline]

Assign to a specific Object ID.

virtual std::string Path::typeString (    )  const [inline, virtual]

Return a string representation of the type. Implements BaseType. Reimplemented in LinkBase, and Link< T >.

---

Member Data Documentation

ObjectID Path::_path [protected]

---

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

• Path.h
• Path.cpp

---

SimData version pre-0.4.0. For more information on SimData, visit the SimData Homepage. Generated on Tue Oct 14 12:06:42 2003, using Doxygen 1.2.18.