# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NLGEORGES::UFormDfn Class Reference

Georges DFN ifle interface. More...

#include <u_form_dfn.h>

Inheritance diagram for NLGEORGES::UFormDfn:

NLMISC::CRefCount NLGEORGES::CFormDfn List of all members.

Public Types

enum  TEntryType { EntryType, EntryDfn, EntryVirtualDfn }

Public Methods

virtual uint getNumEntry () const=0
 Return the number of entry in this DFN. More...

virtual bool getEntryType (uint entry, TEntryType &type, bool &array) const=0
 Return the entry type. More...

virtual bool getEntryName (uint entry, std::string &name) const=0
 Return the entry name Doesn't look in parents DFN. More...

virtual bool getEntryFilename (uint entry, std::string &name) const=0
 Return the filename of the type or the DFN. More...

virtual bool getEntryDfn (uint entry, UFormDfn **dfn)=0
 Return the entry DFN pointer Doesn't look in parents DFN. More...

virtual bool getEntryType (uint entry, UType **type)=0
 Return the entry Type pointer Doesn't look in parents DFN. More...

virtual uint getNumParents () const=0
 Get the number of parent DFN. More...

virtual bool getParent (uint parent, UFormDfn **parentRet)=0
 Get a parent. More...

virtual bool getParentFilename (uint parent, std::string &filename) const=0
 Get a parent filename. More...

virtual const std::string & getComment () const=0
 Get the comment. More...


Detailed Description

Georges DFN ifle interface.

Author:
Cyril 'Hulud' Corvazier , Nevrax France
Date:
2002

Definition at line 45 of file u_form_dfn.h.


Member Enumeration Documentation

enum NLGEORGES::UFormDfn::TEntryType
 

Enumeration values:
EntryType 
EntryDfn 
EntryVirtualDfn 

Definition at line 54 of file u_form_dfn.h.


Member Function Documentation

virtual const std::string& NLGEORGES::UFormDfn::getComment   const [pure virtual]
 

Get the comment.

Implemented in NLGEORGES::CFormDfn.

virtual bool NLGEORGES::UFormDfn::getEntryDfn uint    entry,
UFormDfn **    dfn
[pure 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.

Implemented in NLGEORGES::CFormDfn.

virtual bool NLGEORGES::UFormDfn::getEntryFilename uint    entry,
std::string &    name
const [pure 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.

Implemented in NLGEORGES::CFormDfn.

virtual bool NLGEORGES::UFormDfn::getEntryName uint    entry,
std::string &    name
const [pure 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.

Implemented in NLGEORGES::CFormDfn.

virtual bool NLGEORGES::UFormDfn::getEntryType uint    entry,
UType **    type
[pure 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.

Implemented in NLGEORGES::CFormDfn.

virtual bool NLGEORGES::UFormDfn::getEntryType uint    entry,
TEntryType   type,
bool &    array
const [pure 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.

Implemented in NLGEORGES::CFormDfn.

virtual uint NLGEORGES::UFormDfn::getNumEntry   const [pure virtual]
 

Return the number of entry in this DFN.

Implemented in NLGEORGES::CFormDfn.

virtual uint NLGEORGES::UFormDfn::getNumParents   const [pure virtual]
 

Get the number of parent DFN.

Doesn't look in parents DFN for parents.

Implemented in NLGEORGES::CFormDfn.

virtual bool NLGEORGES::UFormDfn::getParent uint    parent,
UFormDfn **    parentRet
[pure 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.

Implemented in NLGEORGES::CFormDfn.

virtual bool NLGEORGES::UFormDfn::getParentFilename uint    parent,
std::string &    filename
const [pure 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.

Implemented in NLGEORGES::CFormDfn.


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