DoipLib::PowerModeResponse Class Reference

Diagnostic node power mode information response. More...

#include <power_mode_response.h>

Inheritance diagram for DoipLib::PowerModeResponse:

Public Member Functions
	PowerModeResponse (uint8_t protocolVersion, PowerModeType powerMode) noexcept
	Constructor. More...
PowerModeType	GetPowerMode () const noexcept
	Get power mode. 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

Diagnostic node power mode information response.

Constructor & Destructor Documentation

PowerModeResponse()

DoipLib::PowerModeResponse::PowerModeResponse ( uint8_t  protocolVersion, PowerModeType  powerMode  )

explicitnoexcept

Constructor.

Parameters

protocolVersion	DoIP ISO protocol version
powerMode	DoIP node current power mode

Member Function Documentation

GetPayload()

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

overrideprotectedvirtual

Get message payload.

Parameters

[out]

payload

Payload byte array

Implements DoipLib::Message.

GetPowerMode()

PowerModeType DoipLib::PowerModeResponse::GetPowerMode ( ) const

noexcept

Get power mode.

Returns

DoIP node current power mode

TrySetPayload()

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