Describes a user-space buffer on the host computer. I have an address and a length, plus some optional attributes (allocated by SDK?, page-aligned? etc.). More...

#include <ntv2publicinterface.h>

Public Member Functions
ULWordSet &	FindAll (ULWordSet &outOffsets, const NTV2Buffer &inValue) const

bool	RPCEncode (NTV2_RPC_BLOB_TYPE &outBlob, bool fillBuffer=true)

bool	RPCDecode (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex, bool fillBuffer=true)

bool	RPCDecodeNoAllocate (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)

Construction & Destruction
	NTV2Buffer (const void *pInUserPointer, const size_t inByteCount)
	Constructs me from a client-supplied address and size. More...

	NTV2Buffer (const size_t inByteCount=0)
	Constructs me from a client-specified byte count. In this case, I assume full responsibility for automatically freeing the memory I allocate. More...

	NTV2Buffer (const NTV2Buffer &inObj)
	Constructs me from another NTV2Buffer instance. More...

	~NTV2Buffer ()
	My destructor. If I'm responsible for the memory, I free it here. More...

Inquiry
void *	GetHostPointer (void) const

ULWord64	GetRawHostPointer (void) const

size_t	GetByteCount (void) const

bool	IsAllocatedBySDK (void) const

bool	IsProvidedByClient (void) const

bool	IsPageAligned (void) const

bool	IsNULL (void) const

	operator bool () const

	operator size_t () const

void *	GetHostAddress (const ULWord inByteOffset, const bool inFromEnd=false) const

template<typename T >
bool	Find (const T &inValue, int &inOutIndex) const
	Searches me for the given scalar value of type T starting at a given index position. More...

ULWordSet &	Find (ULWordSet &outOffsets, const NTV2Buffer &inValue, const size_t inLimit=0) const
	Searches me for any number of occurrences of a given byte sequence. More...

bool	IsContentEqual (const NTV2Buffer &inBuffer, const ULWord inByteOffset=0, const ULWord inByteCount=0xFFFFFFFF) const

bool	NextDifference (const NTV2Buffer &inBuffer, ULWord &byteOffset) const
	Iterates over each byte that differs between myself and the given buffer. More...

bool	GetRingChangedByteRange (const NTV2Buffer &inBuffer, ULWord &outByteOffsetFirst, ULWord &outByteOffsetLast) const
	Assuming my contents and the contents of the given buffer comprise ring buffers that periodically get overwritten in contiguous variable-length chunks, answers with the contiguous byte range that differs between the two. More...

Changing
bool	Allocate (const size_t inByteCount, const bool inPageAligned=false)
	Allocates (or re-allocates) my user-space storage using the given byte count. I assume full responsibility for any memory that I allocate. More...

bool	Deallocate (void)
	Deallocates my user-space storage (if I own it – i.e. from a prior call to Allocate). More...

template<typename T >
bool	Fill (const T &inValue)
	Fills me with the given scalar value. More...

template<typename T >
bool	Fill (const T &inValue, const NTV2SegmentedXferInfo &inXferInfo)
	Fills a portion of me with the given scalar value. More...

bool	Truncate (const size_t inByteCount)
	Truncates me to the given length. No reallocation takes place. More...

NTV2Buffer &	operator= (const NTV2Buffer &inRHS)
	Assigns me from another NTV2Buffer instance. More...

bool	Set (const void *pInUserPointer, const size_t inByteCount)
	Sets (or resets) me from a client-supplied address and size. More...

bool	SetAndFill (const void *pInUserPointer, const size_t inByteCount, const UByte inValue)
	Sets (or resets) me from a client-supplied address and size. More...

bool	SetFrom (const NTV2Buffer &inBuffer)
	Replaces my contents from the given memory buffer without resizing me. More...

bool	SetFromHexString (const std::string &inStr)
	Replaces my contents from the given hex-encoded string, resizing me if necessary. More...

bool	CopyFrom (const void *pInSrcBuffer, const ULWord inByteCount)
	Replaces my contents from the given memory buffer, resizing me to the new byte count. More...

bool	CopyFrom (const NTV2Buffer &inSrcBuffer, const ULWord inSrcByteOffset, const ULWord inDstByteOffset, const ULWord inByteCount)
	Copies bytes from the given memory buffer into me. More...

bool	CopyFrom (const NTV2Buffer &inSrcBuffer, const NTV2SegmentedXferInfo &inXferInfo)
	Copies data segments from a given source buffer into me (the destination). More...

bool	SwapWith (NTV2Buffer &inBuffer)
	Swaps my underlying buffer with another's. More...

bool	ByteSwap64 (void)
	Byte-swaps my contents 64-bits at a time. More...

bool	ByteSwap32 (void)
	Byte-swaps my contents 32-bits at a time. More...

bool	ByteSwap16 (void)
	Byte-swaps my contents 16-bits at a time. More...

Debugging/Printing
std::ostream &	Print (std::ostream &inOutStream) const
	Prints a human-readable representation of me into the given output stream. More...

std::string	AsString (UWord inDumpMaxBytes=0) const

std::string	AsCode (const size_t inBytesPerWord=4, const std::string &inVarName="", const bool inUseSTL=false, const bool inByteSwap=false) const

bool	toHexString (std::string &outStr, const size_t inLineBreakInterval=0) const
	Converts my contents into a hex-encoded string. More...

std::ostream &	Dump (std::ostream &inOutputStream=std::cout, const size_t inStartByteOffset=0, const size_t inByteCount=0, const size_t inRadix=16, const size_t inBytesPerGroup=4, const size_t inGroupsPerLine=8, const size_t inAddressRadix=0, const bool inShowAscii=false, const size_t inAddrOffset=0) const
	Dumps me in hex/octal/decimal, with/without Ascii, to the given output stream. More...

std::string &	Dump (std::string &inOutputString, const size_t inStartByteOffset=0, const size_t inByteCount=0, const size_t inRadix=16, const size_t inBytesPerGroup=4, const size_t inGroupsPerLine=8, const size_t inAddressRadix=0, const bool inShowAscii=false, const size_t inAddrOffset=0) const
	Dumps me in hex/octal/decimal, with/without Ascii, into the given string. More...

Data Access
template<typename T >
	operator const T * () const

template<typename T >
	operator T* () const

NTV2Buffer &	Segment (NTV2Buffer &outPtr, const ULWord inByteOffset, const ULWord inByteCount) const
	Resets an NTV2Buffer instance to reference a contiguous segment (portion) of my memory buffer. More...

uint8_t	U8 (const int inIndex) const

uint8_t &	U8 (const int inIndex)

int8_t	I8 (const int inIndex) const

int8_t &	I8 (const int inIndex)

uint16_t	U16 (const int inIndex) const

uint16_t &	U16 (const int inIndex)

int16_t	I16 (const int inIndex) const

int16_t &	I16 (const int inIndex)

uint32_t	U32 (const int inIndex) const

uint32_t &	U32 (const int inIndex)

int32_t	I32 (const int inIndex) const

int32_t &	I32 (const int inIndex)

uint64_t	U64 (const int inIndex) const

uint64_t &	U64 (const int inIndex)

int64_t	I64 (const int inIndex) const

int64_t &	I64 (const int inIndex)

float	FL (const int inIndex) const

float &	FL (const int inIndex)

double	DBL (const int inIndex) const

double &	DBL (const int inIndex)

Vector Conversion
bool	GetU64s (ULWord64Sequence &outU64s, const size_t inU64Offset=0, const size_t inMaxSize=16, const bool inByteSwap=false) const
	Answers with my contents as a vector of unsigned 16-bit values. More...

ULWord64Sequence	GetU64s (const size_t inU64Offset=0, const size_t inMaxSize=16, const bool inByteSwap=false) const

bool	GetU32s (ULWordSequence &outU32s, const size_t inU32Offset=0, const size_t inMaxSize=32, const bool inByteSwap=false) const
	Answers with my contents as a vector of unsigned 32-bit values. More...

ULWordSequence	GetU32s (const size_t inU32Offset=0, const size_t inMaxSize=32, const bool inByteSwap=false) const

bool	GetU16s (UWordSequence &outU16s, const size_t inU16Offset=0, const size_t inMaxSize=64, const bool inByteSwap=false) const
	Answers with my contents as a vector of unsigned 16-bit values. More...

UWordSequence	GetU16s (const size_t inU16Offset=0, const size_t inMaxSize=64, const bool inByteSwap=false) const

bool	GetU8s (UByteSequence &outU8s, const size_t inU8Offset=0, const size_t inMaxSize=128) const
	Answers with my contents as a vector of unsigned 8-bit values. More...

UByteSequence	GetU8s (const size_t inU8Offset=0, const size_t inMaxSize=128) const

bool	AppendU8s (UByteSequence &outU8s) const
	Appends my contents to an existing UByteSequence. More...

bool	GetString (std::string &outString, const size_t inU8Offset=0, const size_t inMaxSize=128) const
	Answers with my contents as a character string. More...

std::string	GetString (const size_t inU8Offset=0, const size_t inMaxSize=128) const

bool	PutU64s (const ULWord64Sequence &inU64s, const size_t inU64Offset=0, const bool inByteSwap=false)
	Copies a vector of unsigned 64-bit values into me. More...

bool	PutU32s (const ULWordSequence &inU32s, const size_t inU32Offset=0, const bool inByteSwap=false)
	Copies a vector of unsigned 32-bit values into me. More...

bool	PutU16s (const UWordSequence &inU16s, const size_t inU16Offset=0, const bool inByteSwap=false)
	Copies a vector of unsigned 16-bit values into me. More...

bool	PutU8s (const UByteSequence &inU8s, const size_t inU8Offset=0)
	Copies a vector of unsigned 8-bit values into me. More...

Static Public Member Functions
Default Page Size
static size_t	DefaultPageSize (void)

static bool	SetDefaultPageSize (const size_t inNewSize)
	Changes the default page size for use in future page-aligned allocations. More...

static size_t	HostPageSize (void)

Detailed Description

Describes a user-space buffer on the host computer. I have an address and a length, plus some optional attributes (allocated by SDK?, page-aligned? etc.).

For a static or global buffer, simply construct from the variable:
static ULWord pFoo[1000];
{
NTV2Buffer foo (pFoo, sizeof(pFoo));
. . .
} // When foo goes out of scope, it won't try to free pFoo
For stack-based buffers, simply construct from the variable:
{
ULWord pFoo[100];
NTV2Buffer foo (pFoo, sizeof(pFoo));
. . .
} // Both foo and pFoo are automatically freed when they go out of scope
To allocate and free a buffer of 100 Bar's:
NTV2Buffer foo (new Bar[100], sizeof(Bar));
. . .
delete [] (Bar*) foo.GetHostPointer(); // You must free the memory yourself
Let the SDK allocate and free a buffer of 100 Bar's:
{
NTV2Buffer foo (100 * sizeof(Bar));
::memset (foo.GetHostPointer(), 0, foo.GetByteCount());
. . .
} // Automatically freed when foo goes out of scope

Note
This struct uses a constructor to properly initialize itself. Do not use memset or bzero to initialize or "clear" it.

Definition at line 6250 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2Buffer() [1/3]

NTV2Buffer::NTV2Buffer	(	const void *	pInUserPointer,
		const size_t	inByteCount
	)

explicit

Constructs me from a client-supplied address and size.

Parameters

[in]	pInUserPointer	Specifies the user-space virtual memory address. The client is entirely responsible for it. Ignored if inByteCount is zero.
[in]	inByteCount	Specifies the byte count. Ignored if pInUserPointer is NULL.

Definition at line 1701 of file ntv2publicinterface.cpp.

◆ NTV2Buffer() [2/3]

NTV2Buffer::NTV2Buffer ( const size_t inByteCount = 0 )

Constructs me from a client-specified byte count. In this case, I assume full responsibility for automatically freeing the memory I allocate.

Parameters

[in] inByteCount Optionally specifies the size of the allocated buffer, in bytes. Defaults to zero. If non-zero, causes Allocate to be called, and if successful, automatically zeroes the buffer. If zero (the default), I don't allocate anything, and my host pointer will be NULL.

Definition at line 1717 of file ntv2publicinterface.cpp.

◆ NTV2Buffer() [3/3]

NTV2Buffer::NTV2Buffer ( const NTV2Buffer & inObj )

explicit

Constructs me from another NTV2Buffer instance.

Parameters

[in] inObj NTV2Buffer instance to "deep" copy into me.

Definition at line 1735 of file ntv2publicinterface.cpp.

◆ ~NTV2Buffer()

NTV2Buffer::~NTV2Buffer ( )

My destructor. If I'm responsible for the memory, I free it here.

Definition at line 1780 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ Allocate()

bool NTV2Buffer::Allocate	(	const size_t	inByteCount,
		const bool	inPageAligned = `false`
	)

Allocates (or re-allocates) my user-space storage using the given byte count. I assume full responsibility for any memory that I allocate.

Parameters

[in]	inByteCount	Specifies the number of bytes to allocate. Specifying zero is the same as calling Set(NULL, 0).
[in]	inPageAligned	Optionally specifies page alignment. If true, allocates a page-aligned block. If false (default), uses operator new.

Returns: True if successful; otherwise false.

Note: Any memory that I was referencing prior to this call that I was responsible for will automatically be freed.

Definition at line 1840 of file ntv2publicinterface.cpp.

◆ AppendU8s()

bool NTV2Buffer::AppendU8s ( UByteSequence & outU8s ) const

Appends my contents to an existing UByteSequence.

Parameters

[out] outU8s The vector to be appended to.

Returns: True if successful; otherwise false.

Definition at line 774 of file ntv2publicinterface.cpp.

◆ AsCode()

string NTV2Buffer::AsCode	(	const size_t	inBytesPerWord = `4`,
		const std::string &	inVarName = `""`,
		const bool	inUseSTL = `false`,
		const bool	inByteSwap = `false`
	)		const

Parameters

inBytesPerWord	Word size, in bytes. Must be 1, 2, 4 or 8. Defaults to 4.
inVarName	Optionally specifies the variable name to use.
inUseSTL	Optionally specifies if std::vector should be used instead of a C-style array.
inByteSwap	Optionally specifies if 2/4/8-byte words should be byte-swapped.

Returns: A string containing C/C++ code that will reproduce my contents.

Definition at line 434 of file ntv2publicinterface.cpp.

◆ AsString()

string NTV2Buffer::AsString ( UWord inDumpMaxBytes = 0 ) const

Parameters

inDumpMaxBytes If non-zero, includes a hex dump of my contents up to the number of specified bytes (64 maximum).

Returns: A string containing a human-readable representation of me.

Definition at line 416 of file ntv2publicinterface.cpp.

◆ ByteSwap16()

bool NTV2Buffer::ByteSwap16 ( void )

Byte-swaps my contents 16-bits at a time.

Returns: True if successful; otherwise false.

Note: If my size (in bytes) is not evenly divisible by 2, the very last byte won't get swapped.

Definition at line 1810 of file ntv2publicinterface.cpp.

◆ ByteSwap32()

bool NTV2Buffer::ByteSwap32 ( void )

Byte-swaps my contents 32-bits at a time.

Returns: True if successful; otherwise false.

Note: If my size (in bytes) is not evenly divisible by 4, the very last byte(s) won't get swapped.

Definition at line 1798 of file ntv2publicinterface.cpp.

◆ ByteSwap64()

bool NTV2Buffer::ByteSwap64 ( void )

Byte-swaps my contents 64-bits at a time.

Returns: True if successful; otherwise false.

Note: If my size (in bytes) is not evenly divisible by 8, the very last byte(s) won't get swapped.

Definition at line 1786 of file ntv2publicinterface.cpp.

◆ CopyFrom() [1/3]

bool NTV2Buffer::CopyFrom	(	const void *	pInSrcBuffer,
		const ULWord	inByteCount
	)

Replaces my contents from the given memory buffer, resizing me to the new byte count.

Parameters

[in]	pInSrcBuffer	Specifies the memory buffer whose contents are to be copied into my own.
[in]	inByteCount	Specifies the number of bytes to be copied.

Returns: True if successful; otherwise false.

Definition at line 1930 of file ntv2publicinterface.cpp.

◆ CopyFrom() [2/3]

bool NTV2Buffer::CopyFrom	(	const NTV2Buffer &	inSrcBuffer,
		const ULWord	inSrcByteOffset,
		const ULWord	inDstByteOffset,
		const ULWord	inByteCount
	)

Copies bytes from the given memory buffer into me.

Parameters

[in]	inSrcBuffer	Specifies the source memory buffer to be copied into me.
[in]	inSrcByteOffset	Specifies the offset, in bytes, at which reading will commence in the source buffer.
[in]	inDstByteOffset	Specifies the offset, in bytes, at which writing will commence in me.
[in]	inByteCount	Specifies the total number of bytes to copy.

Returns: True if successful; otherwise false.

Note: The offsets and byte counts are checked against the existing sizes of the two buffers. The function will return false for any overflow.

Definition at line 1943 of file ntv2publicinterface.cpp.

◆ CopyFrom() [3/3]

bool NTV2Buffer::CopyFrom	(	const NTV2Buffer &	inSrcBuffer,
		const NTV2SegmentedXferInfo &	inXferInfo
	)

Copies data segments from a given source buffer into me (the destination).

Parameters

[in]	inSrcBuffer	Specifies the source memory buffer to be copied into me.
[in]	inXferInfo	Specifies how segments are transferred.

Returns: True if successful; otherwise false.

Note: Offsets and lengths are checked. The function will return false for any overflow or underflow.

Definition at line 1964 of file ntv2publicinterface.cpp.

◆ DBL() [1/2]

double NTV2Buffer::DBL ( const int inIndex ) const

inline

Definition at line 6808 of file ntv2publicinterface.h.

◆ DBL() [2/2]

double& NTV2Buffer::DBL ( const int inIndex )

inline

Definition at line 6809 of file ntv2publicinterface.h.

◆ Deallocate()

bool NTV2Buffer::Deallocate ( void )

Deallocates my user-space storage (if I own it – i.e. from a prior call to Allocate).

Returns: True if successful; otherwise false.

Definition at line 1876 of file ntv2publicinterface.cpp.

◆ DefaultPageSize()

size_t NTV2Buffer::DefaultPageSize ( void )

static

Returns: Default page size, in bytes.

Definition at line 2227 of file ntv2publicinterface.cpp.

◆ Dump() [1/2]

std::ostream& NTV2Buffer::Dump	(	std::ostream &	inOutputStream = `std::cout`,
		const size_t	inStartByteOffset = `0`,
		const size_t	inByteCount = `0`,
		const size_t	inRadix = `16`,
		const size_t	inBytesPerGroup = `4`,
		const size_t	inGroupsPerLine = `8`,
		const size_t	inAddressRadix = `0`,
		const bool	inShowAscii = `false`,
		const size_t	inAddrOffset = `0`
	)		const

Dumps me in hex/octal/decimal, with/without Ascii, to the given output stream.

Parameters

inOutputStream	Output stream that will receive the dump. Defaults to std::cout.
inStartByteOffset	The starting offset, in bytes, where the dump will start.
inByteCount	The number of bytes to be dumped. If zero, all bytes will be dumped.
inRadix	Specifies the radix of the dumped memory values. 16=hex, 10=decimal, 8=octal, 2=binary – all others disallowed.
inBytesPerGroup	Number of bytes to dump per contiguous group of numbers. Defaults to 4.
inGroupsPerLine	Number of contiguous groups of numbers to dump per output line. If zero, no grouping is done, and address & ASCII display is suppressed. Defaults to 8.
inAddressRadix	Specifies the radix of the address column. 0=omit, 2=binary, 8=octal, 10=decimal, 16=hex – all others disallowed. Defaults to 0.
inShowAscii	If True, show ASCII characters; otherwise no ASCII characters. Overridden to false if inGroupsPerLine is zero. Defaults to false.
inAddrOffset	Specifies a value to be added to the addresses that appear in the dump. Ignored if inGroupsPerLine is zero.

Returns: A non-constant reference to the output stream that received the dump.

◆ Dump() [2/2]

std::string& NTV2Buffer::Dump	(	std::string &	inOutputString,
		const size_t	inStartByteOffset = `0`,
		const size_t	inByteCount = `0`,
		const size_t	inRadix = `16`,
		const size_t	inBytesPerGroup = `4`,
		const size_t	inGroupsPerLine = `8`,
		const size_t	inAddressRadix = `0`,
		const bool	inShowAscii = `false`,
		const size_t	inAddrOffset = `0`
	)		const

Dumps me in hex/octal/decimal, with/without Ascii, into the given string.

Parameters

inOutputString	String that will receive the dump. Appends the dump to the end of whatever is already in the string.
inStartByteOffset	The starting offset, in bytes, where the dump will start.
inByteCount	The number of bytes to be dumped. If zero, all bytes will be dumped.
inRadix	Specifies the radix of the dumped memory values. 16=hex, 10=decimal, 8=octal, 2=binary – all others disallowed.
inBytesPerGroup	Number of bytes to dump per contiguous group of numbers. Defaults to 4.
inGroupsPerLine	Number of contiguous groups of numbers to dump per output line. If zero, no grouping is done, and address & ASCII display is suppressed. Defaults to 8.
inAddressRadix	Specifies the radix of the address column. 0=omit, 2=binary, 8=octal, 10=decimal, 16=hex – all others disallowed. Defaults to 0.
inShowAscii	If True, show ASCII characters; otherwise no ASCII characters. Overridden to false if inGroupsPerLine is zero. Defaults to false.
inAddrOffset	Specifies a value to be added to the addresses that appear in the dump. Ignored if inGroupsPerLine is zero.

Returns: A reference to the output string that received the dump.

◆ Fill() [1/2]

template<typename T >

bool NTV2Buffer::Fill ( const T & inValue )

inline

Fills me with the given scalar value.

Parameters

[in] inValue The scalar value to fill me with.

Returns: True if I'm currently allocated; otherwise false.

Definition at line 6480 of file ntv2publicinterface.h.

◆ Fill() [2/2]

template<typename T >

bool NTV2Buffer::Fill	(	const T &	inValue,
		const NTV2SegmentedXferInfo &	inXferInfo
	)

inline

Fills a portion of me with the given scalar value.

Parameters

[in]	inValue	The scalar value.
[in]	inXferInfo	Describes the (destination) portion of me to be filled.

Returns: True if successful; otherwise false.

Note: Offsets and lengths are checked. The function will return false for any overflow or underflow.

Definition at line 6502 of file ntv2publicinterface.h.

◆ Find() [1/2]

template<typename T >

bool NTV2Buffer::Find	(	const T &	inValue,
		int &	inOutIndex
	)		const

inline

Searches me for the given scalar value of type T starting at a given index position.

Parameters

[in]	inValue	Specifies the scalar value to be searched for.
	inOutIndex	On entry, specifies where searching begins. On exit, receives the index of the matching value. Negative indexes search backward from the end of the buffer, where -1 is the last T in the buffer (with the highest physical memory address).

Returns: True if successfully found; otherwise false.

Definition at line 6376 of file ntv2publicinterface.h.

◆ Find() [2/2]

ULWordSet & NTV2Buffer::Find	(	ULWordSet &	outOffsets,
		const NTV2Buffer &	inValue,
		const size_t	inLimit = `0`
	)		const

Searches me for any number of occurrences of a given byte sequence.

Parameters

[out]	outOffsets	Receives the byte offsets of every occurrence found in me.
[in]	inValue	Specifies the NTV2Buffer that contains the byte sequence to search for.
[in]	inLimit	Specifies the maximum number of occurrences to report. Zero, the default, means "no limit".

Returns: A non-const reference to the "outOffsets" parameter. If empty, no occurrences were found.

Note: If a large number of matches are anticipated, the caller should call ULWordSet::reserve prior to calling this function.

Definition at line 2042 of file ntv2publicinterface.cpp.

◆ FindAll()

ULWordSet& NTV2Buffer::FindAll	(	ULWordSet &	outOffsets,
		const NTV2Buffer &	inValue
	)		const

inline

Definition at line 7002 of file ntv2publicinterface.h.

◆ FL() [1/2]

float NTV2Buffer::FL ( const int inIndex ) const

inline

Definition at line 6806 of file ntv2publicinterface.h.

◆ FL() [2/2]

float& NTV2Buffer::FL ( const int inIndex )

inline

Definition at line 6807 of file ntv2publicinterface.h.

◆ GetByteCount()

size_t NTV2Buffer::GetByteCount ( void ) const

inline

Returns: My size, in bytes.

Definition at line 6324 of file ntv2publicinterface.h.

◆ GetHostAddress()

void * NTV2Buffer::GetHostAddress	(	const ULWord	inByteOffset,
		const bool	inFromEnd = `false`
	)		const

Parameters

[in]	inByteOffset	Specifies the offset from the start (or end) of my memory buffer. Must be less than my size (see GetByteCount).
[in]	inFromEnd	Specify 'true' to reference the end of my buffer. Specify 'false' (the default) to reference the start of my buffer.

Returns: The host address of the given byte. Returns NULL upon failure.

Definition at line 1898 of file ntv2publicinterface.cpp.

◆ GetHostPointer()

void* NTV2Buffer::GetHostPointer ( void ) const

inline

Returns: My user-space host virtual address, as seen by the host process.

Definition at line 6307 of file ntv2publicinterface.h.

◆ GetRawHostPointer()

ULWord64 NTV2Buffer::GetRawHostPointer ( void ) const

inline

Returns: My "raw" user-space host virtual address.

Note: On 32-bit platforms, the true address is found in the most significant 4 bytes of the ULWord64 value.

Definition at line 6319 of file ntv2publicinterface.h.

◆ GetRingChangedByteRange()

bool NTV2Buffer::GetRingChangedByteRange	(	const NTV2Buffer &	inBuffer,
		ULWord &	outByteOffsetFirst,
		ULWord &	outByteOffsetLast
	)		const

Assuming my contents and the contents of the given buffer comprise ring buffers that periodically get overwritten in contiguous variable-length chunks, answers with the contiguous byte range that differs between the two.

Parameters

[in]	inBuffer	Specifies the memory buffer whose contents are to be compared with mine. Contents are assumed to comprise a ring buffer, where data periodically gets overwritten in chunks.
[out]	outByteOffsetFirst	Receives the offset, in bytes, from the start of the buffer, of the first byte of the contiguous range that's different. Zero indicates the first byte in the buffer. If equal to NTV2Buffer::GetByteCount(), then both buffers are identical. If greater than 'outByteOffsetLast', then a wrap condition exists (see Note).
[out]	outByteOffsetLast	Receives the offset, in bytes, from the start of the buffer, of the last byte of the contiguous range that's different. Zero indicates the first byte in the buffer. If equal to NTV2Buffer::GetByteCount(), then both buffers are identical. If less than 'outByteOffsetFirst', a wrap condition exists (see Note).

Note: If a wrap condition exists – i.e., the contiguous byte range that differs starts near the end and wraps around to near the front – then 'outByteOffsetFirst' will be greater than 'outByteOffsetLast'.

Returns: True if successful; otherwise false.

Definition at line 2146 of file ntv2publicinterface.cpp.

◆ GetString() [1/2]

bool NTV2Buffer::GetString	(	std::string &	outString,
		const size_t	inU8Offset = `0`,
		const size_t	inMaxSize = `128`
	)		const

Answers with my contents as a character string.

Parameters

[out]	outString	Receives the character string copied from my contents.
[in]	inU8Offset	The starting offset, in bytes, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 8-bit values to be returned. Use zero for unlimited. The actual number of returned 8-bit values may be less than this, depending on my size. Defaults to 128.

Returns: True if successful; otherwise false.

Note: Byte copying terminates at the first zero byte that's encountered in my buffer.

Definition at line 793 of file ntv2publicinterface.cpp.

◆ GetString() [2/2]

std::string NTV2Buffer::GetString	(	const size_t	inU8Offset = `0`,
		const size_t	inMaxSize = `128`
	)		const

inline

Returns: My contents as a character string.

Parameters

[in]	inU8Offset	The starting offset, in bytes, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 8-bit values to be returned. Use zero for unlimited. The actual number of returned 8-bit values may be less than this, depending on my size. Defaults to 128.

Note: Byte copying terminates at the first zero byte that's encountered in my buffer.

Definition at line 6957 of file ntv2publicinterface.h.

◆ GetU16s() [1/2]

bool NTV2Buffer::GetU16s	(	UWordSequence &	outU16s,
		const size_t	inU16Offset = `0`,
		const size_t	inMaxSize = `64`,
		const bool	inByteSwap = `false`
	)		const

Answers with my contents as a vector of unsigned 16-bit values.

Parameters

[out]	outU16s	Receives my contents as a vector of unsigned 16-bit values.
[in]	inU16Offset	The starting offset, in 16-bit words, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 16-bit values to be returned. Use zero for unlimited. The actual number of returned 16-bit values may be less than this, depending on my size. Defaults to 64.
[in]	inByteSwap	Specifies if the resulting values will be byte-swapped or not. Specify 'true' to byte-swap; specify 'false' to return the normal, unswapped values. Defaults to 'false'.

Returns: True if successful; otherwise false.

Note: If my length is not evenly divisible by 2, my last byte won't appear in the resulting vector.

Definition at line 704 of file ntv2publicinterface.cpp.

◆ GetU16s() [2/2]

UWordSequence NTV2Buffer::GetU16s	(	const size_t	inU16Offset = `0`,
		const size_t	inMaxSize = `64`,
		const bool	inByteSwap = `false`
	)		const

inline

Returns: My contents as a vector of unsigned 16-bit values.

Parameters

[in]	inU16Offset	The starting offset, in 16-bit words, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 16-bit values to be returned. Use zero for unlimited. The actual number of returned 16-bit values may be less than this, depending on my size. Defaults to 64.
[in]	inByteSwap	Specifies if the resulting values will be byte-swapped or not. Specify 'true' to byte-swap; specify 'false' to return the normal, unswapped values. Defaults to 'false'.

Note: If my length is not evenly divisible by 2, my last byte won't appear in the resulting vector.

Definition at line 6904 of file ntv2publicinterface.h.

◆ GetU32s() [1/2]

bool NTV2Buffer::GetU32s	(	ULWordSequence &	outU32s,
		const size_t	inU32Offset = `0`,
		const size_t	inMaxSize = `32`,
		const bool	inByteSwap = `false`
	)		const

Answers with my contents as a vector of unsigned 32-bit values.

Parameters

[out]	outU32s	Receives my contents as a vector of unsigned 32-bit values.
[in]	inU32Offset	The starting offset, in 32-bit words, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 32-bit values to be returned. Use zero for unlimited. The actual number of returned 32-bit values may be less than this, depending on my size. Defaults to 32.
[in]	inByteSwap	Specifies if the resulting values will be byte-swapped or not. Specify 'true' to byte-swap; specify 'false' to return the normal, unswapped values. Defaults to 'false'.

Returns: True if successful; otherwise false.

Note: If my length is not evenly divisible by 4, my last bytes won't appear in the resulting vector.

Definition at line 667 of file ntv2publicinterface.cpp.

◆ GetU32s() [2/2]

ULWordSequence NTV2Buffer::GetU32s	(	const size_t	inU32Offset = `0`,
		const size_t	inMaxSize = `32`,
		const bool	inByteSwap = `false`
	)		const

inline

Returns: My contents as a vector of unsigned 32-bit values.

Parameters

[in]	inU32Offset	The starting offset, in 32-bit words, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 32-bit values to be returned. Use zero for unlimited. The actual number of returned 32-bit values may be less than this, depending on my size. Defaults to 32.
[in]	inByteSwap	Specifies if the resulting values will be byte-swapped or not. Specify 'true' to byte-swap; specify 'false' to return the normal, unswapped values. Defaults to 'false'.

Note: If my length is not evenly divisible by 4, my last bytes won't appear in the resulting vector.

Definition at line 6874 of file ntv2publicinterface.h.

◆ GetU64s() [1/2]

bool NTV2Buffer::GetU64s	(	ULWord64Sequence &	outU64s,
		const size_t	inU64Offset = `0`,
		const size_t	inMaxSize = `16`,
		const bool	inByteSwap = `false`
	)		const

Answers with my contents as a vector of unsigned 16-bit values.

Parameters

[out]	outU64s	Receives my contents as a vector of unsigned 64-bit values.
[in]	inU64Offset	The starting offset, in 64-bit words, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 64-bit values to be returned. Use zero for unlimited. The actual number of returned 64-bit values may be less than this, depending on my size. Defaults to 16.
[in]	inByteSwap	Specifies if the resulting values will be byte-swapped or not. Specify 'true' to byte-swap; specify 'false' to return the normal, unswapped values. Defaults to 'false'.

Returns: True if successful; otherwise false.

Note: If my length is not evenly divisible by 8, my last bytes won't appear in the resulting vector.

Definition at line 630 of file ntv2publicinterface.cpp.

◆ GetU64s() [2/2]

ULWord64Sequence NTV2Buffer::GetU64s	(	const size_t	inU64Offset = `0`,
		const size_t	inMaxSize = `16`,
		const bool	inByteSwap = `false`
	)		const

inline

Returns: My contents as a vector of unsigned 64-bit values.

Parameters

[in]	inU64Offset	The starting offset, in 64-bit words, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 64-bit values to be returned. Use zero for unlimited. The actual number of returned 64-bit values may be less than this, depending on my size. Defaults to 16.
[in]	inByteSwap	Specifies if the resulting values will be byte-swapped or not. Specify 'true' to byte-swap; specify 'false' to return the normal, unswapped values. Defaults to 'false'.

Note: If my length is not evenly divisible by 8, my last bytes won't appear in the resulting vector.

Definition at line 6844 of file ntv2publicinterface.h.

◆ GetU8s() [1/2]

bool NTV2Buffer::GetU8s	(	UByteSequence &	outU8s,
		const size_t	inU8Offset = `0`,
		const size_t	inMaxSize = `128`
	)		const

Answers with my contents as a vector of unsigned 8-bit values.

Parameters

[out]	outU8s	Receives my contents as a vector of unsigned 8-bit values.
[in]	inU8Offset	The starting offset, in bytes, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 8-bit values to be returned. Use zero for unlimited. The actual number of returned 8-bit values may be less than this, depending on my size. Defaults to 128.

Returns: True if successful; otherwise false.

Definition at line 741 of file ntv2publicinterface.cpp.

◆ GetU8s() [2/2]

UByteSequence NTV2Buffer::GetU8s	(	const size_t	inU8Offset = `0`,
		const size_t	inMaxSize = `128`
	)		const

inline

Returns: My contents as a vector of unsigned 8-bit values.

Parameters

[in]	inU8Offset	The starting offset, in bytes, where copying will commence.
[in]	inMaxSize	Specifies the maximum number of 8-bit values to be returned. Use zero for unlimited. The actual number of returned 8-bit values may be less than this, depending on my size. Defaults to 128.

Definition at line 6926 of file ntv2publicinterface.h.

◆ HostPageSize()

size_t NTV2Buffer::HostPageSize ( void )

static

Returns: Host OS/hardware page size, in bytes.

Definition at line 2240 of file ntv2publicinterface.cpp.

◆ I16() [1/2]

int16_t NTV2Buffer::I16 ( const int inIndex ) const

inline

Definition at line 6796 of file ntv2publicinterface.h.

◆ I16() [2/2]

int16_t& NTV2Buffer::I16 ( const int inIndex )

inline

Definition at line 6797 of file ntv2publicinterface.h.

◆ I32() [1/2]

int32_t NTV2Buffer::I32 ( const int inIndex ) const

inline

Definition at line 6800 of file ntv2publicinterface.h.

◆ I32() [2/2]

int32_t& NTV2Buffer::I32 ( const int inIndex )

inline

Definition at line 6801 of file ntv2publicinterface.h.

◆ I64() [1/2]

int64_t NTV2Buffer::I64 ( const int inIndex ) const

inline

Definition at line 6804 of file ntv2publicinterface.h.

◆ I64() [2/2]

int64_t& NTV2Buffer::I64 ( const int inIndex )

inline

Definition at line 6805 of file ntv2publicinterface.h.

◆ I8() [1/2]

int8_t NTV2Buffer::I8 ( const int inIndex ) const

inline

Definition at line 6792 of file ntv2publicinterface.h.

◆ I8() [2/2]

int8_t& NTV2Buffer::I8 ( const int inIndex )

inline

Definition at line 6793 of file ntv2publicinterface.h.

◆ IsAllocatedBySDK()

bool NTV2Buffer::IsAllocatedBySDK ( void ) const

inline

Returns: True if my host storage was allocated by my Allocate function; otherwise false if my host storage address and size was provided by the client application.

Definition at line 6330 of file ntv2publicinterface.h.

◆ IsContentEqual()

bool NTV2Buffer::IsContentEqual	(	const NTV2Buffer &	inBuffer,
		const ULWord	inByteOffset = `0`,
		const ULWord	inByteCount = `0xFFFFFFFF`
	)		const

Returns: True if the given memory buffer's contents are identical to my own.

Parameters

[in]	inBuffer	Specifies the memory buffer whose contents are to be compared with mine.
[in]	inByteOffset	Specifies the byte offset to start comparing. Defaults to the first byte.
[in]	inByteCount	Specifies the maximum number of bytes to compare. Defaults to 0xFFFFFFFF (entire buffer).

Definition at line 2071 of file ntv2publicinterface.cpp.

◆ IsNULL()

bool NTV2Buffer::IsNULL ( void ) const

inline

Returns: True if my user-space pointer is NULL, or my size is zero.

Definition at line 6346 of file ntv2publicinterface.h.

◆ IsPageAligned()

bool NTV2Buffer::IsPageAligned ( void ) const

inline

Returns: True if my host storage was page-aligned when Allocated; otherwise false.

Definition at line 6341 of file ntv2publicinterface.h.

◆ IsProvidedByClient()

bool NTV2Buffer::IsProvidedByClient ( void ) const

inline

Returns: True if my host storage was provided by the client application; otherwise false if it was allocated by my Allocate function.

Definition at line 6336 of file ntv2publicinterface.h.

◆ NextDifference()

bool NTV2Buffer::NextDifference	(	const NTV2Buffer &	inBuffer,
		ULWord &	byteOffset
	)		const

Iterates over each byte that differs between myself and the given buffer.

Parameters

[in]	inBuffer	Specifies the memory buffer whose contents are to be compared with mine. The buffer sizes must match.
	byteOffset	On entry, specifies the byte offset where comparing begins (use zero to find the first difference); on exit, receives the byte offset of the next difference found (or 0xFFFFFFFF if no further differences found).

Returns: True if successful; otherwise false.

Definition at line 2117 of file ntv2publicinterface.cpp.

◆ operator bool()

NTV2Buffer::operator bool ( ) const

inline

Returns: True if my host pointer is non-NULL and my byte count is non-zero; otherwise false.

Definition at line 6351 of file ntv2publicinterface.h.

◆ operator const T *()

template<typename T >

NTV2Buffer::operator const T * ( ) const

inline

Returns: My host address casted to a const T pointer.

Definition at line 6757 of file ntv2publicinterface.h.

◆ operator size_t()

NTV2Buffer::operator size_t ( ) const

inline

Returns: My size, in bytes, as a size_t.

Definition at line 6356 of file ntv2publicinterface.h.

◆ operator T*()

template<typename T >

NTV2Buffer::operator T* ( ) const

inline

Returns: My host address casted to a non-const T pointer.

Definition at line 6762 of file ntv2publicinterface.h.

◆ operator=()

NTV2Buffer & NTV2Buffer::operator= ( const NTV2Buffer & inRHS )

Assigns me from another NTV2Buffer instance.

Parameters

[in] inRHS Specifies the NTV2Buffer instance to assign ("deep" copy) to me.

Definition at line 1764 of file ntv2publicinterface.cpp.

◆ Print()

ostream & NTV2Buffer::Print ( std::ostream & inOutStream ) const

Prints a human-readable representation of me into the given output stream.

Parameters

inOutStream The output stream to receive my human-readable representation.

Returns: A reference to the given output stream.

Definition at line 409 of file ntv2publicinterface.cpp.

◆ PutU16s()

bool NTV2Buffer::PutU16s	(	const UWordSequence &	inU16s,
		const size_t	inU16Offset = `0`,
		const bool	inByteSwap = `false`
	)

Copies a vector of unsigned 16-bit values into me.

Parameters

[in]	inU16s	The vector of unsigned 16-bit values to be copied into me.
[in]	inU16Offset	Specifies my starting offset (of 16-bit values) at which the vector values will be written. Defaults to zero.
[in]	inByteSwap	Specifies if the 16-bit values will be byte-swapped or not before being written into me. Specify 'true' to byte-swap; otherwise specify 'false'. Defaults to 'false'.

Returns: True if successful; otherwise false.

Definition at line 889 of file ntv2publicinterface.cpp.

◆ PutU32s()

bool NTV2Buffer::PutU32s	(	const ULWordSequence &	inU32s,
		const size_t	inU32Offset = `0`,
		const bool	inByteSwap = `false`
	)

Copies a vector of unsigned 32-bit values into me.

Parameters

[in]	inU32s	The vector of unsigned 32-bit values to be copied into me.
[in]	inU32Offset	Specifies my starting offset (of 32-bit values) at which the vector values will be written. Defaults to zero.
[in]	inByteSwap	Specifies if the 32-bit values will be byte-swapped or not before being written into me. Specify 'true' to byte-swap; otherwise specify 'false'. Defaults to 'false'.

Returns: True if successful; otherwise false.

Definition at line 861 of file ntv2publicinterface.cpp.

◆ PutU64s()

bool NTV2Buffer::PutU64s	(	const ULWord64Sequence &	inU64s,
		const size_t	inU64Offset = `0`,
		const bool	inByteSwap = `false`
	)

Copies a vector of unsigned 64-bit values into me.

Parameters

[in]	inU64s	The vector of unsigned 64-bit values to be copied into me.
[in]	inU64Offset	Specifies my starting offset (of 64-bit values) at which the vector values will be written. Defaults to zero.
[in]	inByteSwap	Specifies if the 64-bit values will be byte-swapped or not before being written into me. Specify 'true' to byte-swap; otherwise specify 'false'. Defaults to 'false'.

Returns: True if successful; otherwise false.

Definition at line 833 of file ntv2publicinterface.cpp.

◆ PutU8s()

bool NTV2Buffer::PutU8s	(	const UByteSequence &	inU8s,
		const size_t	inU8Offset = `0`
	)

Copies a vector of unsigned 8-bit values into me.

Parameters

[in]	inU8s	The vector of unsigned 8-bit values to be copied into me.
[in]	inU8Offset	Specifies my starting byte offset at which the vector values will be written. Defaults to zero.

Returns: True if successful; otherwise false.

Definition at line 917 of file ntv2publicinterface.cpp.

◆ RPCDecode()

bool NTV2Buffer::RPCDecode	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex,
		bool	fillBuffer = `true`
	)

Definition at line 3894 of file ntv2publicinterface.cpp.

◆ RPCDecodeNoAllocate()

bool NTV2Buffer::RPCDecodeNoAllocate	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

Definition at line 3912 of file ntv2publicinterface.cpp.

◆ RPCEncode()

bool NTV2Buffer::RPCEncode	(	NTV2_RPC_BLOB_TYPE &	outBlob,
		bool	fillBuffer = `true`
	)

Definition at line 3885 of file ntv2publicinterface.cpp.

◆ Segment()

NTV2Buffer & NTV2Buffer::Segment	(	NTV2Buffer &	outPtr,
		const ULWord	inByteOffset,
		const ULWord	inByteCount
	)		const

Resets an NTV2Buffer instance to reference a contiguous segment (portion) of my memory buffer.

Parameters

[out]	outPtr	The NTV2Buffer to be reset to my sub-segment. Note this receives a reference my segment, not a copy of it.
[in]	inByteOffset	Specifies the offset, in bytes, where the segment starts.
[in]	inByteCount	Specifies the segment length, in bytes.

Returns: The specified NTV2Buffer. It will be set to null/empty upon failure.

Note: The offset and byte count are both checked against my buffer size.

Warning: Using the "outPtr" instance after my destruction will likely cause access violations, heap corruption, etc.

Definition at line 618 of file ntv2publicinterface.cpp.

◆ Set()

bool NTV2Buffer::Set	(	const void *	pInUserPointer,
		const size_t	inByteCount
	)

Sets (or resets) me from a client-supplied address and size.

Parameters

[in]	pInUserPointer	Specifies the user-space virtual memory address. The client is entirely responsible for it. Ignored if inByteCount is zero.
[in]	inByteCount	Specifies the byte count. Ignored if pInUserPointer is NULL.

Returns: True if both pInUserPointer and inByteCount agree (i.e. if pInUserPointer and inByteCount are both zero, or if they're both non-zero); otherwise false if they don't agree (i.e. one is non-zero and the other is zero, or vice-versa).

Note: Any memory that I was referencing prior to this call that I was responsible for will automatically be freed.

Definition at line 1822 of file ntv2publicinterface.cpp.

◆ SetAndFill()

bool NTV2Buffer::SetAndFill	(	const void *	pInUserPointer,
		const size_t	inByteCount,
		const UByte	inValue
	)

Sets (or resets) me from a client-supplied address and size.

Parameters

[in]	pInUserPointer	Specifies the user-space virtual memory address. The client is entirely responsible for it. Ignored if inByteCount is zero.
[in]	inByteCount	Specifies the byte count. Ignored if pInUserPointer is NULL.
[in]	inValue	Specifies the value to fill the buffer with.

Returns: True if both pInUserPointer and inByteCount agree (i.e. if pInUserPointer and inByteCount are both zero, or if they're both non-zero); otherwise false if they don't agree (i.e. one is non-zero and the other is zero, or vice-versa).

Note: Any memory that I was referencing prior to this call that I was responsible for will automatically be freed.

Definition at line 1834 of file ntv2publicinterface.cpp.

◆ SetDefaultPageSize()

bool NTV2Buffer::SetDefaultPageSize ( const size_t inNewSize )

static

Changes the default page size for use in future page-aligned allocations.

Parameters

[in] inNewSize The new page size value, in bytes. Must be a power of 2.

Returns: True if successful; otherwise false.

Definition at line 2232 of file ntv2publicinterface.cpp.

◆ SetFrom()

bool NTV2Buffer::SetFrom ( const NTV2Buffer & inBuffer )

Replaces my contents from the given memory buffer without resizing me.

Parameters

[in] inBuffer Specifies the memory buffer whose contents are to be copied into my own. If this buffer is larger than I am, I am not resized; instead, only those bytes that fit in me will be copied.

Returns: True if successful; otherwise false.

Definition at line 1913 of file ntv2publicinterface.cpp.

◆ SetFromHexString()

bool NTV2Buffer::SetFromHexString ( const std::string & inStr )

Replaces my contents from the given hex-encoded string, resizing me if necessary.

Parameters

[in] inStr Specifies the hex-encoded string whose contents will be decoded and used to resize and fill me. Any whitespace characters are skipped and ignored. All other characters must be a hexadecimal digit (upper or lower case).

Returns: True if successful; otherwise false.

See also: NTV2Buffer::toHexString

Definition at line 1996 of file ntv2publicinterface.cpp.

◆ SwapWith()

bool NTV2Buffer::SwapWith ( NTV2Buffer & inBuffer )

Swaps my underlying buffer with another's.

Parameters

[in] inBuffer Specifies the NTV2Buffer I'll swap buffers with.

Returns: True if successful; otherwise false.

Note: The buffers must have identical sizes, and must have equal ownership attributes.; AJA recommends not using this function to swap NTV2Buffers that were allocated in different executable modules (e.g., on Windows, an NTV2Buffer that was allocated in a DLL with another that was allocated in an EXE).

Definition at line 2023 of file ntv2publicinterface.cpp.

◆ toHexString()

bool NTV2Buffer::toHexString	(	std::string &	outStr,
		const size_t	inLineBreakInterval = `0`
	)		const

Converts my contents into a hex-encoded string.

Parameters

[out]	outStr	Receives the hexadecimal-encoded string representation of my contents.
[in]	inLineBreakInterval	Optionally inserts a newline into the resulting string at the specified byte count interval. Defaults to zero (no newlines are inserted).

Returns: True if successful; otherwise false.

See also: NTV2Buffer::SetFromHexString

Definition at line 475 of file ntv2publicinterface.cpp.

◆ Truncate()

bool NTV2Buffer::Truncate ( const size_t inByteCount )

Truncates me to the given length. No reallocation takes place.

Parameters

[in] inByteCount Specifies my new length. Specify zero to Deallocate. Otherwise must be less than my current length.

Returns: True if successful; otherwise false.

Definition at line 1752 of file ntv2publicinterface.cpp.

◆ U16() [1/2]

uint16_t NTV2Buffer::U16 ( const int inIndex ) const

inline

Definition at line 6794 of file ntv2publicinterface.h.

◆ U16() [2/2]

uint16_t& NTV2Buffer::U16 ( const int inIndex )

inline

Definition at line 6795 of file ntv2publicinterface.h.

◆ U32() [1/2]

uint32_t NTV2Buffer::U32 ( const int inIndex ) const

inline

Definition at line 6798 of file ntv2publicinterface.h.

◆ U32() [2/2]

uint32_t& NTV2Buffer::U32 ( const int inIndex )

inline

Definition at line 6799 of file ntv2publicinterface.h.

◆ U64() [1/2]

uint64_t NTV2Buffer::U64 ( const int inIndex ) const

inline

Definition at line 6802 of file ntv2publicinterface.h.

◆ U64() [2/2]

uint64_t& NTV2Buffer::U64 ( const int inIndex )

inline

Definition at line 6803 of file ntv2publicinterface.h.

◆ U8() [1/2]

uint8_t NTV2Buffer::U8 ( const int inIndex ) const

inline

Returns: A copy of the value at the given zero-based index position.

Parameters

[in] inIndex Specifies the zero-based index position (e.g. 0 is first value at start of my memory). If negative, indexes from the end of my memory (e.g. -1 is last value).

Warning: Bad index values will result in access violation exceptions.

Definition at line 6782 of file ntv2publicinterface.h.

◆ U8() [2/2]

uint8_t& NTV2Buffer::U8 ( const int inIndex )

inline

Returns: A writeable (non-const) reference to the value at the given zero-based index position.

Parameters

[in] inIndex Specifies the zero-based index position (e.g. 0 is first value at start of my memory). If negative, indexes from the end of my memory (e.g. -1 is last value).

Warning: Bad index values will result in access violation exceptions.

Definition at line 6790 of file ntv2publicinterface.h.

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

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2publicinterface.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2publicinterface.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NTV2Buffer() [1/3]

◆ NTV2Buffer() [2/3]

◆ NTV2Buffer() [3/3]

◆ ~NTV2Buffer()

Member Function Documentation

◆ Allocate()

◆ AppendU8s()

◆ AsCode()

◆ AsString()

◆ ByteSwap16()

◆ ByteSwap32()

◆ ByteSwap64()

◆ CopyFrom() [1/3]

◆ CopyFrom() [2/3]

◆ CopyFrom() [3/3]

◆ DBL() [1/2]

◆ DBL() [2/2]

◆ Deallocate()

◆ DefaultPageSize()

◆ Dump() [1/2]

◆ Dump() [2/2]

◆ Fill() [1/2]

◆ Fill() [2/2]

◆ Find() [1/2]

◆ Find() [2/2]

◆ FindAll()

◆ FL() [1/2]

◆ FL() [2/2]

◆ GetByteCount()

◆ GetHostAddress()

◆ GetHostPointer()

◆ GetRawHostPointer()

◆ GetRingChangedByteRange()

◆ GetString() [1/2]

◆ GetString() [2/2]

◆ GetU16s() [1/2]

◆ GetU16s() [2/2]

◆ GetU32s() [1/2]

◆ GetU32s() [2/2]

◆ GetU64s() [1/2]

◆ GetU64s() [2/2]

◆ GetU8s() [1/2]

◆ GetU8s() [2/2]

◆ HostPageSize()

◆ I16() [1/2]

◆ I16() [2/2]

◆ I32() [1/2]

◆ I32() [2/2]

◆ I64() [1/2]

◆ I64() [2/2]

◆ I8() [1/2]

◆ I8() [2/2]

◆ IsAllocatedBySDK()

◆ IsContentEqual()

◆ IsNULL()

◆ IsPageAligned()

◆ IsProvidedByClient()

◆ NextDifference()

◆ operator bool()

◆ operator const T *()

◆ operator size_t()

◆ operator T*()

◆ operator=()

◆ Print()

◆ PutU16s()

◆ PutU32s()

◆ PutU64s()

◆ PutU8s()

◆ RPCDecode()

◆ RPCDecodeNoAllocate()

◆ RPCEncode()

◆ Segment()

◆ Set()

◆ SetAndFill()

◆ SetDefaultPageSize()

◆ SetFrom()