FDDictionaryEntryAVP Class Reference

A dictionary entry object associated with an AVP. More...

#include <efd.h>

Inheritance diagram for FDDictionaryEntryAVP:

Public Member Functions
	FDDictionaryEntryAVP (const char *name, Bool allVendors=false, struct dictionary *dict=NULL)
	Class constructor. More...
	FDDictionaryEntryAVP (const char *name, vendor_id_t vendorid, struct dictionary *dict=NULL)
	Class constructor. More...
	FDDictionaryEntryAVP (struct dict_object *de)
	Class constructor. More...
Bool	isDerived () const
	Indicates whether the data type is derived from another or if it is a base data type. More...
const char *	getName () const
	Returns the AVP name. More...
vendor_id_t	getVendorId () const
	Returns the AVP vendor ID. More...
avp_code_t	getAvpCode () const
	Returns the AVP code/ID. More...
DiameterDataType	getDataType () const
	Returns the data type of the AVP. More...
Public Member Functions inherited from FDDictionaryEntry
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...

Additional Inherited Members
Protected Member Functions inherited from FDDictionaryEntry
	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 dictionary entry object associated with an AVP.

Constructor & Destructor Documentation

FDDictionaryEntryAVP() [1/3]

FDDictionaryEntryAVP::FDDictionaryEntryAVP	(	const char *	name,
		Bool	allVendors = false,
		struct dictionary *	dict = NULL
	)

Class constructor.

Parameters

name	the name of the AVP.
allVendors	indicates to whether to search all vendors or not.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

Exceptions

FDException

FDDictionaryEntryAVP() [2/3]

FDDictionaryEntryAVP::FDDictionaryEntryAVP	(	const char *	name,
		vendor_id_t	vendorid,
		struct dictionary *	dict = NULL
	)

Class constructor.

Parameters

name	the name of the AVP.
vendorid	the vendor ID of the AVP to search for.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

Exceptions

FDException

FDDictionaryEntryAVP() [3/3]

FDDictionaryEntryAVP::FDDictionaryEntryAVP

(

struct dict_object *

de

)

Class constructor.

Parameters

de	the dictionary entry object to look up.

Exceptions

FDException

Member Function Documentation

getAvpCode()

avp_code_t FDDictionaryEntryAVP::getAvpCode ( ) const

inline

Returns the AVP code/ID.

Returns

the AVP code/ID for this AVP.

getDataType()

DiameterDataType FDDictionaryEntryAVP::getDataType ( ) const

inline

Returns the data type of the AVP.

Returns

the data type for this AVP.

getName()

const char* FDDictionaryEntryAVP::getName ( ) const

inline

Returns the AVP name.

Returns

the name of the AVP.

getVendorId()

vendor_id_t FDDictionaryEntryAVP::getVendorId ( ) const

inline

Returns the AVP vendor ID.

Returns

the vendor ID for this AVP.

isDerived()

Bool FDDictionaryEntryAVP::isDerived ( ) const

inline

Indicates whether the data type is derived from another or if it is a base data type.

Returns

True if the data type is derived, False if it is a base data type.

---

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