Everything needed to call CNTV2Card::ReadRegister or CNTV2Card::WriteRegister functions. More...

#include <ntv2publicinterface.h>

Public Member Functions
	NTV2RegInfo (const ULWord inRegNum=0, const ULWord inValue=0, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
	Constructs me from the given parameters. More...

void	Set (const ULWord inRegNum, const ULWord inValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
	Sets me from the given parameters. More...

void	MakeInvalid (void)
	Invalidates me, setting my register number, value, mask and shift values to 0xFFFFFFFF. More...

bool	IsValid (void) const

bool	operator== (const NTV2RegInfo &inRHS) const

bool	operator< (const NTV2RegInfo &inRHS) const

std::ostream &	Print (std::ostream &outputStream, const bool inAsCode=false) const
	Renders me to the given output stream in a human-readable format. More...

std::ostream &	PrintCode (std::ostream &outputStream, const int inRadix=16, const NTV2DeviceID inDeviceID=DEVICE_ID_INVALID) const
	Renders me to the given output stream as source code using a "WriteRegister" function call. More...

ULWord	regNum (void) const

ULWord	value (void) const

ULWord	mask (void) const

ULWord	shift (void) const

NTV2RegInfo &	setRegNum (const ULWord val)

NTV2RegInfo &	setValue (const ULWord val)

NTV2RegInfo &	setMask (const ULWord val)

NTV2RegInfo &	setShift (const ULWord val)

Public Attributes
ULWord	registerNumber
	My register number to use in a ReadRegister or WriteRegister call. More...

ULWord	registerValue
	My register value to use in a ReadRegister or WriteRegister call. More...

ULWord	registerMask
	My register mask value to use in a ReadRegister or WriteRegister call. More...

ULWord	registerShift
	My register shift value to use in a ReadRegister or WriteRegister call. More...

Detailed Description

Everything needed to call CNTV2Card::ReadRegister or CNTV2Card::WriteRegister functions.

Definition at line 3977 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2RegInfo()

NTV2RegInfo::NTV2RegInfo	(	const ULWord	inRegNum = `0`,
		const ULWord	inValue = `0`,
		const ULWord	inMask = `0xFFFFFFFF`,
		const ULWord	inShift = `0`
	)

inline

Constructs me from the given parameters.

Parameters

[in]	inRegNum	Specifies the register number to use. If not specified, defaults to zero.
[in]	inValue	Specifies the register value to use. If not specified, defaults to zero.
[in]	inMask	Specifies the bit mask to use. If not specified, defaults to 0xFFFFFFFF.
[in]	inShift	Specifies the shift to use. If not specified, defaults to zero.

Definition at line 3991 of file ntv2publicinterface.h.

Member Function Documentation

◆ IsValid()

bool NTV2RegInfo::IsValid ( void ) const

inline

Returns: True if I'm considered "valid", or false if my register number, value, mask and shift values are all 0xFFFFFFFF.

Definition at line 4019 of file ntv2publicinterface.h.

◆ MakeInvalid()

void NTV2RegInfo::MakeInvalid ( void )

inline

Invalidates me, setting my register number, value, mask and shift values to 0xFFFFFFFF.

Definition at line 4012 of file ntv2publicinterface.h.

◆ mask()

ULWord NTV2RegInfo::mask ( void ) const

inline

Definition at line 4057 of file ntv2publicinterface.h.

◆ operator<()

bool NTV2RegInfo::operator< ( const NTV2RegInfo & inRHS ) const

Returns: True if I'm less than the right-hand-side NTV2RegInfo.

Parameters

[in] inRHS Specifies the right-hand-side NTV2RegInfo that will be compared to me.

Note: To synthesize the other comparison operators (!=, <=, >, >=), in client code, add "#include <utility>", and "using namespace std::rel_ops;".

Definition at line 3386 of file ntv2publicinterface.cpp.

◆ operator==()

bool NTV2RegInfo::operator== ( const NTV2RegInfo & inRHS ) const

inline

Returns: True if I'm identical to the right-hand-side NTV2RegInfo.

Parameters

[in] inRHS Specifies the right-hand-side NTV2RegInfo that will be compared to me.

Note: To synthesize the other comparison operators (!=, <=, >, >=), in client code, add "#include <utility>", and "using namespace std::rel_ops;".

Definition at line 4028 of file ntv2publicinterface.h.

◆ Print()

ostream & NTV2RegInfo::Print	(	std::ostream &	outputStream,
		const bool	inAsCode = `false`
	)		const

Renders me to the given output stream in a human-readable format.

Parameters

outputStream	Specifies the output stream in which to Print my contents.
inAsCode	Deprecated as of SDK 16.0 – use PrintCode instead. Defaults to false. If true, renders me as source code.

Returns: The output stream.

Definition at line 3395 of file ntv2publicinterface.cpp.

◆ PrintCode()

ostream & NTV2RegInfo::PrintCode	(	std::ostream &	outputStream,
		const int	inRadix = `16`,
		const NTV2DeviceID	inDeviceID = `DEVICE_ID_INVALID`
	)		const

Renders me to the given output stream as source code using a "WriteRegister" function call.

Parameters

	outputStream	Specifies the output stream to write into.
[in]	inRadix	Optionally specifies the radix to use for the my register value. Defaults to hexadecimal (base 16).
[in]	inDeviceID	Optionally specifies the NTV2DeviceID for properly interpreting my register values.

Returns: The output stream.

Definition at line 3408 of file ntv2publicinterface.cpp.

◆ regNum()

ULWord NTV2RegInfo::regNum ( void ) const

inline

Definition at line 4055 of file ntv2publicinterface.h.

◆ Set()

void NTV2RegInfo::Set	(	const ULWord	inRegNum,
		const ULWord	inValue,
		const ULWord	inMask = `0xFFFFFFFF`,
		const ULWord	inShift = `0`
	)

inline

Sets me from the given parameters.

Parameters

[in]	inRegNum	Specifies the register number to use.
[in]	inValue	Specifies the register value to use.
[in]	inMask	Specifies the bit mask to use. If not specified, defaults to 0xFFFFFFFF.
[in]	inShift	Specifies the shift to use. If not specified, defaults to zero.

Definition at line 4006 of file ntv2publicinterface.h.

◆ setMask()

NTV2RegInfo& NTV2RegInfo::setMask ( const ULWord val )

inline

Definition at line 4061 of file ntv2publicinterface.h.

◆ setRegNum()

NTV2RegInfo& NTV2RegInfo::setRegNum ( const ULWord val )

inline

Definition at line 4059 of file ntv2publicinterface.h.

◆ setShift()

NTV2RegInfo& NTV2RegInfo::setShift ( const ULWord val )

inline

Definition at line 4062 of file ntv2publicinterface.h.

◆ setValue()

NTV2RegInfo& NTV2RegInfo::setValue ( const ULWord val )

inline

Definition at line 4060 of file ntv2publicinterface.h.

◆ shift()

ULWord NTV2RegInfo::shift ( void ) const

inline

Definition at line 4058 of file ntv2publicinterface.h.

◆ value()

ULWord NTV2RegInfo::value ( void ) const

inline

Definition at line 4056 of file ntv2publicinterface.h.

Member Data Documentation

◆ registerMask

ULWord NTV2RegInfo::registerMask

My register mask value to use in a ReadRegister or WriteRegister call.

Definition at line 3980 of file ntv2publicinterface.h.

◆ registerNumber

ULWord NTV2RegInfo::registerNumber

My register number to use in a ReadRegister or WriteRegister call.

Definition at line 3978 of file ntv2publicinterface.h.

◆ registerShift

ULWord NTV2RegInfo::registerShift

My register shift value to use in a ReadRegister or WriteRegister call.

Definition at line 3981 of file ntv2publicinterface.h.

◆ registerValue

ULWord NTV2RegInfo::registerValue

My register value to use in a ReadRegister or WriteRegister call.

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

Detailed Description

Constructor & Destructor Documentation

◆ NTV2RegInfo()

Member Function Documentation

◆ IsValid()

◆ MakeInvalid()

◆ mask()

◆ operator<()

◆ operator==()

◆ Print()

◆ PrintCode()

◆ regNum()

◆ Set()

◆ setMask()

◆ setRegNum()

◆ setShift()

◆ setValue()

◆ shift()

◆ value()

Member Data Documentation

◆ registerMask

◆ registerNumber

◆ registerShift

◆ registerValue