DtPaperMapRecord Class Reference

Inheritance diagram for DtPaperMapRecord:

List of all members.

Public Member Functions
	DtPaperMapRecord ()
virtual	~DtPaperMapRecord ()
	DtPaperMapRecord (const DtPaperMapRecord &orig)
DtPaperMapRecord &	operator= (const DtPaperMapRecord &rhs)
virtual DtPaperMapRecord *	clone ()
virtual DtString	recordTypeName () const
	Returns the type name for the particular record.
virtual DtConfigCategoryType	recordCategory () const
	Each record should have a category of configuration they represent.
virtual const DtString &	name () const
virtual void	setName (const DtString &name)
virtual void	setFilename (const DtFilename &filename)
virtual const DtFilename &	filename () const
virtual void	setTransparencyLevel (int i)
virtual int	transparencyLevel () const
virtual void	setCoordinateSystem (DtPaperMap::DtCoordinateSystem cs)
virtual DtPaperMap::DtCoordinateSystem	coordinateSystem () const
virtual DtPaperMap::AlphaMode	alphaMode () const
virtual void	setAlphaMode (DtPaperMap::AlphaMode mode)
virtual bool	get (std::istream &stream)
	Read self from stream.
virtual bool	processToken (std::istream &stream, DtString &token)
	identifies a token or passes token the parent class.
virtual DtString	coordSysEnumToString (const DtPaperMap::DtCoordinateSystem coordsys) const
virtual DtPaperMap::DtCoordinateSystem	stringToCoordSysEnum (const DtString &string) const
virtual DtString	alphaEnumToString (const DtPaperMap::AlphaMode alphaMode) const
virtual DtPaperMap::AlphaMode	stringToAlphaEnum (const DtString &string) const
Static Public Member Functions
static DtMetafileRecord *	create ()
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
Protected Attributes
DtString	myName
DtFilename	myFilename
DtPaperMap::AlphaMode	myAlphaMode
int	myTransparencyLevel
DtPaperMap::DtCoordinateSystem	myCoordinateSystem
Static Protected Attributes
static const DtString	theParameterName
static const DtString	theParameterFilename
static const DtString	theParameterCoordinateSystem
static const DtString	theParameterAlphaMode
static const DtString	theParameterTransparencyLevel
static const int	theNumOfParameters

---

Constructor & Destructor Documentation

DtPaperMapRecord::DtPaperMapRecord

(

)

virtual DtPaperMapRecord::~DtPaperMapRecord

(

)

[virtual]

DtPaperMapRecord::DtPaperMapRecord

(

const DtPaperMapRecord &

orig

)

---

Member Function Documentation

DtPaperMapRecord& DtPaperMapRecord::operator=

(

const DtPaperMapRecord &

rhs

)

virtual DtPaperMapRecord* DtPaperMapRecord::clone

(

)

[virtual]

Reimplemented in DtMultiResPaperMapRecord, DtPixmapPaperMapRecord, and DtRpfPaperMapRecord.

virtual DtString DtPaperMapRecord::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.

Reimplemented in DtMultiResPaperMapRecord, DtPixmapPaperMapRecord, and DtRpfPaperMapRecord.

virtual DtConfigCategoryType DtPaperMapRecord::recordCategory

(

)

const [virtual]

Each record should have a category of configuration they represent.

I.e does this record configure terrain source files, or vector source files, papermap files....

Implements DtMetafileRecord.

virtual const DtString& DtPaperMapRecord::name

(

)

const [virtual]

virtual void DtPaperMapRecord::setName

(

const DtString &

name

)

[virtual]

virtual void DtPaperMapRecord::setFilename

(

const DtFilename &

filename

)

[virtual]

virtual const DtFilename& DtPaperMapRecord::filename

(

)

const [virtual]

virtual void DtPaperMapRecord::setTransparencyLevel

(

int

i

)

[virtual]

virtual int DtPaperMapRecord::transparencyLevel

(

)

const [virtual]

virtual void DtPaperMapRecord::setCoordinateSystem

(

DtPaperMap::DtCoordinateSystem

cs

)

[virtual]

virtual DtPaperMap::DtCoordinateSystem DtPaperMapRecord::coordinateSystem

(

)

const [virtual]

virtual DtPaperMap::AlphaMode DtPaperMapRecord::alphaMode

(

)

const [virtual]

virtual void DtPaperMapRecord::setAlphaMode

(

DtPaperMap::AlphaMode

mode

)

[virtual]

virtual bool DtPaperMapRecord::get

(

std::istream &

stream

)

[virtual]

Read self from stream.

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

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

identifies a token or passes token the parent class.

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

static DtMetafileRecord* DtPaperMapRecord::create

(

)

[static]

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

virtual DtString DtPaperMapRecord::coordSysEnumToString

(

const DtPaperMap::DtCoordinateSystem

coordsys

)

const [virtual]

virtual DtPaperMap::DtCoordinateSystem DtPaperMapRecord::stringToCoordSysEnum

(

const DtString &

string

)

const [virtual]

virtual DtString DtPaperMapRecord::alphaEnumToString

(

const DtPaperMap::AlphaMode

alphaMode

)

const [virtual]

virtual DtPaperMap::AlphaMode DtPaperMapRecord::stringToAlphaEnum

(

const DtString &

string

)

const [virtual]

virtual bool DtPaperMapRecord::writeAttributes

(

std::ostream &

stream

)

const [protected, virtual]

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

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

virtual bool DtPaperMapRecord::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.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

virtual bool DtPaperMapRecord::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.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

---

Member Data Documentation

DtString DtPaperMapRecord::myName [protected]

DtFilename DtPaperMapRecord::myFilename [protected]

DtPaperMap::AlphaMode DtPaperMapRecord::myAlphaMode [protected]

int DtPaperMapRecord::myTransparencyLevel [protected]

DtPaperMap::DtCoordinateSystem DtPaperMapRecord::myCoordinateSystem [protected]

const DtString DtPaperMapRecord::theParameterName [static, protected]

const DtString DtPaperMapRecord::theParameterFilename [static, protected]

const DtString DtPaperMapRecord::theParameterCoordinateSystem [static, protected]

const DtString DtPaperMapRecord::theParameterAlphaMode [static, protected]

const DtString DtPaperMapRecord::theParameterTransparencyLevel [static, protected]

const int DtPaperMapRecord::theNumOfParameters [static, protected]

---

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

• include/terrainDbFactory/pprMapRec.h