eprosima::safedds::memory::IByteArrayView Interface Reference

IByteArrayView interface. More...

#include <IByteArrayView.hpp>

Public Member Functions
virtual uint32_t	size () const noexcept=0
	size of the view. More...
virtual uint8_t *	data () const noexcept=0
	data pointer of the view. More...
virtual uint8_t &	operator[] (uint32_t i) noexcept=0
	Operators to access IByteArrayView by index. More...
virtual IConstByteArrayView &	as_const () &noexcept=0
	Returns a const view of itself. Can only be used on lvalue objects. More...

Protected Member Functions
	~IByteArrayView () noexcept=default
	Protected destructor ownership defined on creation. More...
	IByteArrayView () noexcept=default
	Default creation. More...
	IByteArrayView (const IByteArrayView &) noexcept=default
	Copy allowed. More...
	IByteArrayView (IByteArrayView &&) noexcept=default
	Movement allowed. More...
IByteArrayView &	operator= (const IByteArrayView &) noexcept=default
	Copy operator allowed. More...
IByteArrayView &	operator= (IByteArrayView &&) noexcept=default
	Movement operator allowed. More...

Detailed Description

IByteArrayView interface.

Constructor & Destructor Documentation

~IByteArrayView()

eprosima::safedds::memory::IByteArrayView::~IByteArrayView ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

IByteArrayView() [1/3]

eprosima::safedds::memory::IByteArrayView::IByteArrayView ( )

protecteddefaultnoexcept

Default creation.

IByteArrayView() [2/3]

eprosima::safedds::memory::IByteArrayView::IByteArrayView ( const IByteArrayView &  )

protecteddefaultnoexcept

Copy allowed.

IByteArrayView() [3/3]

eprosima::safedds::memory::IByteArrayView::IByteArrayView ( IByteArrayView &&  )

protecteddefaultnoexcept

Movement allowed.

Member Function Documentation

as_const()

virtual IConstByteArrayView& eprosima::safedds::memory::IByteArrayView::as_const ( ) &

pure virtualnoexcept

Returns a const view of itself. Can only be used on lvalue objects.

Returns

reference of IConstByteArrayView.

Implemented in eprosima::safedds::memory::byte_array::ByteArrayView.

data()

virtual uint8_t* eprosima::safedds::memory::IByteArrayView::data ( ) const

pure virtualnoexcept

data pointer of the view.

Returns

pointer to byte array of the view.

Implemented in eprosima::safedds::memory::byte_array::ByteArrayView.

operator=() [1/2]

IByteArrayView& eprosima::safedds::memory::IByteArrayView::operator= ( const IByteArrayView &  )

protecteddefaultnoexcept

Copy operator allowed.

Returns

IByteArrayView&.

operator=() [2/2]

IByteArrayView& eprosima::safedds::memory::IByteArrayView::operator= ( IByteArrayView &&  )

protecteddefaultnoexcept

Movement operator allowed.

Returns

IByteArrayView&.

operator[]()

virtual uint8_t& eprosima::safedds::memory::IByteArrayView::operator[] ( uint32_t  i )

pure virtualnoexcept

Operators to access IByteArrayView by index.

Parameters

i

index.

Returns

reference of value on i position of the IByteArrayView.

Implemented in eprosima::safedds::memory::byte_array::ByteArrayView.

size()

virtual uint32_t eprosima::safedds::memory::IByteArrayView::size ( ) const

pure virtualnoexcept

size of the view.

Returns

uint32_t.

Implemented in eprosima::safedds::memory::byte_array::ByteArrayView.

---

The documentation for this interface was generated from the following file:

• build/docs/user_manual/v2.0.0/tmp/include/safedds/memory/IByteArrayView.hpp