DoipLib::EidVehicleIdRequest Class Reference

Vehicle ID request DoIP message with entity ID filtering. More...

#include <eid_vehicle_id_request.h>

Inheritance diagram for DoipLib::EidVehicleIdRequest:

Public Member Functions
	EidVehicleIdRequest (uint8_t protocolVersion, std::array< uint8_t, cEidSize > eid)
	Constructor. More...
std::array< uint8_t, cEidSize >	GetEid () const
	Get EID filter. More...
Public Member Functions inherited from DoipLib::Message
void	Serialize (std::vector< uint8_t > &serializedMessage) const
	Serialize DoIP message. More...
bool	TryDeserialize (const std::vector< uint8_t > &serializedMessage, GenericNackType &nackCode)
	Try to deserialize DoIP message. More...

Protected Member Functions
void	GetPayload (std::vector< uint8_t > &payload) const override
	Get message payload. More...
virtual bool	TrySetPayload (const std::vector< uint8_t > &payload, uint32_t payloadLength) override
	Try to set message payload. More...
Protected Member Functions inherited from DoipLib::Message
	Message (PayloadType payloadType) noexcept
	Constructor. More...
	Message (uint8_t protocolVersion, PayloadType payloadType) noexcept
	Constructor. More...

Additional Inherited Members
Static Public Member Functions inherited from DoipLib::Message
static bool	TryExtractPayloadType (const std::vector< uint8_t > &serializedMessage, PayloadType &payloadType)
	Try to extract the payload type from the given serialized message. More...
Static Protected Attributes inherited from DoipLib::Message
static const std::size_t	cHeaderSize {8}
	DoIP message header size.

Detailed Description

Vehicle ID request DoIP message with entity ID filtering.

Constructor & Destructor Documentation

EidVehicleIdRequest()

DoipLib::EidVehicleIdRequest::EidVehicleIdRequest	(	uint8_t	protocolVersion,
		std::array< uint8_t, cEidSize >	eid
	)

Constructor.

Parameters

protocolVersion	DoIP ISO protocol version
eid	Entity ID filter

Member Function Documentation

GetEid()

std::array< uint8_t, cEidSize > DoipLib::EidVehicleIdRequest::GetEid

(

)

const

Get EID filter.

Returns

Entity ID

GetPayload()

void DoipLib::EidVehicleIdRequest::GetPayload ( std::vector< uint8_t > &  payload ) const

overrideprotectedvirtual

Get message payload.

Parameters

[out]

payload

Payload byte array

Implements DoipLib::Message.

TrySetPayload()

virtual bool DoipLib::EidVehicleIdRequest::TrySetPayload ( const std::vector< uint8_t > &  payload, uint32_t  payloadLength  )

overrideprotectedvirtual

Try to set message payload.

Parameters

[in]	payload	Payload byte array
[in]	payloadLength	Payload length from the message header

Returns

True if the payload is set successfully, otherwise false

Implements DoipLib::Message.