NTV2GetRegisters Class Reference

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

#include <ntv2publicinterface.h>

Public Member Functions
	NTV2GetRegisters (const NTV2RegNumSet &inRegisterNumbers=NTV2RegNumSet())
	Constructs an NTV2GetRegisters struct from the given set of register numbers. More...
	NTV2GetRegisters (NTV2RegisterReads &inRegReads)
	Constructs me from the given NTV2RegInfo sequence. More...
bool	ResetUsing (const NTV2RegNumSet &inRegisterNumbers)
	Resets me, starting over, now using the given NTV2RegisterNumberSet. More...
bool	ResetUsing (const NTV2RegisterReads &inRegReads)
	Resets me, starting over, using the given NTV2RegisterReads vector. More...
bool	GetGoodRegisters (NTV2RegNumSet &outGoodRegNums) const
	Returns an NTV2RegNumSet built from my mOutGoodRegisters field. More...
bool	GetRegisterValues (NTV2RegisterValueMap &outValues) const
	Returns an NTV2RegisterValueMap built from my mOutGoodRegisters and mOutValues fields. More...
bool	GetRegisterValues (NTV2RegisterReads &inOutValues) const
	Returns a NTV2RegInfo sequence built from my mOutGoodRegisters and mOutValues fields. More...
bool	GetRequestedRegisterNumbers (NTV2RegNumSet &outRegNums) const
	Answers with the set of register numbers that were requested. More...
bool	GetBadRegisters (NTV2RegNumSet &outBadRegNums) const
	Returns the set of register numbers that were not read successfully. More...
bool	PatchRegister (const ULWord inRegNum, const ULWord inValue)
	Patches the given register value. 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)

Detailed Description

This is used by the CNTV2Card::ReadRegisters function.

Note

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

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

Definition at line 7444 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2GetRegisters() [1/2]

NTV2GetRegisters::NTV2GetRegisters ( const NTV2RegNumSet &  inRegisterNumbers = NTV2RegNumSet() )

explicit

Constructs an NTV2GetRegisters struct from the given set of register numbers.

Parameters

[in]

inRegisterNumbers

A set of distinct NTV2RegisterNumbers to copy into the mRegisters field. If omitted, defaults to an empty set.

Definition at line 3002 of file ntv2publicinterface.cpp.

NTV2GetRegisters() [2/2]

NTV2GetRegisters::NTV2GetRegisters ( NTV2RegisterReads &  inRegReads )

explicit

Constructs me from the given NTV2RegInfo sequence.

Parameters

[in]

inRegReads

An NTV2RegInfo sequence that identifies the register numbers to be read.

Definition at line 3012 of file ntv2publicinterface.cpp.

Member Function Documentation

GetBadRegisters()

bool NTV2GetRegisters::GetBadRegisters

(

NTV2RegNumSet &

outBadRegNums

)

const

Returns the set of register numbers that were not read successfully.

Parameters

[out]

outBadRegNums

Receives the set of "bad" registers.

Returns

True if successful; otherwise false.

Definition at line 3079 of file ntv2publicinterface.cpp.

GetGoodRegisters()

bool NTV2GetRegisters::GetGoodRegisters

(

NTV2RegNumSet &

outGoodRegNums

)

const

Returns an NTV2RegNumSet built from my mOutGoodRegisters field.

Parameters

[out]

outGoodRegNums

Receives the set of "good" registers.

Returns

True if successful; otherwise false.

Definition at line 3062 of file ntv2publicinterface.cpp.

GetRegisterValues() [1/2]

bool NTV2GetRegisters::GetRegisterValues

(

NTV2RegisterReads &

inOutValues

)

const

Returns a NTV2RegInfo sequence built from my mOutGoodRegisters and mOutValues fields.

Parameters

[out]

inOutValues

If empty upon entry, receives all successfully-read register values; otherwise updates only the register values it already contains (if they were requested and successfully read).

Returns

True if successful; otherwise false.

Definition at line 3145 of file ntv2publicinterface.cpp.

GetRegisterValues() [2/2]

bool NTV2GetRegisters::GetRegisterValues

(

NTV2RegisterValueMap &

outValues

)

const

Returns an NTV2RegisterValueMap built from my mOutGoodRegisters and mOutValues fields.

Parameters

[out]

outValues

Receives the register/value map.

Returns

True if successful; otherwise false.

Definition at line 3122 of file ntv2publicinterface.cpp.

GetRequestedRegisterNumbers()

bool NTV2GetRegisters::GetRequestedRegisterNumbers

(

NTV2RegNumSet &

outRegNums

)

const

Answers with the set of register numbers that were requested.

Parameters

[out]

outRegNums

Receives the set of unique register numbers.

Returns

True if successful; otherwise false.

Definition at line 3044 of file ntv2publicinterface.cpp.

operator NTV2_HEADER *()

NTV2GetRegisters::operator NTV2_HEADER * ( )

inline

Returns

My address casted to an NTV2_HEADER pointer.

Definition at line 7537 of file ntv2publicinterface.h.

PatchRegister()

bool NTV2GetRegisters::PatchRegister	(	const ULWord	inRegNum,
		const ULWord	inValue
	)

Patches the given register value.

Parameters

[in]	inRegNum	Specifies the register to be patched.
[in]	inValue	Specifies the new value.

Returns

True if successful; otherwise false.

Definition at line 3098 of file ntv2publicinterface.cpp.

Print()

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

ResetUsing() [1/2]

bool NTV2GetRegisters::ResetUsing ( const NTV2RegisterReads &  inRegReads )

inline

Resets me, starting over, using the given NTV2RegisterReads vector.

Parameters

[in]

inRegReads

A vector of NTV2RegInfo values to use for my mInRegisters field.

Note

The mask and shift fields of the NTV2RegInfo values are ignored.

Definition at line 7480 of file ntv2publicinterface.h.

ResetUsing() [2/2]

bool NTV2GetRegisters::ResetUsing

(

const NTV2RegNumSet &

inRegisterNumbers

)

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

Parameters

[in]

inRegisterNumbers

A set of distinct NTV2RegisterNumbers to copy into my mInRegisters field.

Definition at line 3022 of file ntv2publicinterface.cpp.

RPCDecode()

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

Definition at line 3638 of file ntv2publicinterface.cpp.

RPCEncode()

bool NTV2GetRegisters::RPCEncode

(

NTV2_RPC_BLOB_TYPE &

outBlob

)

Definition at line 3610 of file ntv2publicinterface.cpp.

---

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