NTV2SetRegisters Class Reference

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

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2SetRegisters:

Public Member Functions
	NTV2SetRegisters (const NTV2RegWrites &inRegWrites=NTV2RegWrites())
	Constructs an NTV2SetRegisters struct from the given NTV2RegisterWrites collection. More...
bool	ResetUsing (const NTV2RegWrites &inRegWrites)
	Resets me, starting over, now using the given NTV2RegisterNumberSet. More...
bool	GetFailedRegisterWrites (NTV2RegWrites &outFailedRegWrites) const
	Returns an NTV2RegisterWrites built from my mOutBadRegInfos field. More...
	operator NTV2_HEADER * ()
ULWord	GetRequestedRegisterCount (void) const
bool	GetRequestedRegisterWrites (NTV2RegWrites &outRegWrites) const
ULWord	GetNumFailedWrites (void) const
std::ostream &	Print (std::ostream &inOutStream) const
	Prints a human-readable representation of me to the given output stream. More...
const NTV2Buffer &	regInfos (void) const
ULWord &	outNumFailures (void)
NTV2Buffer &	outBadRegIndexes (void)
bool	RPCEncode (NTV2_RPC_BLOB_TYPE &outBlob)
bool	RPCDecode (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
bool	RPCDecodeClient (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
bool	RPCEncodeClient (NTV2_RPC_BLOB_TYPE &inBlob)
bool	RPCDecodeServer (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
bool	RPCEncodeServer (NTV2_RPC_BLOB_TYPE &inBlob)

Public Attributes
NTV2_HEADER	mHeader
	The common structure header – ALWAYS FIRST! More...
ULWord	mInNumRegisters
	The number of NTV2RegInfo's to be set. More...
NTV2Buffer	mInRegInfos
	Read-only array of NTV2RegInfo structs to be set. The SDK owns this memory. More...
ULWord	mOutNumFailures
	The number of registers unsuccessfully written. More...
NTV2Buffer	mOutBadRegIndexes
	Array of UWords containing index numbers of the register writes that failed. The SDK owns this memory. More...
NTV2_TRAILER	mTrailer
	The common structure trailer – ALWAYS LAST! More...

Detailed Description

This is used by the CNTV2Card::WriteRegisters function.

Note

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

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

Definition at line 7809 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2SetRegisters()

NTV2SetRegisters::NTV2SetRegisters

(

const NTV2RegWrites &

inRegWrites = NTV2RegWrites()

)

Constructs an NTV2SetRegisters struct from the given NTV2RegisterWrites collection.

Parameters

[in]

inRegWrites

An ordered collection of NTV2ReadWriteRegisterSingle structs to be copied into my mInRegInfos field. If omitted, defaults to an empty collection.

Definition at line 3381 of file ntv2publicinterface.cpp.

Member Function Documentation

GetFailedRegisterWrites()

bool NTV2SetRegisters::GetFailedRegisterWrites

(

NTV2RegWrites &

outFailedRegWrites

)

const

Returns an NTV2RegisterWrites built from my mOutBadRegInfos field.

Parameters

[out]

outFailedRegWrites

Receives the list of failed writes.

Returns

True if successful; otherwise false.

Definition at line 3417 of file ntv2publicinterface.cpp.

GetNumFailedWrites()

ULWord NTV2SetRegisters::GetNumFailedWrites ( void  ) const

inline

Definition at line 7846 of file ntv2publicinterface.h.

GetRequestedRegisterCount()

ULWord NTV2SetRegisters::GetRequestedRegisterCount ( void  ) const

inline

Definition at line 7844 of file ntv2publicinterface.h.

GetRequestedRegisterWrites()

bool NTV2SetRegisters::GetRequestedRegisterWrites

(

NTV2RegWrites &

outRegWrites

)

const

Definition at line 3424 of file ntv2publicinterface.cpp.

operator NTV2_HEADER *()

NTV2SetRegisters::operator NTV2_HEADER * ( )

inline

Returns

My address casted to an NTV2_HEADER pointer.

Definition at line 7842 of file ntv2publicinterface.h.

outBadRegIndexes()

NTV2Buffer& NTV2SetRegisters::outBadRegIndexes ( void  )

inline

Definition at line 7857 of file ntv2publicinterface.h.

outNumFailures()

ULWord& NTV2SetRegisters::outNumFailures ( void  )

inline

Definition at line 7856 of file ntv2publicinterface.h.

Print()

ostream & NTV2SetRegisters::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 3439 of file ntv2publicinterface.cpp.

regInfos()

const NTV2Buffer& NTV2SetRegisters::regInfos ( void  ) const

inline

Definition at line 7855 of file ntv2publicinterface.h.

ResetUsing()

bool NTV2SetRegisters::ResetUsing

(

const NTV2RegWrites &

inRegWrites

)

Resets me, starting over, now using the given NTV2RegisterNumberSet.

Parameters

[in]

inRegWrites

An ordered collection of NTV2ReadWriteRegisterSingle structs to be copied into my mInRegInfos field. If omitted, defaults to an empty collection.

Definition at line 3390 of file ntv2publicinterface.cpp.

RPCDecode()

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

Definition at line 3939 of file ntv2publicinterface.cpp.

RPCDecodeClient()

bool NTV2SetRegisters::RPCDecodeClient	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

RPCDecodeServer()

bool NTV2SetRegisters::RPCDecodeServer	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

RPCEncode()

bool NTV2SetRegisters::RPCEncode

(

NTV2_RPC_BLOB_TYPE &

outBlob

)

Definition at line 3914 of file ntv2publicinterface.cpp.

RPCEncodeClient()

bool NTV2SetRegisters::RPCEncodeClient

(

NTV2_RPC_BLOB_TYPE &

inBlob

)

RPCEncodeServer()

bool NTV2SetRegisters::RPCEncodeServer

(

NTV2_RPC_BLOB_TYPE &

inBlob

)

Member Data Documentation

mHeader

NTV2_HEADER NTV2SetRegisters::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 7810 of file ntv2publicinterface.h.

mInNumRegisters

ULWord NTV2SetRegisters::mInNumRegisters

The number of NTV2RegInfo's to be set.

Definition at line 7811 of file ntv2publicinterface.h.

mInRegInfos

NTV2Buffer NTV2SetRegisters::mInRegInfos

Read-only array of NTV2RegInfo structs to be set. The SDK owns this memory.

Definition at line 7812 of file ntv2publicinterface.h.

mOutBadRegIndexes

NTV2Buffer NTV2SetRegisters::mOutBadRegIndexes

Array of UWords containing index numbers of the register writes that failed. The SDK owns this memory.

Definition at line 7814 of file ntv2publicinterface.h.

mOutNumFailures

ULWord NTV2SetRegisters::mOutNumFailures

The number of registers unsuccessfully written.

Definition at line 7813 of file ntv2publicinterface.h.

mTrailer

NTV2_TRAILER NTV2SetRegisters::mTrailer

The common structure trailer – ALWAYS LAST!

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