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...

const std::string &	DeviceSpec (void) const

std::string	MakeDeviceSpec (const bool urlEncodeQuery) const

std::string	MakeQueryString (const bool urlEncode) const

bool	HasDeviceSpec (void) const

bool	Successful (void) const

bool	Failed (void) const

bool	HasScheme (void) const

std::string	Scheme (void) const

bool	IsLocalDevice (void) const

size_t	ErrorCount (void) const

bool	HasErrors (void) const

std::string	Error (const size_t inIndex=0) const

NTV2StringList	Errors (void) const

NTV2ConnectParams	Results (void) const

bool	HasResult (const std::string &inKey) const

std::string	Result (const std::string &inKey) const

std::string	Resource (const bool inStripLeadSlash=true) const

std::string	Host (void) const

std::string	Port (void) const

std::string	HostWithPort (void) 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

const NTV2Dictionary &	QueryParams (void) const

std::string	QueryParam (const std::string &inKey) const

bool	HasQueryParams (void) const

Static Public Member Functions
static bool	ParseQueryParams (const NTV2Dictionary &inSrcDict, NTV2Dictionary &outQueryParams)
	Parses the string found in the given source dictionary's 'query' key (kConnectParamQuery), storing the key/value pairs of all parsed query parameters into "outQueryParams". Query parameter values are URL-decoded before storing in the "outQueryParams" dictionary. More...

static bool	MakeQueryString (const NTV2Dictionary &inSrcDict, std::string &outQueryStr, const bool inLeadQuestion=false)
	Converts the given "query" dictionary into a string suitable for appending onto the query portion a URL. More...

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 171 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 281 of file ntv2nubaccess.cpp.

Member Function Documentation

◆ DeviceID()

NTV2DeviceID NTV2DeviceSpecParser::DeviceID ( void ) const

Definition at line 572 of file ntv2nubaccess.cpp.

◆ DeviceIndex()

UWord NTV2DeviceSpecParser::DeviceIndex ( void ) const

Definition at line 581 of file ntv2nubaccess.cpp.

◆ DeviceModel()

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

inline

Definition at line 200 of file ntv2nubaccess.h.

◆ DeviceSerial()

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

inline

Definition at line 199 of file ntv2nubaccess.h.

◆ DeviceSpec()

const std::string& NTV2DeviceSpecParser::DeviceSpec ( void ) const

inline

Returns: the original devSpec I parsed

Definition at line 176 of file ntv2nubaccess.h.

◆ Error()

std::string NTV2DeviceSpecParser::Error ( const size_t inIndex = 0 ) const

inline

Returns: The Nth error found by parser

Definition at line 187 of file ntv2nubaccess.h.

◆ ErrorCount()

size_t NTV2DeviceSpecParser::ErrorCount ( void ) const

inline

Returns: Number of errors found by parser

Definition at line 185 of file ntv2nubaccess.h.

◆ Errors()

NTV2StringList NTV2DeviceSpecParser::Errors ( void ) const

inline

Returns: All errors found by parser

Definition at line 188 of file ntv2nubaccess.h.

◆ Failed()

bool NTV2DeviceSpecParser::Failed ( void ) const

inline

Returns: True if empty device spec or parser had errors

Definition at line 181 of file ntv2nubaccess.h.

◆ HasDeviceSpec()

bool NTV2DeviceSpecParser::HasDeviceSpec ( void ) const

inline

Returns: True if I have a device specification

Definition at line 179 of file ntv2nubaccess.h.

◆ HasErrors()

bool NTV2DeviceSpecParser::HasErrors ( void ) const

inline

Returns: True if ErrorCount is non-zero

Definition at line 186 of file ntv2nubaccess.h.

◆ HasQueryParams()

bool NTV2DeviceSpecParser::HasQueryParams ( void ) const

inline

Returns: true if has any query params

Definition at line 205 of file ntv2nubaccess.h.

◆ HasResult()

bool NTV2DeviceSpecParser::HasResult ( const std::string & inKey ) const

inline

Returns: True if the given result exists.

Definition at line 190 of file ntv2nubaccess.h.

◆ HasScheme()

bool NTV2DeviceSpecParser::HasScheme ( void ) const

inline

Returns: True if parser results contain a scheme

Definition at line 182 of file ntv2nubaccess.h.

◆ Host()

std::string NTV2DeviceSpecParser::Host ( void ) const

inline

Returns: The host portion of the URLspec, if present, otherwise empty

Definition at line 193 of file ntv2nubaccess.h.

◆ HostWithPort()

string NTV2DeviceSpecParser::HostWithPort ( void ) const

Returns: The host with port number (if present), otherwise empty

Definition at line 309 of file ntv2nubaccess.cpp.

◆ InfoString()

string NTV2DeviceSpecParser::InfoString ( void ) const

Definition at line 565 of file ntv2nubaccess.cpp.

◆ IsLocalDevice()

bool NTV2DeviceSpecParser::IsLocalDevice ( void ) const

inline

Returns: True if parser results indicate a local device

Definition at line 184 of file ntv2nubaccess.h.

◆ MakeDeviceSpec()

string NTV2DeviceSpecParser::MakeDeviceSpec ( const bool urlEncodeQuery ) const

Returns: reconstituted device spec

Definition at line 521 of file ntv2nubaccess.cpp.

◆ MakeQueryString() [1/2]

string NTV2DeviceSpecParser::MakeQueryString ( const bool urlEncode ) const

Returns: reconstituted query string

Definition at line 556 of file ntv2nubaccess.cpp.

◆ MakeQueryString() [2/2]

bool NTV2DeviceSpecParser::MakeQueryString	(	const NTV2Dictionary &	inSrcDict,
		std::string &	outQueryStr,
		const bool	inLeadQuestion = `false`
	)

static

Converts the given "query" dictionary into a string suitable for appending onto the query portion a URL.

Parameters

[in]	inSrcDict	The dictionary that provides the 'query' key/value pairs to convert. It's not an error if it's empty.
[out]	outQueryStr	Receives the string that contains the URL-encoded key/value pairs. This string will be empty if the source dictionary is empty.
[in]	inLeadQuestion	Optionally specifies if the returned query string should begin with '?'. Defaults to false (omitted).

Returns: True if successful; otherwise false.

Definition at line 968 of file ntv2nubaccess.cpp.

◆ ParseQueryParams()

bool NTV2DeviceSpecParser::ParseQueryParams	(	const NTV2Dictionary &	inSrcDict,
		NTV2Dictionary &	outQueryParams
	)

static

Parses the string found in the given source dictionary's 'query' key (kConnectParamQuery), storing the key/value pairs of all parsed query parameters into "outQueryParams". Query parameter values are URL-decoded before storing in the "outQueryParams" dictionary.

Parameters

[in]	inSrcDict	The dictionary that provides the 'query' string to be parsed. It is not an error if it has no 'query' key, or if the query string is empty. The query string need not start with '?'.
[out]	outQueryParams	Dictionary that receives the key/value pairs parsed from the source dictionary's 'query' string. This dictionary is NOT emptied prior to parsing, but will be changed with the parse results.

Returns: True if successful; otherwise false.

Definition at line 932 of file ntv2nubaccess.cpp.

◆ Port()

std::string NTV2DeviceSpecParser::Port ( void ) const

inline

Returns: The port number portion of the URLspec, if present, otherwise empty

Definition at line 194 of file ntv2nubaccess.h.

◆ Print()

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

Definition at line 492 of file ntv2nubaccess.cpp.

◆ PrintErrors()

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

Definition at line 588 of file ntv2nubaccess.cpp.

◆ QueryParam()

std::string NTV2DeviceSpecParser::QueryParam ( const std::string & inKey ) const

inline

Returns: Query parameter value for the given query parameter key (empty string if no such key)

Definition at line 204 of file ntv2nubaccess.h.

◆ QueryParams()

const NTV2Dictionary& NTV2DeviceSpecParser::QueryParams ( void ) const

inline

Returns: True if ErrorCount is non-zero

Definition at line 203 of file ntv2nubaccess.h.

◆ Reset()

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

Resets me, then parses the given device specification.

Definition at line 286 of file ntv2nubaccess.cpp.

◆ Resource()

string NTV2DeviceSpecParser::Resource ( const bool inStripLeadSlash = true ) const

Returns: The Result for the kConnectParamResource key

Definition at line 297 of file ntv2nubaccess.cpp.

◆ Result()

std::string NTV2DeviceSpecParser::Result ( const std::string & inKey ) const

inline

Returns: The result value for the given key.

Definition at line 191 of file ntv2nubaccess.h.

◆ Results()

NTV2ConnectParams NTV2DeviceSpecParser::Results ( void ) const

inline

Returns: A copy of my parse results, a dictionary (of key/value pairs).

Definition at line 189 of file ntv2nubaccess.h.

◆ Scheme()

std::string NTV2DeviceSpecParser::Scheme ( void ) const

inline

Returns: The scheme (or empty if no scheme)

Definition at line 183 of file ntv2nubaccess.h.

◆ Successful()

bool NTV2DeviceSpecParser::Successful ( void ) const

inline

Returns: True if successfully parsed

Definition at line 180 of file ntv2nubaccess.h.

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

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2nubaccess.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2nubaccess.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NTV2DeviceSpecParser()

Member Function Documentation

◆ DeviceID()

◆ DeviceIndex()

◆ DeviceModel()

◆ DeviceSerial()

◆ DeviceSpec()

◆ Error()

◆ ErrorCount()

◆ Errors()

◆ Failed()

◆ HasDeviceSpec()

◆ HasErrors()

◆ HasQueryParams()

◆ HasResult()

◆ HasScheme()

◆ Host()

◆ HostWithPort()

◆ InfoString()

◆ IsLocalDevice()

◆ MakeDeviceSpec()

◆ MakeQueryString() [1/2]

◆ MakeQueryString() [2/2]

◆ ParseQueryParams()

◆ Port()

◆ Print()

◆ PrintErrors()

◆ QueryParam()

◆ QueryParams()

◆ Reset()

◆ Resource()

◆ Result()

◆ Results()

◆ Scheme()

◆ Successful()