FDExtractorKey Class Reference

Used as the key to a collection of extractors. More...

#include <efd.h>

Public Member Functions
	FDExtractorKey ()
	Class constructor. More...
	FDExtractorKey (vendor_id_t v, avp_code_t a)
	Class constructor. More...
	FDExtractorKey (const FDExtractorKey &k)
	Copy constructor. More...
virtual	~FDExtractorKey ()
	Class destructor. More...
Bool	operator< (const FDExtractorKey &rval) const
	Determins if the provided extractor key is less than this extractor key. More...
vendor_id_t	getVendor ()
	Retrieves the vendor ID. More...
vendor_id_t	setVendor (vendor_id_t v)
	Assigns the vendor ID. More...
avp_code_t	getAvpCode ()
	Retrieves the AVP code. More...
avp_code_t	setAvpCode (avp_code_t a)
	Assigns the AVP code. More...

Detailed Description

Used as the key to a collection of extractors.

Constructor & Destructor Documentation

FDExtractorKey() [1/3]

FDExtractorKey::FDExtractorKey ( )

inline

Class constructor.

FDExtractorKey() [2/3]

FDExtractorKey::FDExtractorKey ( vendor_id_t  v, avp_code_t  a  )

inline

Class constructor.

Parameters

v	the vendor ID for the key.
a	the AVP code for the key.

FDExtractorKey() [3/3]

FDExtractorKey::FDExtractorKey ( const FDExtractorKey &  k )

inline

Copy constructor.

Parameters

k	the key object to copy.

~FDExtractorKey()

virtual FDExtractorKey::~FDExtractorKey ( )

inlinevirtual

Class destructor.

Member Function Documentation

getAvpCode()

avp_code_t FDExtractorKey::getAvpCode ( )

inline

Retrieves the AVP code.

Returns

the AVP code of this key.

getVendor()

vendor_id_t FDExtractorKey::getVendor ( )

inline

Retrieves the vendor ID.

Returns

the vendor ID of this key.

operator<()

Bool FDExtractorKey::operator< ( const FDExtractorKey &  rval ) const

inline

Determins if the provided extractor key is less than this extractor key.

Parameters

rval	the right hand value to evaluate.

Returns

True indicating that the provided key is less than this key, otherwise False.

setAvpCode()

avp_code_t FDExtractorKey::setAvpCode ( avp_code_t  a )

inline

Assigns the AVP code.

Parameters

a	the AVP code to assign.

Returns

the assigned AVP code.

setVendor()

vendor_id_t FDExtractorKey::setVendor ( vendor_id_t  v )

inline

Assigns the vendor ID.

Parameters

v	the vendor ID to assign.

Returns

the assigned vendor ID.

---

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

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