#include <Ocp1Message.h>

Inheritance diagram for NanoOcp1::Ocp1KeepAlive:

Collaboration diagram for NanoOcp1::Ocp1KeepAlive:

Public Member Functions
	Ocp1KeepAlive (std::uint16_t heartBeatSeconds)

	Ocp1KeepAlive (std::uint32_t heartBeatMilliseconds)

	~Ocp1KeepAlive () override=default

std::uint16_t	GetHeartBeatSeconds () const

std::uint32_t	GetHeartBeatMilliseconds () const

ByteVector	GetSerializedData () override

Public Member Functions inherited from NanoOcp1::Ocp1Message
	Ocp1Message (std::uint8_t msgType, const ByteVector &parameterData)

virtual	~Ocp1Message ()=default

std::uint8_t	GetMessageType () const

ByteVector	GetParameterData () const

Additional Inherited Members
Public Types inherited from NanoOcp1::Ocp1Message
enum	MessageType { Command = 0 , CommandResponseRequired = 1 , Notification = 2 , Response = 3 , KeepAlive = 4 }
	OCP.1 message type codes as defined in AES70. More...

Static Public Member Functions inherited from NanoOcp1::Ocp1Message
static std::unique_ptr< Ocp1Message >	UnmarshalOcp1Message (const ByteVector &receivedData)

Protected Attributes inherited from NanoOcp1::Ocp1Message
Ocp1Header	m_header

ByteVector	m_parameterData

Static Protected Attributes inherited from NanoOcp1::Ocp1Message
static std::uint32_t	m_nextHandle = 2

Detailed Description

Representation of an Oca KeepAlive message.

Definition at line 643 of file Ocp1Message.h.

Constructor & Destructor Documentation

◆ Ocp1KeepAlive() [1/2]

NanoOcp1::Ocp1KeepAlive::Ocp1KeepAlive ( std::uint16_t heartBeatSeconds )

Class constructor for initialization with a 16bit seconds value.

Definition at line 462 of file Ocp1Message.cpp.

◆ Ocp1KeepAlive() [2/2]

NanoOcp1::Ocp1KeepAlive::Ocp1KeepAlive ( std::uint32_t heartBeatMilliseconds )

Class constructor for initialization with a 32bit milliseconds value.

Definition at line 468 of file Ocp1Message.cpp.

◆ ~Ocp1KeepAlive()

NanoOcp1::Ocp1KeepAlive::~Ocp1KeepAlive ( )

overridedefault

Class destructor.

Member Function Documentation

◆ GetHeartBeatMilliseconds()

std::uint32_t NanoOcp1::Ocp1KeepAlive::GetHeartBeatMilliseconds ( ) const

Get this KeepAlive message's heartbeat time.

Returns: This KeepAlive message's heartbeat time in milliseconds or 0 if 16bit seconds are used.

Definition at line 484 of file Ocp1Message.cpp.

References NanoOcp1::DataToUint32(), and NanoOcp1::Ocp1Message::m_parameterData.

◆ GetHeartBeatSeconds()

std::uint16_t NanoOcp1::Ocp1KeepAlive::GetHeartBeatSeconds ( ) const

Get this KeepAlive message's heartbeat time.

Returns: This KeepAlive message's heartbeat time in seconds or 0 if 32bit milliseconds are used.

Definition at line 474 of file Ocp1Message.cpp.

References NanoOcp1::DataToUint16(), and NanoOcp1::Ocp1Message::m_parameterData.

◆ GetSerializedData()

ByteVector NanoOcp1::Ocp1KeepAlive::GetSerializedData ( )

overridevirtual

Returns a vector of bytes representing the binary contents of the complete message. Must be reimplemented for each message type.

Returns: A vector containing the OCA message including header.

Implements NanoOcp1::Ocp1Message.

Definition at line 494 of file Ocp1Message.cpp.

References NanoOcp1::Ocp1Header::GetSerializedData(), NanoOcp1::Ocp1Message::m_header, and NanoOcp1::Ocp1Message::m_parameterData.

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

Source/Ocp1Message.h
Source/Ocp1Message.cpp

Public Member Functions

Additional Inherited Members