FDDictionaryEntry Class Reference

A class wrapper around a freeDiameter dictionary entry. This base class is not intended to be directly instantiated. More...

#include <efd.h>

Inheritance diagram for FDDictionaryEntry:

Public Member Functions
struct dictionary *	getDictionary () const
	Returns the freeDiameter dictionary structure pointer. More...
struct dict_object *	getEntry () const
	Returns the freeDiameter dictionary entry structure pointer. More...
Bool	isValid ()
	Returns true if the dictionary entry is valid. More...

Protected Member Functions
	FDDictionaryEntry ()
	Class constructor. More...
	FDDictionaryEntry (const Void *what, enum dict_object_type type, Int criteria, struct dictionary *dict=NULL)
	Class constructor. More...
Void	init (const Void *what, enum dict_object_type type, Int criteria, struct dictionary *dict=NULL)
	initializes an object created with the default constructor. More...
Void	init (struct dict_object *de, struct dictionary *dict=NULL)
	intializes an object using an existing freeDiameter dictionary entry. More...
virtual	~FDDictionaryEntry ()
	Class destructor. More...

Detailed Description

A class wrapper around a freeDiameter dictionary entry. This base class is not intended to be directly instantiated.

Constructor & Destructor Documentation

FDDictionaryEntry() [1/2]

FDDictionaryEntry::FDDictionaryEntry ( )

protected

Class constructor.

FDDictionaryEntry() [2/2]

FDDictionaryEntry::FDDictionaryEntry ( const Void *  what, enum dict_object_type  type, Int  criteria, struct dictionary *  dict = NULL  )

protected

Class constructor.

Parameters

what	depending on criteria, the data that must be searched.
type	type of object that is being searched.
criteria	how the object must be searched.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

~FDDictionaryEntry()

FDDictionaryEntry::~FDDictionaryEntry ( )

protectedvirtual

Class destructor.

Member Function Documentation

getDictionary()

struct dictionary* FDDictionaryEntry::getDictionary ( ) const

inline

Returns the freeDiameter dictionary structure pointer.

Returns

the freeDiameter dictionary pointer.

getEntry()

struct dict_object* FDDictionaryEntry::getEntry ( ) const

inline

Returns the freeDiameter dictionary entry structure pointer.

Returns

the freeDiameter dictionary entry pointer.

init() [1/2]

Void FDDictionaryEntry::init ( const Void *  what, enum dict_object_type  type, Int  criteria, struct dictionary *  dict = NULL  )

protected

initializes an object created with the default constructor.

Parameters

what	depending on criteria, the data that must be searched.
type	type of object that is being searched.
criteria	how the object must be searched.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

init() [2/2]

Void FDDictionaryEntry::init ( struct dict_object *  de, struct dictionary *  dict = NULL  )

protected

intializes an object using an existing freeDiameter dictionary entry.

Parameters

de	the dictionary entry to search.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

isValid()

Bool FDDictionaryEntry::isValid ( )

inline

Returns true if the dictionary entry is valid.

Returns

True if this dictionary entry is valid, otherwise False.

---

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

• /home/vagrant/share/code/epctools/include/epc/efd.h
• /home/vagrant/share/code/epctools/src/efd.cpp