peak::core::BufferPart Class Reference

Represents a buffer part. More...

#include <peak/buffer/peak_buffer_part.hpp>

Public Member Functions
	BufferPart ()=delete
	~BufferPart ()
	BufferPart (const BufferPart &other)=delete
BufferPart &	operator= (const BufferPart &other)=delete
	BufferPart (BufferPart &&other)=delete
BufferPart &	operator= (BufferPart &&other)=delete
RawInformation	Info (int32_t infoCommand) const
	Delivers information based on the given GenTL info command.
uint64_t	SourceID () const
	Returns the source ID.
void *	BasePtr () const
	Returns the base pointer.
size_t	Size () const
	Returns the size in bytes.
BufferPartType	Type () const
	Returns the type.
uint64_t	Format () const
	Returns the format.
uint64_t	FormatNamespace () const
	Returns the format namespace.
size_t	Width () const
	Returns the width.
size_t	Height () const
	Returns the height.
size_t	XOffset () const
	Returns the x offset.
size_t	YOffset () const
	Returns the y offset.
size_t	XPadding () const
	Returns the x padding.
size_t	DeliveredImageHeight () const
	Returns the delivered image height.
std::shared_ptr< Buffer >	ParentBuffer () const
	Returns the parent buffer.

Detailed Description

Represents a buffer part.

This class allows to query information about a buffer part.

Constructor & Destructor Documentation

BufferPart() [1/3]

peak::core::BufferPart::BufferPart ( )

delete

~BufferPart()

peak::core::BufferPart::~BufferPart ( )

inline

BufferPart() [2/3]

peak::core::BufferPart::BufferPart ( const BufferPart & other )

delete

BufferPart() [3/3]

peak::core::BufferPart::BufferPart ( BufferPart && other )

delete

Member Function Documentation

BasePtr()

void * peak::core::BufferPart::BasePtr ( ) const

inline

Returns the base pointer.

Returns

Base pointer

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

DeliveredImageHeight()

size_t peak::core::BufferPart::DeliveredImageHeight ( ) const

inline

Returns the delivered image height.

Returns

Delivered image height

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Format()

uint64_t peak::core::BufferPart::Format ( ) const

inline

Returns the format.

Returns

Format

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

FormatNamespace()

uint64_t peak::core::BufferPart::FormatNamespace ( ) const

inline

Returns the format namespace.

Returns

Format namespace

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Height()

size_t peak::core::BufferPart::Height ( ) const

inline

Returns the height.

Returns

Height

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Info()

RawInformation peak::core::BufferPart::Info ( int32_t infoCommand ) const

inline

Delivers information based on the given GenTL info command.

Parameters

[in]

infoCommand

The GenTL info command.

This function can be used to query information going beyond the predefined info functions, based on the GenTL info commands of the corresponding module.

Example (error handling is omitted):

#include <peak/thirdparty/GenTL.h>
auto info = object->Info(GenTL::XX_INFO_XX);
 
// Cast depending on the delivered data type
if (info.dataType == GenTL::INFO_DATATYPE_UINT64)
{
    uint64_t uint64Var = *reinterpret_cast<const uint64_t*>(info.data.data());
    // Do something with the information
}
else if (infoDataTypeVar == GenTL::INFO_DATATYPE_INT64)
{
    ...
}
...

Returns

Raw information according to the passed info command

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

operator=() [1/2]

BufferPart & peak::core::BufferPart::operator= ( BufferPart && other )

delete

operator=() [2/2]

BufferPart & peak::core::BufferPart::operator= ( const BufferPart & other )

delete

ParentBuffer()

std::shared_ptr< Buffer > peak::core::BufferPart::ParentBuffer ( ) const

inline

Returns the parent buffer.

Returns

Parent buffer

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Size()

size_t peak::core::BufferPart::Size ( ) const

inline

Returns the size in bytes.

Returns

Size in bytes

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

SourceID()

uint64_t peak::core::BufferPart::SourceID ( ) const

inline

Returns the source ID.

Returns

Source ID

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Type()

BufferPartType peak::core::BufferPart::Type ( ) const

inline

Returns the type.

Returns

Type

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Width()

size_t peak::core::BufferPart::Width ( ) const

inline

Returns the width.

Returns

Width

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

XOffset()

size_t peak::core::BufferPart::XOffset ( ) const

inline

Returns the x offset.

Returns

X offset

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

XPadding()

size_t peak::core::BufferPart::XPadding ( ) const

inline

Returns the x padding.

Returns

X padding

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

YOffset()

size_t peak::core::BufferPart::YOffset ( ) const

inline

Returns the y offset.

Returns

Y offset

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

---

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

• peak/buffer/peak_buffer_part.hpp