This is used to perform virtual data reads or writes. More...

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2VirtualData:

Public Member Functions
	NTV2VirtualData (const ULWord inTag, const void *inVirtualData, const size_t inVirtualDataSize, const bool inDoWrite=false)
	Constructs an NTV2VirtualData struct for reading or writing virtual data. More...

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

	operator NTV2_HEADER * ()

bool	RPCEncode (NTV2_RPC_BLOB_TYPE &outBlob)

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

Public Attributes
NTV2_HEADER	mHeader
	The common structure header – ALWAYS FIRST! More...

ULWord	mTag
	Tag for virtual data. This value is used to recal saved data by tag. More...

ULWord	mIsWriting
	If non-zero, virtual data will be written; otherwise, virtual data will be read. More...

NTV2Buffer	mVirtualData
	Pointer object to virtual data. The SDK owns this memory. More...

NTV2_TRAILER	mTrailer
	The common structure trailer – ALWAYS LAST! More...

Detailed Description

This is used to perform virtual data reads or writes.

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

Definition at line 7876 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2VirtualData()

NTV2VirtualData::NTV2VirtualData	(	const ULWord	inTag,
		const void *	inVirtualData,
		const size_t	inVirtualDataSize,
		const bool	inDoWrite = `false`
	)

explicit

Constructs an NTV2VirtualData struct for reading or writing virtual data.

Parameters

[in]	inTag	The tag to use.
[in]	inVirtualData	Pointer to vitrual data.
[in]	inVirtualDataSize	The size of the virtual data.
[in]	inDoWrite	True if writing, false if reading.

Definition at line 3664 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ operator NTV2_HEADER *()

NTV2VirtualData::operator NTV2_HEADER * ( )

inline

Returns: My address casted to an NTV2_HEADER pointer.

Definition at line 7903 of file ntv2publicinterface.h.

◆ Print()

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

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

Parameters

inOutStream Specifies the output stream to use.

Returns: A reference to the output stream.

Definition at line 3674 of file ntv2publicinterface.cpp.

◆ RPCDecode()

bool NTV2VirtualData::RPCDecode	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

◆ RPCEncode()

bool NTV2VirtualData::RPCEncode ( NTV2_RPC_BLOB_TYPE & outBlob )

Member Data Documentation

◆ mHeader

NTV2_HEADER NTV2VirtualData::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 7877 of file ntv2publicinterface.h.

◆ mIsWriting

ULWord NTV2VirtualData::mIsWriting

If non-zero, virtual data will be written; otherwise, virtual data will be read.

Definition at line 7879 of file ntv2publicinterface.h.

◆ mTag

ULWord NTV2VirtualData::mTag

Tag for virtual data. This value is used to recal saved data by tag.

Definition at line 7878 of file ntv2publicinterface.h.

◆ mTrailer

NTV2_TRAILER NTV2VirtualData::mTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 7881 of file ntv2publicinterface.h.

◆ mVirtualData

NTV2Buffer NTV2VirtualData::mVirtualData

Pointer object to virtual data. The SDK owns this memory.

Definition at line 7880 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

Public Attributes