EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | Protected Member Functions | List of all members
FDExtractorList Class Referenceabstract

A wrapper around a grouped AVP that can occur multiple times. More...

#include <efd.h>

Inheritance diagram for FDExtractorList:
FDExtractorBase

Public Member Functions

 FDExtractorList (FDExtractor &parent, FDDictionaryEntryAVP &de)
 Class constructor. More...
 
virtual ~FDExtractorList ()
 Class destructor. More...
 
eFDExtractorType getExtractorType ()
 Retrieves the extractor type. More...
 
FDExtractorgetParent ()
 Retrieves the parent extractor object. More...
 
virtual FDExtractorcreateExtractor ()=0
 Virtual method to create an extractor list member object. More...
 
Void addExtractor (FDExtractor *e)
 Adds an extractor to the list. More...
 
Bool exists ()
 Determines if this extractor exists in the underlying freeDiameter message or grouped AVP. More...
 
Void dump ()
 Prints the underlying freeDiameter message or AVP to stdout. More...
 
- Public Member Functions inherited from FDExtractorBase
 FDExtractorBase (FDDictionaryEntryAVP *de)
 Class constructor. More...
 
virtual ~FDExtractorBase ()
 Class destructor. 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...
 
FDDictionaryEntryAVPgetDictionaryEntry ()
 Retrieves the dictionary entry associated with the AVP. More...
 

Protected Member Functions

std::list< FDExtractor * > & getList ()
 Retrieves the extractor list. More...
 

Detailed Description

A wrapper around a grouped AVP that can occur multiple times.

Constructor & Destructor Documentation

◆ FDExtractorList()

FDExtractorList::FDExtractorList ( FDExtractor parent,
FDDictionaryEntryAVP de 
)

Class constructor.

Parameters
parentthe parent extractor object.
dethe dictionary entry for this extractor.

◆ ~FDExtractorList()

FDExtractorList::~FDExtractorList ( )
virtual

Class destructor.

Member Function Documentation

◆ addExtractor()

Void FDExtractorList::addExtractor ( FDExtractor e)

Adds an extractor to the list.

Parameters
ethe extractor to add.

◆ createExtractor()

virtual FDExtractor* FDExtractorList::createExtractor ( )
pure virtual

Virtual method to create an extractor list member object.

Returns
the created extractor object.

◆ dump()

Void FDExtractorList::dump ( )

Prints the underlying freeDiameter message or AVP to stdout.

◆ exists()

Bool FDExtractorList::exists ( )

Determines if this extractor exists in the underlying freeDiameter message or grouped AVP.

Returns
True if the AVP has been found in the message or grouped AVP.

◆ getExtractorType()

eFDExtractorType FDExtractorList::getExtractorType ( )
inlinevirtual

Retrieves the extractor type.

Returns
the extractor type.

Implements FDExtractorBase.

◆ getList()

std::list< FDExtractor * > & FDExtractorList::getList ( )
protected

Retrieves the extractor list.

Returns
the extractor list.

◆ getParent()

FDExtractor& FDExtractorList::getParent ( )
inline

Retrieves the parent extractor object.

Returns
the parent extractor object.

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