VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Attributes | Static Protected Attributes | Private Attributes
makVrf::DtSurfaceCharacteristicMap Class Reference

Public Member Functions

 DtSurfaceCharacteristicMap ()
 default constructor.
virtual ~DtSurfaceCharacteristicMap ()
 destructor
 DtSurfaceCharacteristicMap (const DtSurfaceCharacteristicMap &orig)
 copy constructor
virtual bool init (const DtFilename filename, bool displayWarning=false)
 assignment operator - provided by default by compiler.
virtual bool get (std::istream &stream)
 get data from a stream
virtual bool processToken (std::istream &stream, DtString &token)
 identifies a token or passes token the parent class.
virtual bool characteristicsFromString (const char *str, unsigned int &characteristics, int &position)
 Set characteristics based on a string.
virtual void printResults (const char *str, unsigned int characteristics, const char *additionalInformation=0)

Protected Types

typedef boost::unordered_map
< DtString,
DtSurface::DtCharacteristics > 
DtSurfaceStringToCharacteristics
typedef
DtSurfaceStringToCharacteristics::const_iterator 
DtSurfStrToCharsConstIter
typedef
DtSurfaceStringToCharacteristics::iterator 
DtSurfStrToCharsIter

Protected Attributes

DtSurfaceStringToCharacteristics mySurfaceStringToCharacteristics

Static Protected Attributes

static const DtString theMatchString

Private Attributes

std::set< std::string > myPrintedMessages
 This is here to prevent error/status messages from streaming out endlessly.

Member Typedef Documentation

typedef boost::unordered_map<DtString, DtSurface::DtCharacteristics> makVrf::DtSurfaceCharacteristicMap::DtSurfaceStringToCharacteristics
protected
typedef DtSurfaceStringToCharacteristics::const_iterator makVrf::DtSurfaceCharacteristicMap::DtSurfStrToCharsConstIter
protected
typedef DtSurfaceStringToCharacteristics::iterator makVrf::DtSurfaceCharacteristicMap::DtSurfStrToCharsIter
protected

Constructor & Destructor Documentation

makVrf::DtSurfaceCharacteristicMap::DtSurfaceCharacteristicMap ( )

default constructor.

virtual makVrf::DtSurfaceCharacteristicMap::~DtSurfaceCharacteristicMap ( )
virtual

destructor

makVrf::DtSurfaceCharacteristicMap::DtSurfaceCharacteristicMap ( const DtSurfaceCharacteristicMap orig)

copy constructor

Member Function Documentation

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

assignment operator - provided by default by compiler.

This class is assignable. Initialize the metafile. Calls createSurface().

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

get data from a stream

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

identifies a token or passes token the parent class.

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

Set characteristics based on a string.

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

Member Data Documentation

DtSurfaceStringToCharacteristics makVrf::DtSurfaceCharacteristicMap::mySurfaceStringToCharacteristics
protected
const DtString makVrf::DtSurfaceCharacteristicMap::theMatchString
staticprotected
std::set<std::string> makVrf::DtSurfaceCharacteristicMap::myPrintedMessages
private

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

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)