NTV2SDIInStatistics Class Reference

This is used by the CNTV2Card::ReadSDIStatistics function. More...

#include <ntv2publicinterface.h>

Public Member Functions
	NTV2SDIInStatistics ()
	Constructs an NTV2GetSDIStatistics struct and initializes it to its default state. More...
void	Clear (void)
	Resets the struct to its initialized state. More...
bool	GetSDIInputStatus (NTV2SDIInputStatus &outStatus, const UWord inSDIInputIndex0=0)
	Answers with the NTV2SDIInputStatus for the given SDI input spigot. More...
NTV2SDIInputStatus &	operator[] (const size_t inSDIInputIndex0)
std::ostream &	Print (std::ostream &inOutStream) const
	Prints a human-readable representation of me to the given output stream. More...
bool	RPCEncode (NTV2_RPC_BLOB_TYPE &outBlob)
bool	RPCDecode (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)

Detailed Description

This is used by the CNTV2Card::ReadSDIStatistics function.

Note

There is no need to access any of this structure's fields directly. Simply call the CNTV2Card instance's ReadSDIStatistics function.

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

Definition at line 7678 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2SDIInStatistics()

NTV2SDIInStatistics::NTV2SDIInStatistics

(

)

Constructs an NTV2GetSDIStatistics struct and initializes it to its default state.

Definition at line 2316 of file ntv2publicinterface.cpp.

Member Function Documentation

Clear()

void NTV2SDIInStatistics::Clear

(

void

)

Resets the struct to its initialized state.

Definition at line 2324 of file ntv2publicinterface.cpp.

GetSDIInputStatus()

bool NTV2SDIInStatistics::GetSDIInputStatus	(	NTV2SDIInputStatus &	outStatus,
		const UWord	inSDIInputIndex0 = 0
	)

Answers with the NTV2SDIInputStatus for the given SDI input spigot.

Parameters

[out]	outStatus	Receives the NTV2SDIInputStatus for the given SDI input.
[in]	inSDIInputIndex0	Specifies the zero-based index of the SDI input of interest.

Returns

True if successful; otherwise false.

Definition at line 2334 of file ntv2publicinterface.cpp.

operator[]()

NTV2SDIInputStatus & NTV2SDIInStatistics::operator[]

(

const size_t

inSDIInputIndex0

)

Returns

A non-const reference to the NTV2SDIInputStatus record for the given SDI input.

Parameters

[in]

inSDIInputIndex0

Specifies the zero-based index of the SDI input of interest.

Definition at line 2350 of file ntv2publicinterface.cpp.

Print()

std::ostream & NTV2SDIInStatistics::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 2365 of file ntv2publicinterface.cpp.

RPCDecode()

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

RPCEncode()

bool NTV2SDIInStatistics::RPCEncode

(

NTV2_RPC_BLOB_TYPE &

outBlob

)

---

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