AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
Public Member Functions | Static Public Member Functions | List of all members
NTV2DeviceSpecParser Class Reference

One-stop shop for parsing device specifications. (New in SDK 16.3) I do very little in the way of validating semantics. I simply do the parsing & provide the info needed to load & operate plugins. More...

#include <ntv2nubaccess.h>

Public Member Functions

 NTV2DeviceSpecParser (const std::string inSpec="")
 My constructor. If given device specification is non-empty, proceeds to Parse it. More...
 
void Reset (const std::string inSpec="")
 Resets me, then parses the given device specification. More...
 
std::string Resource (const bool inStripLeadSlash=true) const
 
std::ostream & PrintErrors (std::ostream &oss) const
 
std::ostream & Print (std::ostream &oss, const bool inDumpResults=false) const
 
std::string InfoString (void) const
 
std::string DeviceSerial (void) const
 
std::string DeviceModel (void) const
 
NTV2DeviceID DeviceID (void) const
 
UWord DeviceIndex (void) const
 

Static Public Member Functions

static bool IsSupportedScheme (const std::string &inScheme)
 

Detailed Description

One-stop shop for parsing device specifications. (New in SDK 16.3) I do very little in the way of validating semantics. I simply do the parsing & provide the info needed to load & operate plugins.

Note
Not thread-safe.

Definition at line 146 of file ntv2nubaccess.h.

Constructor & Destructor Documentation

◆ NTV2DeviceSpecParser()

NTV2DeviceSpecParser::NTV2DeviceSpecParser ( const std::string  inSpec = "")

My constructor. If given device specification is non-empty, proceeds to Parse it.

Definition at line 272 of file ntv2nubaccess.cpp.

Member Function Documentation

◆ DeviceID()

NTV2DeviceID NTV2DeviceSpecParser::DeviceID ( void  ) const

Definition at line 469 of file ntv2nubaccess.cpp.

◆ DeviceIndex()

UWord NTV2DeviceSpecParser::DeviceIndex ( void  ) const

Definition at line 478 of file ntv2nubaccess.cpp.

◆ DeviceModel()

std::string NTV2DeviceSpecParser::DeviceModel ( void  ) const
inline

Definition at line 173 of file ntv2nubaccess.h.

◆ DeviceSerial()

std::string NTV2DeviceSpecParser::DeviceSerial ( void  ) const
inline

Definition at line 172 of file ntv2nubaccess.h.

◆ InfoString()

string NTV2DeviceSpecParser::InfoString ( void  ) const

Definition at line 462 of file ntv2nubaccess.cpp.

◆ IsSupportedScheme()

bool NTV2DeviceSpecParser::IsSupportedScheme ( const std::string &  inScheme)
static
Returns
True if the given scheme starts with "ntv2"

Definition at line 810 of file ntv2nubaccess.cpp.

◆ Print()

ostream & NTV2DeviceSpecParser::Print ( std::ostream &  oss,
const bool  inDumpResults = false 
) const

Definition at line 433 of file ntv2nubaccess.cpp.

◆ PrintErrors()

ostream & NTV2DeviceSpecParser::PrintErrors ( std::ostream &  oss) const

Definition at line 485 of file ntv2nubaccess.cpp.

◆ Reset()

void NTV2DeviceSpecParser::Reset ( const std::string  inSpec = "")

Resets me, then parses the given device specification.

Definition at line 277 of file ntv2nubaccess.cpp.

◆ Resource()

string NTV2DeviceSpecParser::Resource ( const bool  inStripLeadSlash = true) const
Returns
The Result for the kConnectParamResource key

Definition at line 288 of file ntv2nubaccess.cpp.

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