FDDictionaryEntryCommand Class Reference

A dictionary entry object associated with a command message. More...

#include <efd.h>

Inheritance diagram for FDDictionaryEntryCommand:

Public Member Functions
	FDDictionaryEntryCommand (const char *name, struct dictionary *dict=NULL)
	Class constructor. More...
	FDDictionaryEntryCommand (command_code_t cmdid, struct dictionary *dict=NULL)
	Class constructor. More...
	FDDictionaryEntryCommand (const FDDictionaryEntryCommand &req, struct dictionary *dict=NULL)
	Class constructor. More...
Bool	isRequest () const
	Returns True of the command is a request. More...
Bool	isAnswer () const
	Returns True of the command is an answer. More...
command_code_t	getCommandCode ()
	Returns the command ID. More...
const char *	getName ()
	Returns the command name. 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 a command message.

Constructor & Destructor Documentation

FDDictionaryEntryCommand() [1/3]

FDDictionaryEntryCommand::FDDictionaryEntryCommand	(	const char *	name,
		struct dictionary *	dict = NULL
	)

Class constructor.

Parameters

name	the name of the command.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

Exceptions

FDException

FDDictionaryEntryCommand() [2/3]

FDDictionaryEntryCommand::FDDictionaryEntryCommand	(	command_code_t	cmdid,
		struct dictionary *	dict = NULL
	)

Class constructor.

Parameters

cmdid	the ID of the command.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

Exceptions

FDException

FDDictionaryEntryCommand() [3/3]

FDDictionaryEntryCommand::FDDictionaryEntryCommand	(	const FDDictionaryEntryCommand &	req,
		struct dictionary *	dict = NULL
	)

Class constructor.

Parameters

req	the dictionary entry of the command.
dict	the dictionary to search. If NULL, then globally defined freeDiameter dictionary will be searched.

Exceptions

FDException

Member Function Documentation

getCommandCode()

command_code_t FDDictionaryEntryCommand::getCommandCode ( )

inline

Returns the command ID.

Returns

the ID of the command.

getName()

const char* FDDictionaryEntryCommand::getName ( )

inline

Returns the command name.

Returns

the name of the command.

isAnswer()

Bool FDDictionaryEntryCommand::isAnswer ( ) const

inline

Returns True of the command is an answer.

Returns

True if the command is an answer, otherwise False.

isRequest()

Bool FDDictionaryEntryCommand::isRequest ( ) const

inline

Returns True of the command is a request.

Returns

True if the command is a request, otherwise False.

---

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