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

An extractor for an AVP that can have multiple occurrances. More...

#include <efd.h>

Inheritance diagram for FDExtractorAvpList:
FDExtractorBase

Public Member Functions

 FDExtractorAvpList (FDExtractor &extractor, FDDictionaryEntryAVP &de)
 Class constructor. More...
 
virtual ~FDExtractorAvpList ()
 Class destructor. More...
 
eFDExtractorType getExtractorType ()
 Retrieves the extractor type. More...
 
std::list< FDExtractorAvp * > & getList ()
 Retrieves the list of extractors. 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...
 

Detailed Description

An extractor for an AVP that can have multiple occurrances.

Constructor & Destructor Documentation

◆ FDExtractorAvpList()

FDExtractorAvpList::FDExtractorAvpList ( FDExtractor extractor,
FDDictionaryEntryAVP de 
)

Class constructor.

Parameters
extractorthe parent extractor.
dethe associated dictionary entry.

◆ ~FDExtractorAvpList()

FDExtractorAvpList::~FDExtractorAvpList ( )
virtual

Class destructor.

Member Function Documentation

◆ dump()

Void FDExtractorAvpList::dump ( )

Prints the underlying freeDiameter message or AVP to stdout.

◆ exists()

Bool FDExtractorAvpList::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 FDExtractorAvpList::getExtractorType ( )
inlinevirtual

Retrieves the extractor type.

Returns
the extractor type.

Implements FDExtractorBase.

◆ getList()

std::list< FDExtractorAvp * > & FDExtractorAvpList::getList ( )

Retrieves the list of extractors.

Returns
the extractor list.

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