#include <MessageChecker.h>

Inheritance diagram for inet::MessageChecker:

Public Member Functions
	MessageChecker ()

Protected Member Functions
void	initialize () override

void	handleMessage (cMessage *msg) override

void	checkMessage (cMessage *msg)

void	forwardMessage (cMessage *msg)

void	finish () override

void	checkFields (void object, cClassDescriptor descriptor, const cXMLElementList &msgPattern) const

void	checkFieldValue (void object, cClassDescriptor descriptor, int field, cXMLAttributeMap &attr, int i=0) const

void	checkFieldObject (void object, cClassDescriptor descriptor, int field, cXMLAttributeMap &attr, const cXMLElement &pattern, int i=0) const

int	checkFieldArray (void object, cClassDescriptor descriptor, int field, cXMLAttributeMap &attr) const

void	checkFieldValueInArray (void object, cClassDescriptor descriptor, int field, cXMLAttributeMap &attr) const

void	checkFieldObjectInArray (void object, cClassDescriptor descriptor, int field, cXMLAttributeMap &attr, const cXMLElement &pattern) const

void	checkFieldType (void object, cClassDescriptor descriptor, int field, cXMLAttributeMap &attrList, int i=0) const

int	findFieldIndex (void object, cClassDescriptor descriptor, const std::string &fieldName) const

Protected Attributes
cXMLElementList	m_checkingInfo

cXMLElementList::iterator	m_iterChk
	List of checking information. More...

unsigned	forwardedMsg
	Interator of the list of chacking information. More...

unsigned	checkedMsg
	Number of received and forwarded messages. More...

Constructor & Destructor Documentation

inet::MessageChecker::MessageChecker ( )

     : forwardedMsg(0)
     , checkedMsg(0)
 {
 }

Member Function Documentation

int inet::MessageChecker::checkFieldArray	(	void *	object,
		cClassDescriptor *	descriptor,
		int	field,
		cXMLAttributeMap &	attr
	)		const

protected

Referenced by checkFieldObjectInArray(), checkFields(), and checkFieldValueInArray().

 {
     if (!descriptor->getFieldIsArray(field))
         throw cRuntimeError("The field \"%s\" in message %d isn't an array", attr["name"].data(), forwardedMsg);
 
     // check the size of the field array into the client object
     int size = atol(attr["size"].data());
     int fieldSize = descriptor->getFieldArraySize(object, field);
     if (size != fieldSize)
         throw cRuntimeError("Field array \"%s\" contains %d element(s) (and not %d) in message %d",
                 attr["name"].data(), fieldSize, size, forwardedMsg);
 
     return fieldSize;
 }

void inet::MessageChecker::checkFieldObject	(	void *	object,
		cClassDescriptor *	descriptor,
		int	field,
		cXMLAttributeMap &	attr,
		const cXMLElement &	pattern,
		int	i = `0`
	)		const

protected

Referenced by checkFieldObjectInArray(), and checkFields().

 {
     // get the client object associated to the field
     void *obj = descriptor->getFieldStructValuePointer(object, field, i);
 
     // get the client object associated to the field, and its descriptor class
     cClassDescriptor *descr = descriptor->getFieldIsCObject(field) ?
         cClassDescriptor::getDescriptorFor((cObject *)obj) :
         cClassDescriptor::getDescriptorFor(descriptor->getFieldStructName(field));
 
     checkFields(obj, descr, pattern.getChildren());
 }

void inet::MessageChecker::checkFieldObjectInArray	(	void *	object,
		cClassDescriptor *	descriptor,
		int	field,
		cXMLAttributeMap &	attr,
		const cXMLElement &	pattern
	)		const

protected

Referenced by checkFields().

 {
     int fieldSize = checkFieldArray(object, descriptor, field, attr);
 
     // convert attribute "index" into integer
     int i = atol(attr["index"].data());
 
     if (i >= fieldSize)
         throw cRuntimeError("Field \"%s\" in message %d has no entry for index %d", attr["name"].data(), forwardedMsg, i);
 
     // check field object into the client object
     checkFieldObject(object, descriptor, field, attr, pattern, i);
 }

void inet::MessageChecker::checkFields	(	void *	object,
		cClassDescriptor *	descriptor,
		const cXMLElementList &	msgPattern
	)		const

protected

Referenced by checkFieldObject(), and checkMessage().

 {
     // fldPatternList contains the list of fields to be inspected
     cXMLElementList::const_iterator iter = msgPattern.begin();
     while (iter != msgPattern.end()) {
         const cXMLElement& pattern = **iter;
         cXMLAttributeMap attr = pattern.getAttributes();
         std::string patternType(pattern.getTagName());
 
         // find field position into the client object
         int field = findFieldIndex(object, descriptor, attr["name"]);
 
         // check the field type into the client object (if requiered)
         if (attr.find("type") != attr.end())
             checkFieldType(object, descriptor, field, attr);
 
         if (patternType == "fieldValue")
             checkFieldValue(object, descriptor, field, attr);
         else if (patternType == "fieldObject")
             checkFieldObject(object, descriptor, field, attr, pattern);
         else if (patternType == "fieldArray")
             checkFieldArray(object, descriptor, field, attr);
         else if (patternType == "fieldValueInArray")
             checkFieldValueInArray(object, descriptor, field, attr);
         else if (patternType == "fieldObjectInArray")
             checkFieldObjectInArray(object, descriptor, field, attr, pattern);
 
         iter++;
     }
 }

void inet::MessageChecker::checkFieldType	(	void *	object,
		cClassDescriptor *	descriptor,
		int	field,
		cXMLAttributeMap &	attrList,
		int	i = `0`
	)		const

protected

Referenced by checkFields().

 {
     std::string type;
 
     if (descriptor->getFieldIsCObject(field))
         type = ((cObject *)descriptor->getFieldStructValuePointer(object, field, i))->getClassName();
     else
         type = descriptor->getFieldTypeString(field);
 
     if (type != attr["type"])
         throw cRuntimeError("Type mismatch for field \"%s\" in message %d (\"%s\" != \"%s\")",
                 attr["name"].data(), forwardedMsg, type.data(), attr["type"].data());
 }

void inet::MessageChecker::checkFieldValue	(	void *	object,
		cClassDescriptor *	descriptor,
		int	field,
		cXMLAttributeMap &	attr,
		int	i = `0`
	)		const

protected

Referenced by checkFields(), and checkFieldValueInArray().

 {
     // get the field string value from the client object
     std::string value = descriptor->getFieldValueAsString(object, field, i);
 
     // convert the field value into its name of enum value
     if (descriptor->getFieldProperty(field, "enum")) {
         cEnum *enm = cEnum::find(descriptor->getFieldProperty(field, "enum"));
         if (enm)
             value = enm->getStringFor(atol(value.c_str()));
     }
 
     // check field value into the client object
     if (value.find(attr["value"]) != 0) //allow to keep reference values even if
                                         //simtime precision changed...
         throw cRuntimeError("Mismatch: field \"%s\" in the message %d (\"%s\" != \"%s\")",
                 attr["name"].data(), forwardedMsg, value.data(), attr["value"].data());
 }

void inet::MessageChecker::checkFieldValueInArray	(	void *	object,
		cClassDescriptor *	descriptor,
		int	field,
		cXMLAttributeMap &	attr
	)		const

protected

Referenced by checkFields().

 {
     int fieldSize = checkFieldArray(object, descriptor, field, attr);
 
     // convert attribute "index" into integer
     int i = atol(attr["index"].data());
 
     if (i >= fieldSize)
         throw cRuntimeError("Field \"%s\" in message %d has no entry for index %d", attr["name"].data(), forwardedMsg, i);
 
     // check field value into the client object
     checkFieldValue(object, descriptor, field, attr, i);
 }

void inet::MessageChecker::checkMessage ( cMessage * msg )

protected

Referenced by handleMessage().

 {
     while (m_iterChk != m_checkingInfo.end()) {
         cXMLElement& messagePattern = **m_iterChk;
 
         if (std::string(messagePattern.getTagName()) == "message" && messagePattern.hasAttributes()) {
             int occurence = atol(messagePattern.getAttribute("occurence"));
             if (occurence > 0) {
                 if (messagePattern.hasChildren())
                     checkFields(msg, msg->getDescriptor(), messagePattern.getChildren());
 
                 occurence--;
                 std::ostringstream occur_str;
                 occur_str << occurence;
                 messagePattern.setAttribute("occurence", occur_str.str().data());
                 checkedMsg++;
             }
             if (occurence == 0)
                 m_iterChk++;
             break;
         }
         else
             m_iterChk++;
     }
 }

int inet::MessageChecker::findFieldIndex	(	void *	object,
		cClassDescriptor *	descriptor,
		const std::string &	fieldName
	)		const

protected

Referenced by checkFields().

 {
     std::ostringstream availableFields;
     for (int i = 0; i < descriptor->getFieldCount(); i++) {
         availableFields << descriptor->getFieldName(i) << ", ";
         if (std::string(descriptor->getFieldName(i)) == fieldName)
             return i;
     }
 
     throw cRuntimeError("Unknown field \"%s\" in message %d\nAvailable fields in \"%s\" are : %s"
             , fieldName.data(), forwardedMsg, descriptor->getClassName(), availableFields.str().data());
     return 0;
 }

void inet::MessageChecker::finish ( )

overrideprotected

 {
     if (forwardedMsg > checkedMsg)
         throw cRuntimeError("%d message(s) has not been checked", forwardedMsg - checkedMsg);
 
     if (m_iterChk != m_checkingInfo.end())
         throw cRuntimeError("Several message(s) have to be checked");
 }

void inet::MessageChecker::forwardMessage ( cMessage * msg )

protected

Referenced by handleMessage().

 {
     cGate *gateOut = gate("out");
     cChannel *channel = gateOut->getChannel();
     simtime_t now = simTime();
     simtime_t endTransmissionTime = channel->getTransmissionFinishTime();
     simtime_t delayToWait = 0;
     if (endTransmissionTime > now)
         delayToWait = endTransmissionTime - now;
     sendDelayed(msg, delayToWait, "out");
 }

void inet::MessageChecker::handleMessage ( cMessage * msg )

overrideprotected

 {
     forwardedMsg++;
     checkMessage(msg);
     forwardMessage(msg);
 }

void inet::MessageChecker::initialize ( )

overrideprotected

 {
     cXMLElement *root = par("config");
     if (std::string(root->getTagName()) == "checker") {
         m_checkingInfo = root->getChildren();
         m_iterChk = m_checkingInfo.begin();
     }
     forwardedMsg = 0;
     checkedMsg = 0;
     WATCH(forwardedMsg);
     WATCH(checkedMsg);
 }