This class is a collection of widget input-to-output connections that can be applied all-at-once to an NTV2 device. Call AddConnection to connect a widget input (specified by NTV2InputXptID) to a widget's output (specified by NTV2OutputXptID). Call the CNTV2Card::ApplySignalRoute function to apply this route to the device. More...

#include <ntv2signalrouter.h>

Classes
struct	PrintCodeConfig

Public Member Functions
virtual bool	AddConnection (const NTV2InputXptID inSignalInput, const NTV2OutputXptID inSignalOutput=NTV2_XptBlack)
	Adds a connection between a widget's signal input (sink) and another widget's signal output (source). More...

virtual bool	RemoveConnection (const NTV2InputXptID inSignalInput, const NTV2OutputXptID inSignalOutput)
	Removes the connection between the specified input (signal sink) and output (signal source). More...

virtual bool	HasConnection (const NTV2InputXptID inSignalInput, const NTV2OutputXptID inSignalOutput) const
	Answers true if I contain a connection between the specified input (signal sink) and output (signal source). More...

virtual bool	HasInput (const NTV2InputXptID inSignalInput) const
	Answers true if I contain a connection that involves the given input (signal sink). More...

virtual NTV2OutputXptID	GetConnectedOutput (const NTV2InputXptID inSignalInput) const

virtual void	Reset (void)
	Resets me, erasing any/all existing connections. More...

virtual bool	ResetFromRegisters (const NTV2InputXptIDSet &inInputXpts, const NTV2RegisterReads &inRegReads)
	Resets me, erasing any/all existing connections, then rebuilding my connections from the given register values. More...

virtual bool	ResetFrom (const NTV2XptConnections &inConnections)
	Resets me, replacing any/all existing connections with the given connections. More...

virtual ULWord	GetNumberOfConnections (void) const

virtual bool	IsEmpty (void) const

virtual NTV2XptConnections	GetConnections (void) const

virtual bool	GetRegisterWrites (NTV2RegisterWrites &outRegWrites) const
	Returns a sequence of NTV2RegInfo values that can be written to an NTV2 device using its WriteRegisters function. More...

virtual bool	Compare (const CNTV2SignalRouter &inRHS, NTV2XptConnections &outNew, NTV2XptConnections &outChanged, NTV2XptConnections &outMissing) const
	Compares me with another routing, and returns three connection mappings as a result of the comparison: those that are new, changed, and missing. More...

virtual bool	operator== (const CNTV2SignalRouter &inRHS) const

virtual bool	operator!= (const CNTV2SignalRouter &inRHS) const

virtual std::ostream &	Print (std::ostream &inOutStream, const bool inForRetailDisplay=false) const
	Prints me in a human-readable format to the given output stream. More...

virtual bool	PrintCode (std::string &outCode, const PrintCodeConfig &inConfig=PrintCodeConfig()) const
	Prints me as source code to the given output stream. More...

Static Public Member Functions
static bool	GetRouteROMInfoFromReg (const ULWord inROMRegNum, const ULWord inROMRegValue, NTV2InputXptID &outInputXpt, NTV2OutputXptIDSet &outOutputXpts, const bool inAppendOutputXpts=false)
	Answers with the NTV2InputXptID and NTV2OutputXptIDSet for the given ROM register value. More...

static bool	GetPossibleConnections (const NTV2RegReads &inROMRegisters, NTV2PossibleConnections &outConnections)
	Answers with the implemented crosspoint connections as obtained from the given ROM registers. More...

static bool	MakeRouteROMRegisters (NTV2RegReads &outROMRegisters)
	Prepares an initialized, zeroed NTV2RegReads that's prepared to read all ROM registers from a device. More...

static std::string	NTV2InputCrosspointIDToString (const NTV2InputXptID inInputXpt)
	Returns a string containing the most compact human-readable form for a given input crosspoint. More...

static std::string	NTV2OutputCrosspointIDToString (const NTV2OutputXptID inOutputXpt)
	Returns a string containing the most compact human-readable form for a given output crosspoint. More...

static NTV2InputXptID	StringToNTV2InputCrosspointID (const std::string &inStr)
	Returns a string containing the most compact human-readable form for a given input crosspoint. More...

static NTV2OutputXptID	StringToNTV2OutputCrosspointID (const std::string &inStr)
	Returns the output crosspoint that corresponds to the given string. More...

static bool	GetWidgetIDs (const NTV2DeviceID inDeviceID, NTV2WidgetIDSet &outWidgets)
	Returns the widget IDs supported by the given device. More...

static bool	GetWidgetsForOutput (const NTV2OutputXptID inOutputXpt, NTV2WidgetIDSet &outWidgetIDs)
	Returns the widgets that "own" the specified output crosspoint. More...

static bool	GetWidgetForOutput (const NTV2OutputXptID inOutputXpt, NTV2WidgetID &outWidgetID, const NTV2DeviceID inDeviceID=DEVICE_ID_NOTFOUND)
	Returns the widget that "owns" the specified output crosspoint. More...

static bool	GetWidgetsForInput (const NTV2InputXptID inInputXpt, NTV2WidgetIDSet &outWidgetIDs)
	Returns the widgets that "own" the specified input crosspoint. More...

static bool	GetWidgetForInput (const NTV2InputXptID inInputXpt, NTV2WidgetID &outWidgetID, const NTV2DeviceID inDeviceID=DEVICE_ID_NOTFOUND)
	Returns the widget that "owns" the specified input crosspoint. More...

static bool	GetWidgetInputs (const NTV2WidgetID inWidgetID, NTV2InputXptIDSet &outInputs)
	Returns the input crosspoints known to be "owned" by the given widget. More...

static bool	GetAllWidgetInputs (const NTV2DeviceID inDeviceID, NTV2InputXptIDSet &outInputs)
	Returns all known widget input crosspoints for the given device. More...

static bool	GetAllRoutingRegInfos (const NTV2InputXptIDSet &inInputs, NTV2RegisterWrites &outRegInfos)
	Returns all routing registers for the given set of input crosspoints. More...

static bool	GetWidgetOutputs (const NTV2WidgetID inWidgetID, NTV2OutputXptIDSet &outOutputs)
	Returns the output crosspoints known to be "owned" by the given widget. More...

static bool	GetConnectionsFromRegs (const NTV2InputXptIDSet &inInputXptIDs, const NTV2RegisterReads &inRegValues, NTV2XptConnections &outConnections)
	Converts a set of crosspoint registers into a set of crosspoint connections. More...

static bool	IsRGBOnlyInputXpt (const NTV2InputXptID inInputXpt)

static bool	IsYUVOnlyInputXpt (const NTV2InputXptID inInputXpt)

static bool	IsKeyInputXpt (const NTV2InputXptID inInputXpt)

static NTV2Channel	WidgetIDToChannel (const NTV2WidgetID inWidgetID)

static NTV2WidgetID	WidgetIDFromTypeAndChannel (const NTV2WidgetType inWidgetType, const NTV2Channel inChannel)

static NTV2WidgetType	WidgetIDToType (const NTV2WidgetID inWidgetID)

static bool	IsSDIWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsSDIInputWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsSDIOutputWidgetType (const NTV2WidgetType inWidgetType)

static bool	Is3GSDIWidgetType (const NTV2WidgetType inWidgetType)

static bool	Is12GSDIWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsDualLinkWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsDualLinkInWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsDualLinkOutWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsHDMIWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsHDMIInWidgetType (const NTV2WidgetType inWidgetType)

static bool	IsHDMIOutWidgetType (const NTV2WidgetType inWidgetType)

static bool	CompareConnections (const NTV2XptConnections &inLHS, const NTV2XptConnections &inRHS, NTV2XptConnections &outNew, NTV2XptConnections &outRemoved)
	Compares two sets of crosspoint connections. More...

static bool	CreateFromString (const std::string &inString, NTV2XptConnections &outConnections)
	Decodes a given string into a map of crosspoint connections. More...

static bool	CreateFromString (const std::string &inString, CNTV2SignalRouter &outRouter)
	Sets the router from the given string. More...

static bool	ToCodeString (std::string &outCode, const NTV2XptConnections &inConnections, const PrintCodeConfig &inConfig=PrintCodeConfig())
	Converts the given map of crosspoint connections into source code. More...

static bool	IsInitialized (void)

static bool	Initialize (void)
	Explicitly allocates and initializes the Routing Expert singleton. More...

static bool	Deinitialize (void)
	Explicitly deinitializes and deallocates the Routing Expert singleton. More...

Detailed Description

This class is a collection of widget input-to-output connections that can be applied all-at-once to an NTV2 device. Call AddConnection to connect a widget input (specified by NTV2InputXptID) to a widget's output (specified by NTV2OutputXptID). Call the CNTV2Card::ApplySignalRoute function to apply this route to the device.

Note: Use of this class is optional, as widget signal routing can always be performed using direct calls to CNTV2Card::Connect.; This class is not thread-safe.; Public access to the NTV2RoutingEntry structs are deprecated. Please use NTV2InputXptID instead.

See also: Widget Signal Routing

Definition at line 55 of file ntv2signalrouter.h.

Member Function Documentation

◆ AddConnection()

bool CNTV2SignalRouter::AddConnection	(	const NTV2InputXptID	inSignalInput,
		const NTV2OutputXptID	inSignalOutput = `NTV2_XptBlack`
	)

virtual

Adds a connection between a widget's signal input (sink) and another widget's signal output (source).

Parameters

[in]	inSignalInput	Specifies the widget signal input (sink) as an NTV2InputXptID.
[in]	inSignalOutput	Specifies the widget signal output (source) as an NTV2OutputXptID. If not specified, uses NTV2_XptBlack.

Returns: True if successfully added; otherwise false.

See also: CNTV2Card::Connect, CNTV2SignalRouter::RemoveConnection

Definition at line 62 of file ntv2signalrouter.cpp.

◆ Compare()

bool CNTV2SignalRouter::Compare	(	const CNTV2SignalRouter &	inRHS,
		NTV2XptConnections &	outNew,
		NTV2XptConnections &	outChanged,
		NTV2XptConnections &	outMissing
	)		const

virtual

Compares me with another routing, and returns three connection mappings as a result of the comparison: those that are new, changed, and missing.

Parameters

[in]	inRHS	The CNTV2SignalRouter that I'm being compared with.
[out]	outNew	Receives the new connections (those that I have, but RHS doesn't).
[out]	outChanged	Receives the changed connections, where only the output crosspoint changed. The output crosspoint of these changed connections will be those from "inRHS" – not the new ones.
[out]	outMissing	Receives the deleted connections (those that RHS has, but I don't).

Returns: True if identical (i.e. the returned output connection maps are all empty); otherwise false.

See also: CNTV2SignalRouter::operator ==, CNTV2SignalRouter::operator !=

Definition at line 164 of file ntv2signalrouter.cpp.

◆ CompareConnections()

bool CNTV2SignalRouter::CompareConnections	(	const NTV2XptConnections &	inLHS,
		const NTV2XptConnections &	inRHS,
		NTV2XptConnections &	outNew,
		NTV2XptConnections &	outRemoved
	)

static

Compares two sets of crosspoint connections.

Parameters

[in]	inLHS	Specifies the input crosspoints.
[in]	inRHS	Specifies the crosspoint register values.
[out]	outNew	Receives the new connections found in the RHS that aren't in the LHS.
[out]	outRemoved	Receives the deleted connections not found in the RHS that are in the LHS.

Returns: True if successful; otherwise false.

Definition at line 632 of file ntv2signalrouter.cpp.

◆ CreateFromString() [1/2]

static bool CNTV2SignalRouter::CreateFromString	(	const std::string &	inString,
		CNTV2SignalRouter &	outRouter
	)

static

Sets the router from the given string.

Parameters

[in]	inString	Specifies the string to be parsed.
[out]	outRouter	The CNTV2SignalRouter to be cleared and set from what is parsed from the string. It will be empty if this function fails.

Returns: True if successful; otherwise false.

See also: CNTV2SignalRouter::PrintCode, CNTV2SignalRouter::ResetFromRegisters

◆ CreateFromString() [2/2]

static bool CNTV2SignalRouter::CreateFromString	(	const std::string &	inString,
		NTV2XptConnections &	outConnections
	)

static

Decodes a given string into a map of crosspoint connections.

Parameters

[in]	inString	Specifies the string to be parsed. It can contain the pnemonics that CNTV2SignalRouter::PrintCode generates, or a simple C++ code snippet that contains one or more "device.Connect(...)" calls.
[out]	outConnections	Receives the connections from what is successfully parsed from the string. It will be empty if this function fails.

Returns: True if successful; otherwise false.

◆ Deinitialize()

bool CNTV2SignalRouter::Deinitialize ( void )

static

Explicitly deinitializes and deallocates the Routing Expert singleton.

Returns: True if successful; otherwise false.

Note: Normally, there is no need to call this function, as the Routing Expert singleton is automatically deinitialized and deallocated.

See also: CNTV2SignalRouter::Initialize

Definition at line 333 of file ntv2signalrouter.cpp.

◆ GetAllRoutingRegInfos()

bool CNTV2SignalRouter::GetAllRoutingRegInfos	(	const NTV2InputXptIDSet &	inInputs,
		NTV2RegisterWrites &	outRegInfos
	)

static

Returns all routing registers for the given set of input crosspoints.

Parameters

[in]	inInputs	Specifies the input crosspoints.
[out]	outRegInfos	Receives the NTV2RegInfo collection (empty upon failure).

Returns: True if successful; otherwise false.

Definition at line 473 of file ntv2signalrouter.cpp.

◆ GetAllWidgetInputs()

bool CNTV2SignalRouter::GetAllWidgetInputs	(	const NTV2DeviceID	inDeviceID,
		NTV2InputXptIDSet &	outInputs
	)

static

Returns all known widget input crosspoints for the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest.
[out]	outInputs	Receives the NTV2InputXptIDSet (or empty upon failure).

Returns: True if successful; otherwise false.

Definition at line 456 of file ntv2signalrouter.cpp.

◆ GetConnectedOutput()

NTV2OutputXptID CNTV2SignalRouter::GetConnectedOutput ( const NTV2InputXptID inSignalInput ) const

virtual

Returns: The output crosspoint that the given input is connected to, or NTV2_XptBlack if not connected.

Parameters

[in] inSignalInput Specifies the widget signal input (sink) of interest.

See also: CNTV2Card::GetConnectedOutput

Definition at line 76 of file ntv2signalrouter.cpp.

◆ GetConnections()

virtual NTV2XptConnections CNTV2SignalRouter::GetConnections ( void ) const

inlinevirtual

Returns: A copy of my connections.

Definition at line 142 of file ntv2signalrouter.h.

◆ GetConnectionsFromRegs()

bool CNTV2SignalRouter::GetConnectionsFromRegs	(	const NTV2InputXptIDSet &	inInputXptIDs,
		const NTV2RegisterReads &	inRegValues,
		NTV2XptConnections &	outConnections
	)

static

Converts a set of crosspoint registers into a set of crosspoint connections.

Parameters

[in]	inInputXptIDs	Specifies the input crosspoints.
[in]	inRegValues	Specifies the crosspoint register values.
[out]	outConnections	Receives the connections found in the given register values.

Returns: True if successful; otherwise false.

Definition at line 605 of file ntv2signalrouter.cpp.

◆ GetNumberOfConnections()

virtual ULWord CNTV2SignalRouter::GetNumberOfConnections ( void ) const

inlinevirtual

Returns: The current number of connections (signal routes).

See also: CNTV2SignalRouter::IsEmpty

Definition at line 131 of file ntv2signalrouter.h.

◆ GetPossibleConnections()

bool CNTV2SignalRouter::GetPossibleConnections	(	const NTV2RegReads &	inROMRegisters,
		NTV2PossibleConnections &	outConnections
	)

static

Answers with the implemented crosspoint connections as obtained from the given ROM registers.

Parameters

[in]	inROMRegisters	The ROM register numbers and values.
[out]	outConnections	Receives the legal implemented connections/routes.

Returns: True if successful; otherwise false.

Definition at line 1064 of file ntv2signalrouter.cpp.

◆ GetRegisterWrites()

bool CNTV2SignalRouter::GetRegisterWrites ( NTV2RegisterWrites & outRegWrites ) const

virtual

Returns a sequence of NTV2RegInfo values that can be written to an NTV2 device using its WriteRegisters function.

Parameters

[out] outRegWrites Receives a sequence of NTV2ReadWriteRegisterSingle values.

Returns: True if successful; otherwise false.

Definition at line 132 of file ntv2signalrouter.cpp.

◆ GetRouteROMInfoFromReg()

bool CNTV2SignalRouter::GetRouteROMInfoFromReg	(	const ULWord	inROMRegNum,
		const ULWord	inROMRegValue,
		NTV2InputXptID &	outInputXpt,
		NTV2OutputXptIDSet &	outOutputXpts,
		const bool	inAppendOutputXpts = `false`
	)

static

Answers with the NTV2InputXptID and NTV2OutputXptIDSet for the given ROM register value.

Parameters

[in]	inROMRegNum	Specifies the ROM register number.
[in]	inROMRegValue	Specifies the ROM register value.
[out]	outInputXpt	Receives the input crosspoint associated with the ROM register.
[out]	outOutputXpts	Receives the valid (implemented) output crosspoint routes.
[in]	inAppendOutputXpts	If true, appends output crosspoints to the output set; otherwise clears the output crosspoint set (the default).

Returns: True if successful; otherwise false.

Definition at line 1029 of file ntv2signalrouter.cpp.

◆ GetWidgetForInput()

bool CNTV2SignalRouter::GetWidgetForInput	(	const NTV2InputXptID	inInputXpt,
		NTV2WidgetID &	outWidgetID,
		const NTV2DeviceID	inDeviceID = `DEVICE_ID_NOTFOUND`
	)

static

Returns the widget that "owns" the specified input crosspoint.

Parameters

[in]	inInputXpt	Specifies the input crosspoint of interest.
[out]	outWidgetID	Receives the NTV2WidgetID of the widget that "owns" the input crosspoint (or NTV2_WIDGET_INVALID upon failure).
[in]	inDeviceID	Optionally specifies a device ID to resolve any ambiguity if more than one NTV2WidgetID is associated with the given NTV2InputXptID. Defaults to DEVICE_ID_NOTFOUND, which returns the first match.

Returns: True if successful; otherwise false.

Definition at line 398 of file ntv2signalrouter.cpp.

◆ GetWidgetForOutput()

bool CNTV2SignalRouter::GetWidgetForOutput	(	const NTV2OutputXptID	inOutputXpt,
		NTV2WidgetID &	outWidgetID,
		const NTV2DeviceID	inDeviceID = `DEVICE_ID_NOTFOUND`
	)

static

Returns the widget that "owns" the specified output crosspoint.

Parameters

[in]	inOutputXpt	Specifies the output crosspoint of interest.
[out]	outWidgetID	Receives the NTV2WidgetID of the widget that "owns" the output crosspoint (or NTV2_WIDGET_INVALID upon failure).
[in]	inDeviceID	Optionally specifies a device ID to resolve any ambiguity if more than one NTV2WidgetID is associated with the given NTV2OutputXptID. Defaults to DEVICE_ID_NOTFOUND.

Note: The default behavior is to answer with the first NTV2WidgetID found in the NTV2WidgetIDSet.

Returns: True if successful; otherwise false.

Definition at line 426 of file ntv2signalrouter.cpp.

◆ GetWidgetIDs()

bool CNTV2SignalRouter::GetWidgetIDs	(	const NTV2DeviceID	inDeviceID,
		NTV2WidgetIDSet &	outWidgets
	)

static

Returns the widget IDs supported by the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the NTV2 device of interest.
[out]	outWidgets	Receives the NTV2WidgetIDSet of widgets that are supported by the given device.

Returns: True if successful; otherwise false.

Definition at line 379 of file ntv2signalrouter.cpp.

◆ GetWidgetInputs()

bool CNTV2SignalRouter::GetWidgetInputs	(	const NTV2WidgetID	inWidgetID,
		NTV2InputXptIDSet &	outInputs
	)

static

Returns the input crosspoints known to be "owned" by the given widget.

Parameters

[in]	inWidgetID	Specifies the NTV2WidgetID of the widget of interest.
[out]	outInputs	Receives the set of NTV2InputXptIDSet that are "owned" by the widget (or empty upon failure).

Returns: True if successful; otherwise false.

Definition at line 448 of file ntv2signalrouter.cpp.

◆ GetWidgetOutputs()

bool CNTV2SignalRouter::GetWidgetOutputs	(	const NTV2WidgetID	inWidgetID,
		NTV2OutputXptIDSet &	outOutputs
	)

static

Returns the output crosspoints known to be "owned" by the given widget.

Parameters

[in]	inWidgetID	Specifies the NTV2WidgetID of the widget of interest.
[out]	outOutputs	Receives the set of NTV2OutputXptIDSet that are "owned" by the widget (or empty upon failure).

Returns: True if successful; otherwise false.

Definition at line 490 of file ntv2signalrouter.cpp.

◆ GetWidgetsForInput()

bool CNTV2SignalRouter::GetWidgetsForInput	(	const NTV2InputXptID	inInputXpt,
		NTV2WidgetIDSet &	outWidgetIDs
	)

static

Returns the widgets that "own" the specified input crosspoint.

Parameters

[in]	inInputXpt	Specifies the input crosspoint of interest.
[out]	outWidgetIDs	Receives the NTV2WidgetIDSet containing the widgets that "own" the input crosspoint (or an empty set upon failure).

Returns: True if successful; otherwise false.

Definition at line 389 of file ntv2signalrouter.cpp.

◆ GetWidgetsForOutput()

bool CNTV2SignalRouter::GetWidgetsForOutput	(	const NTV2OutputXptID	inOutputXpt,
		NTV2WidgetIDSet &	outWidgetIDs
	)

static

Returns the widgets that "own" the specified output crosspoint.

Parameters

[in]	inOutputXpt	Specifies the output crosspoint of interest.
[out]	outWidgetIDs	Receives the NTV2WidgetIDSet containing the widgets that "own" the output crosspoint (or an empty set upon failure).

Returns: True if successful; otherwise false.

Definition at line 417 of file ntv2signalrouter.cpp.

◆ HasConnection()

bool CNTV2SignalRouter::HasConnection	(	const NTV2InputXptID	inSignalInput,
		const NTV2OutputXptID	inSignalOutput
	)		const

virtual

Answers true if I contain a connection between the specified input (signal sink) and output (signal source).

Parameters

[in]	inSignalInput	Specifies the widget signal input (sink) as an NTV2InputXptID.
[in]	inSignalOutput	Specifies the widget signal output (source) as an NTV2OutputXptID.

Returns: True if I have such a connection; otherwise false.

See also: CNTV2Card::IsConnected, CNTV2Card::IsConnectedTo

Definition at line 83 of file ntv2signalrouter.cpp.

◆ HasInput()

bool CNTV2SignalRouter::HasInput ( const NTV2InputXptID inSignalInput ) const

virtual

Answers true if I contain a connection that involves the given input (signal sink).

Parameters

[in] inSignalInput Specifies the widget signal input (sink) of interest as an NTV2InputXptID.

Returns: True if I have a connection involving the given input; otherwise false.

See also: CNTV2Card::IsConnected, CNTV2Card::GetConnectedInput, CNTV2SignalRouter::HasConnection

Definition at line 70 of file ntv2signalrouter.cpp.

◆ Initialize()

bool CNTV2SignalRouter::Initialize ( void )

static

Explicitly allocates and initializes the Routing Expert singleton.

Returns: True if successful; otherwise false.

Note: Normally, there is no need to call this function, as the Routing Expert singleton is automatically allocated and initialized.

See also: CNTV2SignalRouter::Deinitialize

Definition at line 325 of file ntv2signalrouter.cpp.

◆ Is12GSDIWidgetType()

bool CNTV2SignalRouter::Is12GSDIWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is a 12G SDI widget.

Definition at line 563 of file ntv2signalrouter.cpp.

◆ Is3GSDIWidgetType()

bool CNTV2SignalRouter::Is3GSDIWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is a 3G SDI widget.

Definition at line 557 of file ntv2signalrouter.cpp.

◆ IsDualLinkInWidgetType()

bool CNTV2SignalRouter::IsDualLinkInWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is a Dual Link Input widget.

Definition at line 575 of file ntv2signalrouter.cpp.

◆ IsDualLinkOutWidgetType()

bool CNTV2SignalRouter::IsDualLinkOutWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is a Dual Link Output widget.

Definition at line 581 of file ntv2signalrouter.cpp.

◆ IsDualLinkWidgetType()

bool CNTV2SignalRouter::IsDualLinkWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is a Dual Link widget.

Definition at line 569 of file ntv2signalrouter.cpp.

◆ IsEmpty()

virtual bool CNTV2SignalRouter::IsEmpty ( void ) const

inlinevirtual

Returns: True if I have no connections (signal routes); otherwise false.

See also: CNTV2SignalRouter::GetNumberOfConnections

Definition at line 137 of file ntv2signalrouter.h.

◆ IsHDMIInWidgetType()

bool CNTV2SignalRouter::IsHDMIInWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is an HDMI Input widget.

Definition at line 593 of file ntv2signalrouter.cpp.

◆ IsHDMIOutWidgetType()

bool CNTV2SignalRouter::IsHDMIOutWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is an HDMI Output widget.

Definition at line 599 of file ntv2signalrouter.cpp.

◆ IsHDMIWidgetType()

bool CNTV2SignalRouter::IsHDMIWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is an HDMI widget.

Definition at line 587 of file ntv2signalrouter.cpp.

◆ IsInitialized()

bool CNTV2SignalRouter::IsInitialized ( void )

static

Returns: True if the Signal Router singleton has been allocated/created; otherwise false.

Definition at line 339 of file ntv2signalrouter.cpp.

◆ IsKeyInputXpt()

bool CNTV2SignalRouter::IsKeyInputXpt ( const NTV2InputXptID inInputXpt )

static

Parameters

[in] inInputXpt Specifies the input crosspoint ID of interest.

Returns: True if the input is a mask/key input; otherwise false.

Definition at line 509 of file ntv2signalrouter.cpp.

◆ IsRGBOnlyInputXpt()

bool CNTV2SignalRouter::IsRGBOnlyInputXpt ( const NTV2InputXptID inInputXpt )

static

Parameters

[in] inInputXpt Specifies the input crosspoint ID of interest.

Returns: True if the input only accepts RGB; otherwise false.

Definition at line 497 of file ntv2signalrouter.cpp.

◆ IsSDIInputWidgetType()

bool CNTV2SignalRouter::IsSDIInputWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is an SDI Input Widget.

Definition at line 545 of file ntv2signalrouter.cpp.

◆ IsSDIOutputWidgetType()

bool CNTV2SignalRouter::IsSDIOutputWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is an SDI Output widget.

Definition at line 551 of file ntv2signalrouter.cpp.

◆ IsSDIWidgetType()

bool CNTV2SignalRouter::IsSDIWidgetType ( const NTV2WidgetType inWidgetType )

static

Parameters

[in] inWidgetType Specifies the widget type of interest.

Returns: True if the widget type is an SDI widget.

Definition at line 539 of file ntv2signalrouter.cpp.

◆ IsYUVOnlyInputXpt()

bool CNTV2SignalRouter::IsYUVOnlyInputXpt ( const NTV2InputXptID inInputXpt )

static

Parameters

[in] inInputXpt Specifies the input crosspoint ID of interest.

Returns: True if the input only accepts YCbCr; otherwise false.

Definition at line 503 of file ntv2signalrouter.cpp.

◆ MakeRouteROMRegisters()

bool CNTV2SignalRouter::MakeRouteROMRegisters ( NTV2RegReads & outROMRegisters )

static

Prepares an initialized, zeroed NTV2RegReads that's prepared to read all ROM registers from a device.

Parameters

[out] outROMRegisters Receives the prepared NTV2RegReads.

Returns: True if successful; otherwise false.

Definition at line 1081 of file ntv2signalrouter.cpp.

◆ NTV2InputCrosspointIDToString()

string CNTV2SignalRouter::NTV2InputCrosspointIDToString ( const NTV2InputXptID inInputXpt )

static

Returns a string containing the most compact human-readable form for a given input crosspoint.

Parameters

[in] inInputXpt Specifies the NTV2InputXptID of interest.

Returns: A string containing the most compact human-readable representation of the input crosspoint.

See also: CNTV2SignalRouter::NTV2OutputCrosspointIDToString, CNTV2SignalRouter::StringToNTV2InputCrosspointID

Definition at line 347 of file ntv2signalrouter.cpp.

◆ NTV2OutputCrosspointIDToString()

string CNTV2SignalRouter::NTV2OutputCrosspointIDToString ( const NTV2OutputXptID inOutputXpt )

static

Returns a string containing the most compact human-readable form for a given output crosspoint.

Parameters

[in] inOutputXpt Specifies the NTV2OutputXptID of interest.

Returns: A string containing the most compact human-readable representation of the output crosspoint.

See also: CNTV2SignalRouter::NTV2InputCrosspointIDToString, CNTV2SignalRouter::StringToNTV2OutputCrosspointID

Definition at line 355 of file ntv2signalrouter.cpp.

◆ operator!=()

virtual bool CNTV2SignalRouter::operator!= ( const CNTV2SignalRouter & inRHS ) const

inlinevirtual

Returns: True if my connections differ from those of the given right-hand-side signal router; otherwise false.

Parameters

[in] inRHS The CNTV2SignalRouter that I'll be compared with.

See also: CNTV2SignalRouter::Compare, CNTV2SignalRouter::operator ==

Definition at line 180 of file ntv2signalrouter.h.

◆ operator==()

virtual bool CNTV2SignalRouter::operator== ( const CNTV2SignalRouter & inRHS ) const

inlinevirtual

Returns: True if my connections are identical to those of the given right-hand-side signal router; otherwise false.

Parameters

[in] inRHS The CNTV2SignalRouter that I'll be compared with.

See also: CNTV2SignalRouter::Compare, CNTV2SignalRouter::operator !=

Definition at line 173 of file ntv2signalrouter.h.

◆ Print()

ostream & CNTV2SignalRouter::Print	(	std::ostream &	inOutStream,
		const bool	inForRetailDisplay = `false`
	)		const

virtual

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

Parameters

	inOutStream	Specifies the output stream that is to receive the human-readable data.
[in]	inForRetailDisplay	Specify true to use human-readable names in the display; otherwise false to use names found in the SDK.

Returns: A reference to the specified output stream.

See also: CNTV2SignalRouter::PrintCode

Definition at line 200 of file ntv2signalrouter.cpp.

◆ PrintCode()

bool CNTV2SignalRouter::PrintCode	(	std::string &	outCode,
		const PrintCodeConfig &	inConfig = `PrintCodeConfig()`
	)		const

virtual

Prints me as source code to the given output stream.

Parameters

[out]	outCode	Receives the generated source code.
[in]	inConfig	Specifies how the source code will be generated. If unspecified, uses the PrintCodeConfig's default settings.

Returns: True if successful; otherwise false.

See also: CNTV2SignalRouter::Print

Definition at line 219 of file ntv2signalrouter.cpp.

◆ RemoveConnection()

bool CNTV2SignalRouter::RemoveConnection	(	const NTV2InputXptID	inSignalInput,
		const NTV2OutputXptID	inSignalOutput
	)

virtual

Removes the connection between the specified input (signal sink) and output (signal source).

Parameters

[in]	inSignalInput	Specifies the widget signal input (sink) as an NTV2InputXptID.
[in]	inSignalOutput	Specifies the widget signal output (source) as an NTV2OutputXptID.

Returns: True if successfully removed; otherwise false.

See also: CNTV2Card::Disconnect, CNTV2SignalRouter::AddConnection

Definition at line 92 of file ntv2signalrouter.cpp.

◆ Reset()

virtual void CNTV2SignalRouter::Reset ( void )

inlinevirtual

Resets me, erasing any/all existing connections.

See also: CNTV2Card::ClearRouting, CNTV2SignalRouter::ResetFromRegisters

Definition at line 108 of file ntv2signalrouter.h.

◆ ResetFrom()

virtual bool CNTV2SignalRouter::ResetFrom ( const NTV2XptConnections & inConnections )

inlinevirtual

Resets me, replacing any/all existing connections with the given connections.

Parameters

[in] inConnections Specifies the new routing connections.

Returns: True if successful; otherwise false.

See also: CNTV2SignalRouter::Reset

Definition at line 125 of file ntv2signalrouter.h.

◆ ResetFromRegisters()

bool CNTV2SignalRouter::ResetFromRegisters	(	const NTV2InputXptIDSet &	inInputXpts,
		const NTV2RegisterReads &	inRegReads
	)

virtual

Resets me, erasing any/all existing connections, then rebuilding my connections from the given register values.

Parameters

[in]	inInputXpts	Specifies the input crosspoints of interest (perhaps obtained from CNTV2SignalRouter::GetAllWidgetInputs).
[in]	inRegReads	Specifies the routing registers/values (perhaps obtained from CNTV2Card::ReadRegisters).

Returns: True if successful; otherwise false.

See also: CNTV2SignalRouter::Reset, CNTV2SignalRouter::GetRegisterWrites

Definition at line 108 of file ntv2signalrouter.cpp.

◆ StringToNTV2InputCrosspointID()

NTV2InputXptID CNTV2SignalRouter::StringToNTV2InputCrosspointID ( const std::string & inStr )

static

Returns a string containing the most compact human-readable form for a given input crosspoint.

Parameters

[in] inStr Specifies the string to convert into an NTV2InputXptID.

Returns: The corresponding input crosspoint.

See also: CNTV2SignalRouter::StringToNTV2OutputCrosspointID, CNTV2SignalRouter::NTV2InputCrosspointIDToString

Definition at line 363 of file ntv2signalrouter.cpp.

◆ StringToNTV2OutputCrosspointID()

NTV2OutputXptID CNTV2SignalRouter::StringToNTV2OutputCrosspointID ( const std::string & inStr )

static

Returns the output crosspoint that corresponds to the given string.

Parameters

[in] inStr Specifies the string to convert into an NTV2OutputXptID.

Returns: The corresponding output crosspoint.

See also: CNTV2SignalRouter::StringToNTV2InputCrosspointID, CNTV2SignalRouter::NTV2OutputCrosspointIDToString

Definition at line 371 of file ntv2signalrouter.cpp.

◆ ToCodeString()

bool CNTV2SignalRouter::ToCodeString	(	std::string &	outCode,
		const NTV2XptConnections &	inConnections,
		const PrintCodeConfig &	inConfig = `PrintCodeConfig()`
	)

static

Converts the given map of crosspoint connections into source code.

Parameters

[out]	outCode	Receives the generated source code.
[in]	inConnections	Receives the connections from what is successfully parsed from the string. It will be empty if this function fails.
[in]	inConfig	Specifies how the source code will be generated. If unspecified, uses the PrintCodeConfig's default settings.

Returns: True if successful; otherwise false.

Definition at line 226 of file ntv2signalrouter.cpp.

◆ WidgetIDFromTypeAndChannel()

NTV2WidgetID CNTV2SignalRouter::WidgetIDFromTypeAndChannel	(	const NTV2WidgetType	inWidgetType,
		const NTV2Channel	inChannel
	)

static

Parameters

[in]	inWidgetType	Specifies the widget type of interest.
[in]	inChannel	Specifies the channel of interest.

Returns: The corresponding widget ID.

Definition at line 523 of file ntv2signalrouter.cpp.

◆ WidgetIDToChannel()

NTV2Channel CNTV2SignalRouter::WidgetIDToChannel ( const NTV2WidgetID inWidgetID )

static

Parameters

[in] inWidgetID Specifies the widget ID of interest.

Returns: The corresponding channel.

Definition at line 515 of file ntv2signalrouter.cpp.

◆ WidgetIDToType()

NTV2WidgetType CNTV2SignalRouter::WidgetIDToType ( const NTV2WidgetID inWidgetID )

static

Parameters

[in] inWidgetID Specifies the widget ID of interest.

Returns: The corresponding widget type.

Definition at line 531 of file ntv2signalrouter.cpp.

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

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

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddConnection()

◆ Compare()

◆ CompareConnections()

◆ CreateFromString() [1/2]

◆ CreateFromString() [2/2]

◆ Deinitialize()

◆ GetAllRoutingRegInfos()

◆ GetAllWidgetInputs()

◆ GetConnectedOutput()

◆ GetConnections()

◆ GetConnectionsFromRegs()

◆ GetNumberOfConnections()

◆ GetPossibleConnections()

◆ GetRegisterWrites()

◆ GetRouteROMInfoFromReg()

◆ GetWidgetForInput()

◆ GetWidgetForOutput()

◆ GetWidgetIDs()

◆ GetWidgetInputs()

◆ GetWidgetOutputs()

◆ GetWidgetsForInput()

◆ GetWidgetsForOutput()

◆ HasConnection()

◆ HasInput()

◆ Initialize()

◆ Is12GSDIWidgetType()

◆ Is3GSDIWidgetType()

◆ IsDualLinkInWidgetType()

◆ IsDualLinkOutWidgetType()

◆ IsDualLinkWidgetType()

◆ IsEmpty()

◆ IsHDMIInWidgetType()

◆ IsHDMIOutWidgetType()

◆ IsHDMIWidgetType()

◆ IsInitialized()

◆ IsKeyInputXpt()

◆ IsRGBOnlyInputXpt()

◆ IsSDIInputWidgetType()

◆ IsSDIOutputWidgetType()

◆ IsSDIWidgetType()

◆ IsYUVOnlyInputXpt()

◆ MakeRouteROMRegisters()

◆ NTV2InputCrosspointIDToString()

◆ NTV2OutputCrosspointIDToString()

◆ operator!=()

◆ operator==()

◆ Print()

◆ PrintCode()

◆ RemoveConnection()

◆ Reset()

◆ ResetFrom()

◆ ResetFromRegisters()

◆ StringToNTV2InputCrosspointID()

◆ StringToNTV2OutputCrosspointID()

◆ ToCodeString()

◆ WidgetIDFromTypeAndChannel()

◆ WidgetIDToChannel()

◆ WidgetIDToType()