Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 

NLGEORGES::UFormDfn Class Reference

#include <u_form_dfn.h>

Inheritance diagram for NLGEORGES::UFormDfn:

NLMISC::CRefCount NLGEORGES::CFormDfn

Detailed Description

Georges DFN ifle interface

Author:
Cyril 'Hulud' Corvazier

Nevrax France

Date:
2002

Definition at line 45 of file u_form_dfn.h.

Public Types

enum  TEntryType { EntryType, EntryDfn, EntryVirtualDfn }

Public Member Functions

virtual const std::string & getComment () const=0
virtual void getDependencies (std::set< std::string > &dependencies) const=0
virtual bool getEntryDfn (uint entry, UFormDfn **dfn)=0
virtual bool getEntryDfnByName (const std::string &name, UFormDfn **dfn)=0
virtual bool getEntryFilename (uint entry, std::string &name) const=0
virtual bool getEntryFilenameExt (uint entry, std::string &name) const=0
virtual bool getEntryIndexByName (uint &entry, const std::string &name) const=0
virtual bool getEntryName (uint entry, std::string &name) const=0
virtual bool getEntryType (uint entry, UType **type)=0
virtual bool getEntryType (uint entry, TEntryType &type, bool &array) const=0
virtual uint getNumEntry () const=0
virtual uint getNumParents () const=0
virtual bool getParent (uint parent, UFormDfn **parentRet)=0
virtual bool getParentFilename (uint parent, std::string &filename) const=0
const sint & getRefCount () const
virtual bool isAnArrayEntryByName (const std::string &name) const=0
virtual ~UFormDfn ()

Data Fields

sint crefs
CPtrInfo * pinfo

Static Public Attributes

CPtrInfo NullPtrInfo

Friends

struct CPtrInfo

Member Enumeration Documentation

enum NLGEORGES::UFormDfn::TEntryType
 

Enumeration values:
EntryType 
EntryDfn 
EntryVirtualDfn 

Definition at line 56 of file u_form_dfn.h. 

00057         {
00058                 EntryType,
00059                 EntryDfn,
00060                 EntryVirtualDfn,
00061         };

Constructor & Destructor Documentation

virtual NLGEORGES::UFormDfn::~UFormDfn (   )  [inline, virtual]
 

Definition at line 49 of file u_form_dfn.h. 

00049 { }

Member Function Documentation

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

Get the comment

Implemented in NLGEORGES::CFormDfn.

virtual void NLGEORGES::UFormDfn::getDependencies (  std::set< std::string > &  dependencies  )  const [pure virtual]
 

Get dependency files

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::getEntryDfnByName (  const std::string &  name,
UFormDfn **  dfn
)  [pure virtual]
 

Return the entry DFN pointer Doesn't look in parents DFN.

Parameters:
name is the supposed name of the dfn.
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::getEntryFilenameExt (  uint  entry,
std::string &  name
)  const [pure virtual]
 

Return the filename extension used by the DFN entry. 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::getEntryIndexByName (  uint &  entry,
const std::string &  name
)  const [pure virtual]
 

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.

const sint& NLMISC::CRefCount::getRefCount (   )  const [inline, inherited]
 

Definition at line 70 of file smart_ptr.h.

References NLMISC::CRefCount::crefs, and sint. 

00071         {
00072                 return  crefs;
00073         }

virtual bool NLGEORGES::UFormDfn::isAnArrayEntryByName (  const std::string &  name  )  const [pure virtual]
 

Implemented in NLGEORGES::CFormDfn.

Friends And Related Function Documentation

friend struct CPtrInfo [friend, inherited]
 

Definition at line 67 of file smart_ptr.h.

Field Documentation

sint NLMISC::CRefCount::crefs [mutable, inherited]
 

Definition at line 79 of file smart_ptr.h.

Referenced by NLMISC::CRefCount::CRefCount(), NLMISC::CRefCount::getRefCount(), and NLMISC::CRefCount::~CRefCount().

CRefCount::CPtrInfo NLMISC::CRefCount::NullPtrInfo [static, inherited]
 

Referenced by NLMISC::CRefCount::CRefCount().

CPtrInfo* NLMISC::CRefCount::pinfo [mutable, inherited]
 

Definition at line 80 of file smart_ptr.h.

Referenced by NLMISC::CRefCount::CRefCount(), and NLMISC::CRefCount::~CRefCount().

The documentation for this class was generated from the following file:
Generated on Tue Mar 16 12:46:29 2004 for NeL by doxygen 1.3.6