TraCIServerAPI_Route Class Reference

#include <TraCIServerAPI_Route.h>

---

Detailed Description

APIs for getting/setting route values via TraCI.

Definition at line 43 of file TraCIServerAPI_Route.h.

Static Public Member Functions
static bool	processGet (tcpip::Storage &inputStorage, tcpip::Storage &outputStorage, bool withStatus=true) throw (traci::TraCIException)
	Processes a get value command (Command 0xa6: Get Route Variable).
static bool	processSet (tcpip::Storage &inputStorage, tcpip::Storage &outputStorage) throw (traci::TraCIException)
	Processes a set value command (Command 0xc6: Change Route State).
Private Member Functions
TraCIServerAPI_Route &	operator= (const TraCIServerAPI_Route &s)
	invalidated assignment operator
	TraCIServerAPI_Route (const TraCIServerAPI_Route &s)
	invalidated copy constructor

---

Constructor & Destructor Documentation

TraCIServerAPI_Route::TraCIServerAPI_Route

(

const TraCIServerAPI_Route &

s

)

[private]

invalidated copy constructor

---

Member Function Documentation

TraCIServerAPI_Route& TraCIServerAPI_Route::operator=

(

const TraCIServerAPI_Route &

s

)

[private]

invalidated assignment operator

bool TraCIServerAPI_Route::processGet	(	tcpip::Storage &	inputStorage,
		tcpip::Storage &	outputStorage,
		bool	withStatus = true
	)			throw (traci::TraCIException) [static]

Processes a get value command (Command 0xa6: Get Route Variable).

Parameters:

[in]	inputStorage	The storage to read the command from
[out]	outputStorage	The storage to write the result to
[in]	withStatus	Whether the status message shall be written (not in subscription)

Definition at line 54 of file TraCIServerAPI_Route.cpp.

References MSRoute::begin(), CMD_GET_ROUTE_VARIABLE, MSRoute::dictionary(), MSRoute::end(), ID_LIST, MSRoute::insertIDs(), RESPONSE_GET_ROUTE_VARIABLE, RTYPE_ERR, RTYPE_OK, tcpip::Storage::size(), MSRoute::size(), TYPE_STRINGLIST, VAR_EDGES, tcpip::Storage::writeInt(), TraCIServerAPIHelper::writeStatusCmd(), tcpip::Storage::writeString(), tcpip::Storage::writeStringList(), and tcpip::Storage::writeUnsignedByte().

Referenced by traci::TraCIServer::dispatchCommand(), and traci::TraCIServer::processSingleSubscription().

                                                                        {
    std::string warning = ""; // additional description for response
    // variable & id
    int variable = inputStorage.readUnsignedByte();
    std::string id = inputStorage.readString();
    // check variable
    if (variable!=ID_LIST&&variable!=VAR_EDGES) {
        TraCIServerAPIHelper::writeStatusCmd(CMD_GET_ROUTE_VARIABLE, RTYPE_ERR, "Get Route Variable: unsupported variable specified", outputStorage);
        return false;
    }
    // begin response building
    Storage tempMsg;
    //  response-code, variableID, objectID
    tempMsg.writeUnsignedByte(RESPONSE_GET_ROUTE_VARIABLE);
    tempMsg.writeUnsignedByte(variable);
    tempMsg.writeString(id);
    // process request
    if (variable==ID_LIST) {
        std::vector<std::string> ids;
        MSRoute::insertIDs(ids);
        tempMsg.writeUnsignedByte(TYPE_STRINGLIST);
        tempMsg.writeStringList(ids);
    } else {
        const MSRoute *r = MSRoute::dictionary(id);
        if (r==0) {
            TraCIServerAPIHelper::writeStatusCmd(CMD_GET_ROUTE_VARIABLE, RTYPE_ERR, "Route '" + id + "' is not known", outputStorage);
            return false;
        }
        switch (variable) {
        case VAR_EDGES:
            tempMsg.writeUnsignedByte(TYPE_STRINGLIST);
            tempMsg.writeInt(r->size());
            for (MSRouteIterator i=r->begin(); i!=r->end(); ++i) {
                tempMsg.writeString((*i)->getID());
            }
            break;
        default:
            break;
        }
    }
    if (withStatus) {
        TraCIServerAPIHelper::writeStatusCmd(CMD_GET_ROUTE_VARIABLE, RTYPE_OK, warning, outputStorage);
    }
    // send response
    outputStorage.writeUnsignedByte(0); // command length -> extended
    outputStorage.writeInt(1 + 4 + tempMsg.size());
    outputStorage.writeStorage(tempMsg);
    return true;
}

bool TraCIServerAPI_Route::processSet	(	tcpip::Storage &	inputStorage,
		tcpip::Storage &	outputStorage
	)			throw (traci::TraCIException) [static]

Processes a set value command (Command 0xc6: Change Route State).

Parameters:

[in]	inputStorage	The storage to read the command from
[out]	outputStorage	The storage to write the result to

Definition at line 108 of file TraCIServerAPI_Route.cpp.

                                                                                    {
    return true;
}

---

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

• TraCIServerAPI_Route.h
• TraCIServerAPI_Route.cpp