DtReaderWriterClassDocDB Class Reference

Public Member Functions
	DtReaderWriterClassDocDB ()
	DtReaderWriterClassDocDB (const DtReaderWriterClassDocDB &orig)
const DtReaderWriterClassDocDB &	operator= (const DtReaderWriterClassDocDB &orig)
virtual	~DtReaderWriterClassDocDB ()
virtual void	addEntry (const DtReaderWriterClassDocumentation &entry)
	Add a given DtReaderWriter class documenation entry to the database. More...
virtual bool	lookup (const DtString &rwClassType, const DtString &rwDataMemberName, DtReaderWriterClassMemberDataRecord &record) const
	Look up the entry for a DtReaderWriter data member, give the DtReaderWriter name of the data member, and the DtReaderWriter class it belongs to. More...
virtual const std::vector < DtReaderWriterClassMemberDataRecord > &	lookup (const DtString &rwDataMemberName) const
	Looks up parameter entries by reader/writer name. More...

Protected Attributes
DtReaderWriterClassDocumentationMap	myRwClassDocumentationMap
	Map of DtReaderWriterClassDocumenation objects, keyed by DtReaderWriter class type. More...
DtReaderWriterMemberClassDocumentationMap	myRwMemberClassDocumentationMap

Constructor & Destructor Documentation

DtReaderWriterClassDocDB::DtReaderWriterClassDocDB

(

)

DtReaderWriterClassDocDB::DtReaderWriterClassDocDB

(

const DtReaderWriterClassDocDB &

orig

)

virtual DtReaderWriterClassDocDB::~DtReaderWriterClassDocDB ( )

virtual

Member Function Documentation

const DtReaderWriterClassDocDB& DtReaderWriterClassDocDB::operator=

(

const DtReaderWriterClassDocDB &

orig

)

virtual void DtReaderWriterClassDocDB::addEntry ( const DtReaderWriterClassDocumentation &  entry )

virtual

Add a given DtReaderWriter class documenation entry to the database.

There will be one entry per DtReaderWriter class.

virtual bool DtReaderWriterClassDocDB::lookup ( const DtString &  rwClassType, const DtString &  rwDataMemberName, DtReaderWriterClassMemberDataRecord &  record  ) const

virtual

Look up the entry for a DtReaderWriter data member, give the DtReaderWriter name of the data member, and the DtReaderWriter class it belongs to.

If the item cannot be located in the given class, it will recursively move up the inheritance tree in attempting to locate the item.

virtual const std::vector<DtReaderWriterClassMemberDataRecord>& DtReaderWriterClassDocDB::lookup ( const DtString &  rwDataMemberName ) const

virtual

Looks up parameter entries by reader/writer name.

Note that there could be multiple descriptors that have the same reader/writer variable name, so, it is up to the caller of this method to figure out what to do with that

Member Data Documentation

DtReaderWriterClassDocumentationMap DtReaderWriterClassDocDB::myRwClassDocumentationMap

protected

Map of DtReaderWriterClassDocumenation objects, keyed by DtReaderWriter class type.

DtReaderWriterMemberClassDocumentationMap DtReaderWriterClassDocDB::myRwMemberClassDocumentationMap

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjparam/rwClassDocDB.h