Classes
class	Entry

struct	structCharacteristicsFromString

Public Member Functions
	DtSurfaceCharacteristicMap ()

virtual	~DtSurfaceCharacteristicMap ()

virtual bool	init (const DtFilename filename, bool displayWarning=false)

virtual bool	append (const DtFilename filename, bool displayWarning=false)

virtual bool	characteristicsFromString (const char *str, unsigned int &characteristics, int &position, int &matchClass) const

virtual bool	characteristicsFromString (const std::string &str, unsigned int &characteristics, int &position, int &matchClass) const

virtual bool	characteristicsFromString (const std::string &str, unsigned int &characteristics) const

virtual void	printResults (const char str, unsigned int characteristics, const char additionalInformation=0) const

Static Public Member Functions
static DtSurfaceCharacteristicMapConstPtr	createSurfCharMap (const DtFilename &surfCharFile)

Protected Types
typedef std::map< DtString, std::shared_ptr< Entry > >	EntryList

typedef std::map< std::string, structCharacteristicsFromString >	CharacteristicsFromStringMap

Protected Member Functions
virtual bool	get (std::istream &stream)

virtual bool	processToken (std::istream &stream, const DtString &token)

Protected Attributes
EntryList	myEntries

int	myCurrentPosition

CharacteristicsFromStringMap	myCharacteristicsFromStringCache

tbb::spin_rw_mutex	myCharacteristicsFromStringCacheMutex

Static Protected Attributes
static const DtString	theMatchString

static const DtString	theRegExprMatchString

Private Attributes
std::set< std::string >	myPrintedMessages

tbb::spin_rw_mutex	myPrintedMessagesMutex

Member Typedef Documentation

typedef std::map<DtString, std::shared_ptr<Entry> > makVrf::DtSurfaceCharacteristicMap::EntryList

protected

typedef std::map<std::string, structCharacteristicsFromString> makVrf::DtSurfaceCharacteristicMap::CharacteristicsFromStringMap

protected

Constructor & Destructor Documentation

makVrf::DtSurfaceCharacteristicMap::DtSurfaceCharacteristicMap ( )

default constructor.

virtual makVrf::DtSurfaceCharacteristicMap::~DtSurfaceCharacteristicMap ( )

virtual

destructor

Member Function Documentation

virtual bool makVrf::DtSurfaceCharacteristicMap::init	(	const DtFilename	filename,
		bool	displayWarning = `false`
	)

virtual

Initialize the metafile. Calls createSurface().

virtual bool makVrf::DtSurfaceCharacteristicMap::append	(	const DtFilename	filename,
		bool	displayWarning = `false`
	)

virtual

Append entries from [terrain].landCoverDataSurfChar.map.

virtual bool makVrf::DtSurfaceCharacteristicMap::characteristicsFromString	(	const char *	str,
		unsigned int &	characteristics,
		int &	position,
		int &	matchClass
	)		const

virtual

Set characteristics based on a string (version are doing the same thing but with the accurate parameters the results will be a bit faster)

virtual bool makVrf::DtSurfaceCharacteristicMap::characteristicsFromString	(	const std::string &	str,
		unsigned int &	characteristics,
		int &	position,
		int &	matchClass
	)		const

virtual

virtual bool makVrf::DtSurfaceCharacteristicMap::characteristicsFromString	(	const std::string &	str,
		unsigned int &	characteristics
	)		const

virtual

virtual void makVrf::DtSurfaceCharacteristicMap::printResults	(	const char *	str,
		unsigned int	characteristics,
		const char *	additionalInformation = `0`
	)		const

virtual

static DtSurfaceCharacteristicMapConstPtr makVrf::DtSurfaceCharacteristicMap::createSurfCharMap ( const DtFilename & surfCharFile )

static

Creates a new DtSurfaceCharacteristicMap instance and initializes it with the specified file. If the file is not found, the default mapping is created.

virtual bool makVrf::DtSurfaceCharacteristicMap::get ( std::istream & stream )

protectedvirtual

get data from a stream

virtual bool makVrf::DtSurfaceCharacteristicMap::processToken	(	std::istream &	stream,
		const DtString &	token
	)

protectedvirtual

identifies a token or passes token the parent class.

Member Data Documentation

EntryList makVrf::DtSurfaceCharacteristicMap::myEntries

protected

int makVrf::DtSurfaceCharacteristicMap::myCurrentPosition

protected

const DtString makVrf::DtSurfaceCharacteristicMap::theMatchString

staticprotected

const DtString makVrf::DtSurfaceCharacteristicMap::theRegExprMatchString

staticprotected

CharacteristicsFromStringMap makVrf::DtSurfaceCharacteristicMap::myCharacteristicsFromStringCache

mutableprotected

Keep a cache of the string already process in characteristicsFromString() to speed up the search.

tbb::spin_rw_mutex makVrf::DtSurfaceCharacteristicMap::myCharacteristicsFromStringCacheMutex

mutableprotected

Mutex to control access to myCharacteristicsFromStringCache.

std::set<std::string> makVrf::DtSurfaceCharacteristicMap::myPrintedMessages

mutableprivate

This is here to prevent error/status messages from streaming out endlessly. Should probably be changed to a logging class that is a member of the class, that explicitly has the "only output once" logic held internally. NOTE: This is used in the characteristicsFromString function.

See Also: characteristicsFromString

tbb::spin_rw_mutex makVrf::DtSurfaceCharacteristicMap::myPrintedMessagesMutex

mutableprivate

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vantageTerrainImplementation/surfaceCharacteristicsMap.h

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation