DtKynPathDataMetafileRecord Class Reference

Inheritance diagram for DtKynPathDataMetafileRecord:

List of all members.

Public Member Functions
	DtKynPathDataMetafileRecord ()
	default constructor.
virtual	~DtKynPathDataMetafileRecord ()
	destructor
	DtKynPathDataMetafileRecord (const DtKynPathDataMetafileRecord &orig)
	copy constructor
DtKynPathDataMetafileRecord &	operator= (const DtKynPathDataMetafileRecord &orig)
	assignment operator
virtual bool	init ()
	Initialize the metafile.
virtual bool	get (std::istream &stream)
	Overridden to invoke any postRead callbacks after the record is read.
virtual bool	processToken (std::istream &stream, DtString &token)
	identifies a token or passes token the parent class.
virtual DtString	recordTypeName () const
	Returns the type name for the particular record.
virtual bool	includeInMtd () const
virtual void	setPDGName (const DtString &name)
virtual DtString	PDGName () const
virtual void	setPDGPath (const DtString &path)
virtual DtString	PDGPath () const
virtual void	setRelativePathCheck (const bool arg)
virtual bool	RelativePathCheck () const
virtual void	setPDGType (const DtString &type)
virtual DtString	PDGType () const
virtual void	setObjectType (const DtString &objectType)
virtual DtString	objectType () const
Static Public Member Functions
static DtMetafileRecord *	create ()
static void	addPostReadCallback (DtKynPathDataMetafileRecordCallback, void *usr)
	Callbacks that will be called immediately after this record is read from a file.
static void	removePostReadCallback (DtKynPathDataMetafileRecordCallback, void *usr)
	Callbacks that will be called immediately after this record is read from a file.
Protected Types
typedef std::pair < DtKynPathDataMetafileRecordCallback, void * >	DtCallbackInfo
typedef std::list< DtCallbackInfo >	DtCallbackInfoList
Protected Member Functions
virtual bool	writeAttributes (std::ostream &stream) const
	Write attributes to stream. This is called by put(stream)
virtual bool	getAttribute (const DtString attrName, DtString &value, unsigned index=0)
	Given the name of a record's attribute, returns its value in the 'value' parameter.
virtual bool	setToken (const DtString &token, const DtString value)
	identifies a token and returns true if the value can be set to it, false otherwise
virtual void	invokePostReadCallbacks ()
Protected Attributes
DtString	myPDGName
DtString	myPDGPath
bool	myRelativePathCheck
DtString	myPathDataType
DtString	myObjectType
Static Protected Attributes
static const DtString	thePDGName
static const DtString	thePDGPath
static const DtString	theRelativePathCheck
static const DtString	thePathDataType
static const DtString	theObjectType
static DtCallbackInfoList	thePostReadCallbackList

---

Member Typedef Documentation

typedef std::pair<DtKynPathDataMetafileRecordCallback, void*> DtKynPathDataMetafileRecord::DtCallbackInfo [protected]

typedef std::list<DtCallbackInfo> DtKynPathDataMetafileRecord::DtCallbackInfoList [protected]

---

Constructor & Destructor Documentation

DtKynPathDataMetafileRecord::DtKynPathDataMetafileRecord

(

)

default constructor.

virtual DtKynPathDataMetafileRecord::~DtKynPathDataMetafileRecord

(

)

[virtual]

destructor

DtKynPathDataMetafileRecord::DtKynPathDataMetafileRecord

(

const DtKynPathDataMetafileRecord &

orig

)

copy constructor

---

Member Function Documentation

DtKynPathDataMetafileRecord& DtKynPathDataMetafileRecord::operator=

(

const DtKynPathDataMetafileRecord &

orig

)

assignment operator

virtual bool DtKynPathDataMetafileRecord::init

(

)

[virtual]

Initialize the metafile.

Reimplemented from DtMetafileRecord.

virtual bool DtKynPathDataMetafileRecord::get

(

std::istream &

stream

)

[virtual]

Overridden to invoke any postRead callbacks after the record is read.

Reimplemented from DtMetafileRecord.

virtual bool DtKynPathDataMetafileRecord::processToken	(	std::istream &	stream,
		DtString &	token
	)		[virtual]

identifies a token or passes token the parent class.

Reimplemented from DtMetafileRecord.

virtual DtString DtKynPathDataMetafileRecord::recordTypeName

(

)

const [virtual]

Returns the type name for the particular record.

Descendants should have this method return some string which uniquely identifies the kind of database it represents.

Implements DtMetafileRecord.

virtual bool DtKynPathDataMetafileRecord::includeInMtd

(

)

const [virtual]

Implements DtAdditionalDataRecord.

virtual void DtKynPathDataMetafileRecord::setPDGName

(

const DtString &

name

)

[virtual]

virtual DtString DtKynPathDataMetafileRecord::PDGName

(

)

const [virtual]

virtual void DtKynPathDataMetafileRecord::setPDGPath

(

const DtString &

path

)

[virtual]

virtual DtString DtKynPathDataMetafileRecord::PDGPath

(

)

const [virtual]

virtual void DtKynPathDataMetafileRecord::setRelativePathCheck

(

const bool

arg

)

[virtual]

virtual bool DtKynPathDataMetafileRecord::RelativePathCheck

(

)

const [virtual]

virtual void DtKynPathDataMetafileRecord::setPDGType

(

const DtString &

type

)

[virtual]

virtual DtString DtKynPathDataMetafileRecord::PDGType

(

)

const [virtual]

virtual void DtKynPathDataMetafileRecord::setObjectType

(

const DtString &

objectType

)

[virtual]

virtual DtString DtKynPathDataMetafileRecord::objectType

(

)

const [virtual]

static void DtKynPathDataMetafileRecord::addPostReadCallback	(	DtKynPathDataMetafileRecordCallback	,
		void *	usr
	)		[static]

Callbacks that will be called immediately after this record is read from a file.

Note:

The callback list is a static member of this class, not a per-instance list.

static void DtKynPathDataMetafileRecord::removePostReadCallback	(	DtKynPathDataMetafileRecordCallback	,
		void *	usr
	)		[static]

Callbacks that will be called immediately after this record is read from a file.

Note:

The callback list is a static member of this class, not a per-instance list.

static DtMetafileRecord* DtKynPathDataMetafileRecord::create

(

)

[static]

virtual bool DtKynPathDataMetafileRecord::writeAttributes

(

std::ostream &

stream

)

const [protected, virtual]

Write attributes to stream. This is called by put(stream)

Reimplemented from DtMetafileRecord.

virtual bool DtKynPathDataMetafileRecord::getAttribute	(	const DtString	attrName,
		DtString &	value,
		unsigned	index = 0
	)		[protected, virtual]

Given the name of a record's attribute, returns its value in the 'value' parameter.

Returns True if successful; false otherwise

Reimplemented from DtMetafileRecord.

virtual bool DtKynPathDataMetafileRecord::setToken	(	const DtString &	token,
		const DtString	value
	)		[protected, virtual]

identifies a token and returns true if the value can be set to it, false otherwise

Reimplemented from DtMetafileRecord.

virtual void DtKynPathDataMetafileRecord::invokePostReadCallbacks

(

)

[protected, virtual]

---

Member Data Documentation

const DtString DtKynPathDataMetafileRecord::thePDGName [static, protected]

const DtString DtKynPathDataMetafileRecord::thePDGPath [static, protected]

const DtString DtKynPathDataMetafileRecord::theRelativePathCheck [static, protected]

const DtString DtKynPathDataMetafileRecord::thePathDataType [static, protected]

const DtString DtKynPathDataMetafileRecord::theObjectType [static, protected]

DtString DtKynPathDataMetafileRecord::myPDGName [protected]

DtString DtKynPathDataMetafileRecord::myPDGPath [protected]

bool DtKynPathDataMetafileRecord::myRelativePathCheck [protected]

DtString DtKynPathDataMetafileRecord::myPathDataType [protected]

DtString DtKynPathDataMetafileRecord::myObjectType [protected]

DtCallbackInfoList DtKynPathDataMetafileRecord::thePostReadCallbackList [static, protected]

---

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

• include/terrainDbFactory/kynPathDataMetafileRec.h