AJA NTV2 SDK  17.1.3.1410
NTV2 SDK 17.1.3.1410
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CNTV2MailBox Class Reference

#include <ntv2mailbox.h>

Inheritance diagram for CNTV2MailBox:
[legend]
Collaboration diagram for CNTV2MailBox:
[legend]

Public Member Functions

 CNTV2MailBox (CNTV2Card &device)
 
 ~CNTV2MailBox ()
 
bool sendMsg (char *msg, uint32_t timeout)
 
bool sendMsg (uint32_t timeout)
 
void getError (std::string &error)
 
void getResponse (std::string &response)
 
bool WriteChannelRegister (ULWord reg, ULWord value, ULWord mask=0xFFFFFFFF, ULWord shift=0x0)
 
bool ReadChannelRegister (const ULWord inReg, ULWord &outValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0x0)
 
bool ReadChannelRegister (ULWord inReg, ULWord *pOutValue, ULWord mask=0xFFFFFFFF, ULWord shift=0x0)
 
void SetChannel (ULWord channelOffset, ULWord channelNumber)
 
bool AcquireMailbox ()
 
void ReleaseMailbox ()
 

Protected Member Functions

bool rcvMsg (uint32_t timeout)
 
bool writeMB (uint32_t val, uint32_t timeout=50)
 
bool readMB (uint32_t &val, uint32_t timeout=50)
 
bool waitSOM (uint32_t timeout)
 
bool waitRxReady (uint32_t timeout)
 
bool waitTxReady (uint32_t timeout)
 
bool rxReady ()
 
uint32_t getStatus ()
 
uint32_t getFeatures ()
 

Protected Attributes

CNTV2Card & mDevice
 
NTV2IpError mIpErrorCode
 
std::string mIpInternalErrorString
 
uint32_t txBuf [1024+1]
 

Detailed Description

Definition at line 42 of file ntv2mailbox.h.

Constructor & Destructor Documentation

◆ CNTV2MailBox()

CNTV2MailBox::CNTV2MailBox ( CNTV2Card &  device)

Definition at line 44 of file ntv2mailbox.cpp.

◆ ~CNTV2MailBox()

CNTV2MailBox::~CNTV2MailBox ( )

Definition at line 55 of file ntv2mailbox.cpp.

Member Function Documentation

◆ AcquireMailbox()

bool CNTV2MailBox::AcquireMailbox ( )

Definition at line 270 of file ntv2mailbox.cpp.

◆ getError()

void CNTV2MailBox::getError ( std::string &  error)

Definition at line 257 of file ntv2mailbox.cpp.

◆ getFeatures()

uint32_t CNTV2MailBox::getFeatures ( )
protected

Definition at line 406 of file ntv2mailbox.cpp.

◆ getResponse()

void CNTV2MailBox::getResponse ( std::string &  response)

Definition at line 301 of file ntv2mailbox.cpp.

◆ getStatus()

uint32_t CNTV2MailBox::getStatus ( )
protected

Definition at line 230 of file ntv2mailbox.cpp.

◆ rcvMsg()

bool CNTV2MailBox::rcvMsg ( uint32_t  timeout)
protected

Definition at line 102 of file ntv2mailbox.cpp.

◆ ReadChannelRegister() [1/2]

bool CNTV2MailBox::ReadChannelRegister ( const ULWord  inReg,
ULWord &  outValue,
const ULWord  inMask = 0xFFFFFFFF,
const ULWord  inShift = 0x0 
)

Definition at line 237 of file ntv2mailbox.cpp.

◆ ReadChannelRegister() [2/2]

bool CNTV2MailBox::ReadChannelRegister ( ULWord  inReg,
ULWord *  pOutValue,
ULWord  mask = 0xFFFFFFFF,
ULWord  shift = 0x0 
)
inline

Definition at line 57 of file ntv2mailbox.h.

◆ readMB()

bool CNTV2MailBox::readMB ( uint32_t &  val,
uint32_t  timeout = 50 
)
protected

Definition at line 173 of file ntv2mailbox.cpp.

◆ ReleaseMailbox()

void CNTV2MailBox::ReleaseMailbox ( )

Definition at line 291 of file ntv2mailbox.cpp.

◆ rxReady()

bool CNTV2MailBox::rxReady ( )
protected

Definition at line 198 of file ntv2mailbox.cpp.

◆ sendMsg() [1/2]

bool CNTV2MailBox::sendMsg ( char *  msg,
uint32_t  timeout 
)

Definition at line 94 of file ntv2mailbox.cpp.

◆ sendMsg() [2/2]

bool CNTV2MailBox::sendMsg ( uint32_t  timeout)

Definition at line 59 of file ntv2mailbox.cpp.

◆ SetChannel()

void CNTV2MailBox::SetChannel ( ULWord  channelOffset,
ULWord  channelNumber 
)

Definition at line 251 of file ntv2mailbox.cpp.

◆ waitRxReady()

bool CNTV2MailBox::waitRxReady ( uint32_t  timeout)
protected

Definition at line 204 of file ntv2mailbox.cpp.

◆ waitSOM()

bool CNTV2MailBox::waitSOM ( uint32_t  timeout)
protected

Definition at line 183 of file ntv2mailbox.cpp.

◆ waitTxReady()

bool CNTV2MailBox::waitTxReady ( uint32_t  timeout)
protected

Definition at line 217 of file ntv2mailbox.cpp.

◆ WriteChannelRegister()

bool CNTV2MailBox::WriteChannelRegister ( ULWord  reg,
ULWord  value,
ULWord  mask = 0xFFFFFFFF,
ULWord  shift = 0x0 
)

Definition at line 246 of file ntv2mailbox.cpp.

◆ writeMB()

bool CNTV2MailBox::writeMB ( uint32_t  val,
uint32_t  timeout = 50 
)
protected

Definition at line 163 of file ntv2mailbox.cpp.

Member Data Documentation

◆ mDevice

CNTV2Card& CNTV2MailBox::mDevice
protected

Definition at line 79 of file ntv2mailbox.h.

◆ mIpErrorCode

NTV2IpError CNTV2MailBox::mIpErrorCode
protected

Definition at line 81 of file ntv2mailbox.h.

◆ mIpInternalErrorString

std::string CNTV2MailBox::mIpInternalErrorString
protected

Definition at line 82 of file ntv2mailbox.h.

◆ txBuf

uint32_t CNTV2MailBox::txBuf[1024+1]
protected

Definition at line 100 of file ntv2mailbox.h.

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