From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNLGEORGES_1_1CFormDfn.html | 1626 ++++++++++++++++++++++ 1 file changed, 1626 insertions(+) create mode 100644 docs/doxygen/nel/classNLGEORGES_1_1CFormDfn.html (limited to 'docs/doxygen/nel/classNLGEORGES_1_1CFormDfn.html') diff --git a/docs/doxygen/nel/classNLGEORGES_1_1CFormDfn.html b/docs/doxygen/nel/classNLGEORGES_1_1CFormDfn.html new file mode 100644 index 00000000..21800f7b --- /dev/null +++ b/docs/doxygen/nel/classNLGEORGES_1_1CFormDfn.html @@ -0,0 +1,1626 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NLGEORGES::CFormDfn Class Reference

This class is the defnition for a familly of from. +More... +

+#include <form_dfn.h> +

Inheritance diagram for NLGEORGES::CFormDfn: +

+ + + + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
	CFormDfn ()
void	write (xmlDocPtr root, const char *filename, bool georges4CVS)
uint	countParentDfn (uint32 round=0xffffffff) const
void	getParentDfn (std::vector< CFormDfn * > &array, uint32 round=0xffffffff)
void	getParentDfn (std::vector< const CFormDfn * > &array, uint32 round=0xffffffff) const
uint	getNumParent () const
void	setNumParent (uint size)
void	setParent (uint parent, CFormLoader &loader, const char *filename)
CFormDfn *	getParent (uint parent) const
const std::string &	getParentFilename (uint parent) const
uint	getNumEntry () const
	Return the number of entry in this DFN. More...
void	setNumEntry (uint size)
const CEntry &	getEntry (uint entry) const
CEntry &	getEntry (uint entry)
bool	getEntryType (uint entry, TEntryType &type, bool &array) const
	Return the entry type. More...
bool	getEntryName (uint entry, std::string &name) const
	Return the entry name Doesn't look in parents DFN. More...
bool	getEntryDfn (uint entry, UFormDfn **dfn)
	Return the entry DFN pointer Doesn't look in parents DFN. More...
bool	getEntryType (uint entry, UType **type)
	Return the entry Type pointer Doesn't look in parents DFN. More...
uint	getNumParents () const
	Get the number of parent DFN. More...
bool	getParent (uint parent, UFormDfn **parentRet)
	Get a parent. More...
const std::string &	getComment () const
	Get the comment. More...
bool	getEntryFilename (uint entry, std::string &filename) const
	Return the filename of the type or the DFN. More...
bool	getParentFilename (uint parent, std::string &filename) const
	Get a parent filename. More...
CFormDfn *	getSubDfn (uint index, uint &dfnIndex)
const CFormDfn *	getSubDfn (uint index, uint &dfnIndex) const
void	warning (bool exception, const char function, const char format,...) const
Public Attributes
CFileHeader	Header
Private Methods
void	read (xmlNodePtr doc, CFormLoader &loader, bool forceLoad, const char *filename)
Private Attributes
std::vector< CParent >	Parents
std::vector< CEntry >	Entries
uint32	Round
std::string	_Filename
Friends
class	CForm
class	CType
class	CFormElm
class	CFormLoader
class	CFormElmStruct
bool	convertDfnFile (const char oldFileName, const char newFileName)

Detailed Description

+This class is the defnition for a familly of from. +

+ +

+Definition at line 46 of file form_dfn.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NLGEORGES::CFormDfn::CFormDfn ( ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 57 of file form_dfn.h. +
+References Round. +
+Referenced by NLGEORGES::CFormDfn::CEntry::getDfnPtr, and getSubDfn.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
uint NLGEORGES::CFormDfn::countParentDfn ( uint32 round = 0xffffffff ) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 337 of file form_dfn.cpp. +
+References Parents, Round, and warning. +
+Referenced by getSubDfn.
+

+ + + + +
+ + + + + + + + + +
const std::string & NLGEORGES::CFormDfn::getComment ( ) const [virtual]
+
+ + + + + +
+ + + +
+Get the comment. +
+ +
+Implements NLGEORGES::UFormDfn. +
+Definition at line 772 of file form_dfn.cpp. +
+References Header.
+

+ + + + +
+ + + + + + + + + + +
CFormDfn::CEntry & NLGEORGES::CFormDfn::getEntry ( uint entry )
+
+ + + + + +
+ + + +
+ +
+Definition at line 457 of file form_dfn.cpp. +
+References Entries.
+

+ + + + +
+ + + + + + + + + + +
const CFormDfn::CEntry & NLGEORGES::CFormDfn::getEntry ( uint entry ) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 450 of file form_dfn.cpp. +
+References Entries.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLGEORGES::CFormDfn::getEntryDfn ( uint entry,
UFormDfn ** dfn
) [virtual]
+
+ + + + + +
+ + + +
+Return the entry DFN pointer Doesn't look in parents DFN. +
+
+Parameters:
+ + + +
entry +is the entry id to get the dfn pointer.
dfn +will be filled with the DFN pointer.
+
+Returns:
+true if successed, false if the entry doesn't exist or is not a DFN.
+
+Implements NLGEORGES::UFormDfn. +
+Definition at line 702 of file form_dfn.cpp. +
+References Entries, NLGEORGES::UFormDfn::EntryDfn, and warning.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLGEORGES::CFormDfn::getEntryFilename ( uint entry,
std::string & filename
) const [virtual]
+
+ + + + + +
+ + + +
+Return the filename of the type or the DFN. +
+Doesn't look in parents DFN.
+Parameters:
+ + + +
entry +is the entry id to get the dfn pointer.
name +will be filled with the entry filename.
+
+Returns:
+true if successed, false if the entry doesn't exist or is a virtual DFN.
+
+Implements NLGEORGES::UFormDfn. +
+Definition at line 671 of file form_dfn.cpp. +
+References Entries, NLGEORGES::UFormDfn::EntryVirtualDfn, and warning.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLGEORGES::CFormDfn::getEntryName ( uint entry,
std::string & name
) const [virtual]
+
+ + + + + +
+ + + +
+Return the entry name Doesn't look in parents DFN. +
+
+Parameters:
+ + + +
entry +is the entry id to get the dfn pointer.
name +will be filled with the entry name.
+
+Returns:
+true if successed, false if the entry doesn't exist.
+
+Implements NLGEORGES::UFormDfn. +
+Definition at line 689 of file form_dfn.cpp. +
+References Entries, and warning.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLGEORGES::CFormDfn::getEntryType ( uint entry,
UType ** type
) [virtual]
+
+ + + + + +
+ + + +
+Return the entry Type pointer Doesn't look in parents DFN. +
+
+Parameters:
+ + + +
entry +is the entry id to get the dfn pointer.
type +will be filled with the TYPE pointer.
+
+Returns:
+true if successed, false if the entry doesn't exist or is not a Type.
+
+Implements NLGEORGES::UFormDfn. +
+Definition at line 720 of file form_dfn.cpp. +
+References Entries, NLGEORGES::UFormDfn::EntryType, type, and warning.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
bool NLGEORGES::CFormDfn::getEntryType ( uint entry,
TEntryType & type,
bool & array
) const [virtual]
+
+ + + + + +
+ + + +
+Return the entry type. +
+Doesn't look in parents DFN.
+Parameters:
+ + + + +
entry +is the entry id to get the type.
type +will be filled with the entry type.
array +is true if the entry is an array, else false.
+
+Returns:
+true if successed, false if the entry doesn't exist.
+
+Implements NLGEORGES::UFormDfn. +
+Definition at line 657 of file form_dfn.cpp. +
+References Entries, type, and warning.
+

+ + + + +
+ + + + + + + + + +
uint NLGEORGES::CFormDfn::getNumEntry ( ) const [virtual]
+
+ + + + + +
+ + + +
+Return the number of entry in this DFN. +
+ +
+Implements NLGEORGES::UFormDfn. +
+Definition at line 436 of file form_dfn.cpp. +
+References Entries.
+

+ + + + +
+ + + + + + + + + +
uint NLGEORGES::CFormDfn::getNumParent ( ) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 415 of file form_dfn.cpp. +
+References Parents.
+

+ + + + +
+ + + + + + + + + +
uint NLGEORGES::CFormDfn::getNumParents ( ) const [virtual]
+
+ + + + + +
+ + + +
+Get the number of parent DFN. +
+Doesn't look in parents DFN for parents. +
+Implements NLGEORGES::UFormDfn. +
+Definition at line 738 of file form_dfn.cpp. +
+References Parents.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLGEORGES::CFormDfn::getParent ( uint parent,
UFormDfn ** parentRet
) [virtual]
+
+ + + + + +
+ + + +
+Get a parent. +
+
+Parameters:
+ + + +
entry +is the entry id to get the dfn pointer.
parent +will be filled with the parent pointer.
+
+Returns:
+true if successed, false if the parent doesn't exist.
+
+Implements NLGEORGES::UFormDfn. +
+Definition at line 745 of file form_dfn.cpp. +
+References Parents, and warning.
+

+ + + + +
+ + + + + + + + + + +
CFormDfn * NLGEORGES::CFormDfn::getParent ( uint parent ) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 422 of file form_dfn.cpp. +
+References Parents.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLGEORGES::CFormDfn::getParentDfn ( std::vector< const CFormDfn * > & array,
uint32 round = 0xffffffff
) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 389 of file form_dfn.cpp. +
+References Parents, Round, and warning.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLGEORGES::CFormDfn::getParentDfn ( std::vector< CFormDfn * > & array,
uint32 round = 0xffffffff
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 363 of file form_dfn.cpp. +
+References Parents, Round, and warning. +
+Referenced by getSubDfn.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLGEORGES::CFormDfn::getParentFilename ( uint parent,
std::string & filename
) const [virtual]
+
+ + + + + +
+ + + +
+Get a parent filename. +
+
+Parameters:
+ + + +
entry +is the entry id to get the dfn pointer.
parent +will be filled with the parent pointer.
+
+Returns:
+true if successed, false if the parent doesn't exist.
+
+Implements NLGEORGES::UFormDfn. +
+Definition at line 759 of file form_dfn.cpp. +
+References Parents, and warning.
+

+ + + + +
+ + + + + + + + + + +
const string & NLGEORGES::CFormDfn::getParentFilename ( uint parent ) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 429 of file form_dfn.cpp. +
+References Parents.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
const CFormDfn * NLGEORGES::CFormDfn::getSubDfn ( uint index,
uint & dfnIndex
) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 630 of file form_dfn.cpp. +
+References countParentDfn, getParentDfn, index, and nlstop.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
CFormDfn * NLGEORGES::CFormDfn::getSubDfn ( uint index,
uint & dfnIndex
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 603 of file form_dfn.cpp. +
+References CFormDfn, countParentDfn, getParentDfn, index, and nlstop.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NLGEORGES::CFormDfn::read ( xmlNodePtr doc,
CFormLoader & loader,
bool forceLoad,
const char * filename
) [private]
+
+ + + + + +
+ + + +
+ +
+Definition at line 118 of file form_dfn.cpp. +
+References _Filename, Entries, Header, nlassert, Parents, stricmp, type, value, and warning.
+

+ + + + +
+ + + + + + + + + + +
void NLGEORGES::CFormDfn::setNumEntry ( uint size )
+
+ + + + + +
+ + + +
+ +
+Definition at line 443 of file form_dfn.cpp. +
+References Entries.
+

+ + + + +
+ + + + + + + + + + +
void NLGEORGES::CFormDfn::setNumParent ( uint size )
+
+ + + + + +
+ + + +
+ +
+Definition at line 464 of file form_dfn.cpp. +
+References Parents.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NLGEORGES::CFormDfn::setParent ( uint parent,
CFormLoader & loader,
const char * filename
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 471 of file form_dfn.cpp. +
+References Parents.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NLGEORGES::CFormDfn::warning ( bool exception,
const char * function,
const char * format,
...
) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 793 of file form_dfn.cpp. +
+References _Filename, format, and NLGEORGES::warning. +
+Referenced by countParentDfn, getEntryDfn, getEntryFilename, getEntryName, getEntryType, getParent, getParentDfn, getParentFilename, and read.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NLGEORGES::CFormDfn::write ( xmlDocPtr root,
const char * filename,
bool georges4CVS
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file form_dfn.cpp. +
+References _Filename, Entries, Header, and Parents.
+

+ + + + +
+ + +
friend class CFormElm [friend] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file form_dfn.h.
+

+ + + + +
+ + +
friend class CFormElmStruct [friend] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 52 of file form_dfn.h.
+

+ + + + +
+ + +
friend class CFormLoader [friend] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 51 of file form_dfn.h. +
+Referenced by NLGEORGES::CFormDfn::CEntry::setDfn.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool convertDfnFile ( const char * oldFileName,
const char * newFileName
) [friend]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + +
friend class CType [friend] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 49 of file form_dfn.h. +
+Referenced by NLGEORGES::CFormDfn::CEntry::getTypePtr.
+

Member Data Documentation

+ + + + +
+ + +
std::string NLGEORGES::CFormDfn::_Filename [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 241 of file form_dfn.h. +
+Referenced by read, warning, and write.
+

+ + + + +
+ + +
std::vector<CEntry> NLGEORGES::CFormDfn::Entries [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 235 of file form_dfn.h. +
+Referenced by getEntry, getEntryDfn, getEntryFilename, getEntryName, getEntryType, getNumEntry, read, setNumEntry, and write.
+

+ + + + +
+ + +
CFileHeader NLGEORGES::CFormDfn::Header +
+
+ + + + + +
+ + + +
+ +
+Definition at line 225 of file form_dfn.h. +
+Referenced by getComment, read, and write.
+

+ + + + +
+ + +
std::vector<CParent> NLGEORGES::CFormDfn::Parents [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 232 of file form_dfn.h. +
+Referenced by countParentDfn, getNumParent, getNumParents, getParent, getParentDfn, getParentFilename, read, setNumParent, setParent, and write.
+

+ + + + +
+ + +
uint32 NLGEORGES::CFormDfn::Round [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 238 of file form_dfn.h. +
+Referenced by CFormDfn, countParentDfn, and getParentDfn.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLGEORGES::CFormDfn Class Reference

Public Methods

Public Attributes

Private Methods

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation