NTV2BankSelGetSetRegs Class Reference

This is used to atomically perform bank-selected register reads or writes. More...

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2BankSelGetSetRegs:

Public Member Functions
	NTV2BankSelGetSetRegs (const NTV2RegInfo &inBankSelect, const NTV2RegInfo &inRegInfo, const bool inDoWrite=false)
	Constructs an NTV2BankSelGetSetRegs struct for atomically reading or writing the given bank-selected register. More...
NTV2RegInfo	GetRegInfo (const UWord inIndex0=0) const
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)
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	mIsWriting
	If non-zero, register(s) will be written; otherwise, register(s) will be read. More...
NTV2Buffer	mInBankInfos
	Bank select NTV2RegInfo. The SDK owns this memory. More...
NTV2Buffer	mInRegInfos
	NTV2RegInfo array of registers be read/written. The SDK owns this memory. More...
NTV2_TRAILER	mTrailer
	The common structure trailer – ALWAYS LAST! More...

Detailed Description

This is used to atomically perform bank-selected register 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 7862 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2BankSelGetSetRegs()

NTV2BankSelGetSetRegs::NTV2BankSelGetSetRegs ( const NTV2RegInfo &  inBankSelect, const NTV2RegInfo &  inRegInfo, const bool  inDoWrite = false  )

explicit

Constructs an NTV2BankSelGetSetRegs struct for atomically reading or writing the given bank-selected register.

Parameters

[in]	inBankSelect	The bank select register info.
[in]	inRegInfo	The register info of the register to be read or written.
[in]	inDoWrite	Specify 'true' to write the register value; otherwise use 'false'. Defaults to 'false'.

Definition at line 3676 of file ntv2publicinterface.cpp.

Member Function Documentation

GetRegInfo()

NTV2RegInfo NTV2BankSelGetSetRegs::GetRegInfo

(

const UWord

inIndex0 = 0

)

const

Returns

The NTV2RegInfo at the given zero-based index position.

Parameters

inIndex0

Specifies the zero-based index of the NTV2RegInfo to retrieve from my array.

Definition at line 3692 of file ntv2publicinterface.cpp.

operator NTV2_HEADER *()

NTV2BankSelGetSetRegs::operator NTV2_HEADER * ( )

inline

Returns

My address casted to an NTV2_HEADER pointer.

Definition at line 7894 of file ntv2publicinterface.h.

Print()

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

RPCDecode()

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

Definition at line 3979 of file ntv2publicinterface.cpp.

RPCDecodeClient()

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

RPCDecodeServer()

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

RPCEncode()

bool NTV2BankSelGetSetRegs::RPCEncode

(

NTV2_RPC_BLOB_TYPE &

outBlob

)

Definition at line 3955 of file ntv2publicinterface.cpp.

RPCEncodeClient()

bool NTV2BankSelGetSetRegs::RPCEncodeClient

(

NTV2_RPC_BLOB_TYPE &

inBlob

)

RPCEncodeServer()

bool NTV2BankSelGetSetRegs::RPCEncodeServer

(

NTV2_RPC_BLOB_TYPE &

inBlob

)

Member Data Documentation

mHeader

NTV2_HEADER NTV2BankSelGetSetRegs::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 7863 of file ntv2publicinterface.h.

mInBankInfos

NTV2Buffer NTV2BankSelGetSetRegs::mInBankInfos

Bank select NTV2RegInfo. The SDK owns this memory.

Definition at line 7865 of file ntv2publicinterface.h.

mInRegInfos

NTV2Buffer NTV2BankSelGetSetRegs::mInRegInfos

NTV2RegInfo array of registers be read/written. The SDK owns this memory.

Definition at line 7866 of file ntv2publicinterface.h.

mIsWriting

ULWord NTV2BankSelGetSetRegs::mIsWriting

If non-zero, register(s) will be written; otherwise, register(s) will be read.

Definition at line 7864 of file ntv2publicinterface.h.

mTrailer

NTV2_TRAILER NTV2BankSelGetSetRegs::mTrailer

The common structure trailer – ALWAYS LAST!

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