DoipLib::VinVehicleIdRequest Class Reference

Vehicle ID request DoIP message with vehicle ID number filtering. More...

#include <vin_vehicle_id_request.h>

Inheritance diagram for DoipLib::VinVehicleIdRequest:

Public Member Functions
	VinVehicleIdRequest (uint8_t protocolVersion, const std::string &vin)
	Constructor. More...
	VinVehicleIdRequest (uint8_t protocolVersion, std::string &&vin)
	Constructor. More...
std::string	GetVin () const
	Get VIN 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 vehicle ID number filtering.

Constructor & Destructor Documentation

VinVehicleIdRequest() [1/2]

DoipLib::VinVehicleIdRequest::VinVehicleIdRequest	(	uint8_t	protocolVersion,
		const std::string &	vin
	)

Constructor.

Parameters

protocolVersion	DoIP ISO protocol version
vin	Vehicle ID number filter

Exceptions

std::out_of_range

Throws if the given VIN is invalid

VinVehicleIdRequest() [2/2]

DoipLib::VinVehicleIdRequest::VinVehicleIdRequest	(	uint8_t	protocolVersion,
		std::string &&	vin
	)

Constructor.

Parameters

protocolVersion	DoIP ISO protocol version
vin	Vehicle ID number filter

Exceptions

std::out_of_range

Throws if the given VIN is invalid

Member Function Documentation

GetPayload()

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

overrideprotectedvirtual

Get message payload.

Parameters

[out]

payload

Payload byte array

Implements DoipLib::Message.

GetVin()

std::string DoipLib::VinVehicleIdRequest::GetVin

(

)

const

Get VIN filter.

Returns

Vehicle ID number

TrySetPayload()

virtual bool DoipLib::VinVehicleIdRequest::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.