AJA NTV2 SDK  17.5.0.1492
NTV2 SDK 17.5.0.1492
Classes | Public Member Functions | Static Public Member Functions | List of all members
RegisterExpert Class Reference

Public Member Functions

 ~RegisterExpert ()
 
string RegNameToString (const uint32_t inRegNum) const
 
string RegValueToString (const uint32_t inRegNum, const uint32_t inRegValue, const NTV2DeviceID inDeviceID) const
 
bool IsRegInClass (const uint32_t inRegNum, const string &inClassName) const
 
bool IsRegisterWriteOnly (const uint32_t inRegNum) const
 
bool IsRegisterReadOnly (const uint32_t inRegNum) const
 
NTV2StringSet GetAllRegisterClasses (void) const
 
NTV2StringSet GetRegisterClasses (const uint32_t inRegNum, const bool inRemovePrefix) const
 
NTV2RegNumSet GetRegistersForClass (const string &inClassName) const
 
NTV2RegNumSet GetRegistersForDevice (const NTV2DeviceID inDeviceID, const int inOtherRegsToInclude) const
 
NTV2RegNumSet GetRegistersWithName (const string &inName, const int inMatchStyle=EXACTMATCH) const
 
bool GetXptRegNumAndMaskIndex (const NTV2InputCrosspointID inInputXpt, uint32_t &outXptRegNum, uint32_t &outMaskIndex) const
 
NTV2InputCrosspointID GetInputCrosspointID (const uint32_t inXptRegNum, const uint32_t inMaskIndex) const
 
ostream & Print (ostream &inOutStream) const
 

Static Public Member Functions

static RegisterExpertPtr GetInstance (const bool inCreateIfNecessary=true)
 
static bool DisposeInstance (void)
 
static ostream & PrintLabelValuePairs (ostream &oss, const AJALabelValuePairs &inLabelValuePairs)
 

Detailed Description

I'm the the root source of register information. I provide answers to the public-facing CNTV2RegisterExpert class. There's only one instance of me. TODO: Need to handle multi-register sparse bits. Search for MULTIREG_SPARSE_BITS – it's where we need to improve how we present related information that's stored in more than one register.

Definition at line 122 of file ntv2registerexpert.cpp.

Constructor & Destructor Documentation

◆ ~RegisterExpert()

RegisterExpert::~RegisterExpert ( )
inline

Definition at line 170 of file ntv2registerexpert.cpp.

Member Function Documentation

◆ DisposeInstance()

bool RegisterExpert::DisposeInstance ( void  )
static

Definition at line 4621 of file ntv2registerexpert.cpp.

◆ GetAllRegisterClasses()

NTV2StringSet RegisterExpert::GetAllRegisterClasses ( void  ) const
inline

Definition at line 1803 of file ntv2registerexpert.cpp.

◆ GetInputCrosspointID()

NTV2InputCrosspointID RegisterExpert::GetInputCrosspointID ( const uint32_t  inXptRegNum,
const uint32_t  inMaskIndex 
) const
inline

Definition at line 2066 of file ntv2registerexpert.cpp.

◆ GetInstance()

RegisterExpertPtr RegisterExpert::GetInstance ( const bool  inCreateIfNecessary = true)
static

Definition at line 4613 of file ntv2registerexpert.cpp.

◆ GetRegisterClasses()

NTV2StringSet RegisterExpert::GetRegisterClasses ( const uint32_t  inRegNum,
const bool  inRemovePrefix 
) const
inline

Definition at line 1813 of file ntv2registerexpert.cpp.

◆ GetRegistersForClass()

NTV2RegNumSet RegisterExpert::GetRegistersForClass ( const string &  inClassName) const
inline

Definition at line 1830 of file ntv2registerexpert.cpp.

◆ GetRegistersForDevice()

NTV2RegNumSet RegisterExpert::GetRegistersForDevice ( const NTV2DeviceID  inDeviceID,
const int  inOtherRegsToInclude 
) const
inline

Definition at line 1840 of file ntv2registerexpert.cpp.

◆ GetRegistersWithName()

NTV2RegNumSet RegisterExpert::GetRegistersWithName ( const string &  inName,
const int  inMatchStyle = EXACTMATCH 
) const
inline

Definition at line 2018 of file ntv2registerexpert.cpp.

◆ GetXptRegNumAndMaskIndex()

bool RegisterExpert::GetXptRegNumAndMaskIndex ( const NTV2InputCrosspointID  inInputXpt,
uint32_t &  outXptRegNum,
uint32_t &  outMaskIndex 
) const
inline

Definition at line 2053 of file ntv2registerexpert.cpp.

◆ IsRegInClass()

bool RegisterExpert::IsRegInClass ( const uint32_t  inRegNum,
const string &  inClassName 
) const
inline

Definition at line 1791 of file ntv2registerexpert.cpp.

◆ IsRegisterReadOnly()

bool RegisterExpert::IsRegisterReadOnly ( const uint32_t  inRegNum) const
inline

Definition at line 1801 of file ntv2registerexpert.cpp.

◆ IsRegisterWriteOnly()

bool RegisterExpert::IsRegisterWriteOnly ( const uint32_t  inRegNum) const
inline

Definition at line 1800 of file ntv2registerexpert.cpp.

◆ Print()

ostream& RegisterExpert::Print ( ostream &  inOutStream) const
inline

Definition at line 2076 of file ntv2registerexpert.cpp.

◆ PrintLabelValuePairs()

static ostream& RegisterExpert::PrintLabelValuePairs ( ostream &  oss,
const AJALabelValuePairs &  inLabelValuePairs 
)
inlinestatic

Definition at line 1741 of file ntv2registerexpert.cpp.

◆ RegNameToString()

string RegisterExpert::RegNameToString ( const uint32_t  inRegNum) const
inline

Definition at line 1761 of file ntv2registerexpert.cpp.

◆ RegValueToString()

string RegisterExpert::RegValueToString ( const uint32_t  inRegNum,
const uint32_t  inRegValue,
const NTV2DeviceID  inDeviceID 
) const
inline

Definition at line 1778 of file ntv2registerexpert.cpp.

The documentation for this class was generated from the following file: