FDExtractorBase Class Reference

Extractor base class. An extractor is a wrapper around an AVP that locates and accesses the AVP in the message or grouped AVP. More...

#include <efd.h>

Inheritance diagram for FDExtractorBase:

Public Member Functions
	FDExtractorBase (FDDictionaryEntryAVP *de)
	Class constructor. More...
virtual	~FDExtractorBase ()
	Class destructor. More...
virtual eFDExtractorType	getExtractorType ()=0
	Retrieves the type of this extractor. More...
Int	getIndex ()
	Retrieves the location of the AVP in the parent (message or AVP). More...
Int	setIndex (Int idx)
	Assigns the index of this AVP. More...
Bool	getResolved ()
	Retrieves the resolved status. Being resolved means that the underlying freeDiameter AVP has been located and assigned. More...
Bool	setResolved (Bool resolved=true)
	Assigns the resolved state. More...
Bool	exists ()
	Retrieves status indicating if the AVP is present/exists in the message. More...
FDDictionaryEntryAVP *	getDictionaryEntry ()
	Retrieves the dictionary entry associated with the AVP. More...

Detailed Description

Extractor base class. An extractor is a wrapper around an AVP that locates and accesses the AVP in the message or grouped AVP.

Constructor & Destructor Documentation

FDExtractorBase()

FDExtractorBase::FDExtractorBase ( FDDictionaryEntryAVP *  de )

inline

Class constructor.

Parameters

de	the dictionary entry for this extractor.

~FDExtractorBase()

virtual FDExtractorBase::~FDExtractorBase ( )

inlinevirtual

Class destructor.

Member Function Documentation

exists()

Bool FDExtractorBase::exists ( )

inline

Retrieves status indicating if the AVP is present/exists in the message.

Returns

True if the AVP exists, otherwise False.

getDictionaryEntry()

FDDictionaryEntryAVP* FDExtractorBase::getDictionaryEntry ( )

inline

Retrieves the dictionary entry associated with the AVP.

Returns

the AVP dictionary entry.

getExtractorType()

virtual eFDExtractorType FDExtractorBase::getExtractorType ( )

pure virtual

Retrieves the type of this extractor.

Returns

the extractor type.

Implemented in FDExtractorAvpList, FDExtractorAvp, FDExtractorList, and FDExtractor.

getIndex()

Int FDExtractorBase::getIndex ( )

inline

Retrieves the location of the AVP in the parent (message or AVP).

Returns

the index of this AVP.

getResolved()

Bool FDExtractorBase::getResolved ( )

inline

Retrieves the resolved status. Being resolved means that the underlying freeDiameter AVP has been located and assigned.

Returns

True if resolved, otherwise False.

setIndex()

Int FDExtractorBase::setIndex ( Int  idx )

inline

Assigns the index of this AVP.

Parameters

idx	the index of the AVP in the message or grouped AVP.

Returns

the assigned index.

setResolved()

Bool FDExtractorBase::setResolved ( Bool  resolved = true )

inline

Assigns the resolved state.

Parameters

resolved

the resolutions status to assign.

Returns

True if resolved, otherwise False.

---

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

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