NI DIGITAL PATTERN DRIVER Pin Map Functions

Pin Map Functions

• niDigital_LoadPinMap
• niDigital_EnableSites
• niDigital_DisableSites
• niDigital_IsSiteEnabled

niDigital_LoadPinMap

Loads a pin map file. You can load only a single pin and channel map file during an NI-Digital Pattern Driver session. To switch pin maps, create a new session or call the niDigital_reset function.

C Function Prototype: ViStatus niDigital_LoadPinMap (ViSession vi, ViConstString pinMapFilePath)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
pinMapFilePath	Absolute file path to a pin map file created with the Digital Pattern Editor or the NI TestStand Semiconductor Module.

Return value: Reports the status of the operation.

niDigital_EnableSites

Enables the sites you specify. All sites are enabled by default.

C Function Prototype: ViStatus niDigital_EnableSites (ViSession vi, ViConstString siteList)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
siteList	Comma-delimited list of strings in the form of siteN, where N is the site number. If you enter an empty string, the function enables all sites.

Return value: Reports the status of the operation.

niDigital_DisableSites

Disables specified sites. Disabled sites are not included in pattern bursts initiated by the niDigital_Initiate function or the niDigital_BurstPattern function, even if the site is specified in the list of pattern burst sites in niDigital_ConfigurePatternBurstSites function or in the siteList input of the niDigital_BurstPattern function.

Additionally, if you specify a list of pin or pin group names in a channelList parameter in any NI-Digital function, digital pattern instrument channels mapped to disabled sites are not affected by the function. The functions that return per-pin data, such as the niDigital_PPMU_Measure function, do not return data for channels mapped to disabled sites.

The digital pattern instrument channels mapped to the sites specified are left in their current state.

NI TestStand Semiconductor Module requires all sites to always be enabled, and manages the set of active sites without disabling the sites in the digital instrument session. Do not use this function with the Semiconductor Module.

C Function Prototype: ViStatus niDigital_DisableSites (ViSession vi, ViConstString siteList)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
siteList	Comma-delimited list of strings in the form of siteN, where N is the site number. If you enter an empty string, the function disables all sites.

Return value: Reports the status of the operation.

niDigital_IsSiteEnabled

Checks if a specified site is enabled.

C Function Prototype: ViStatus niDigital_IsSiteEnabled (ViSession vi, viConstString site, ViBoolean* enable)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
site	Site specified as a string in the form of siteN, where N is the site number. The function returns an error if more than one site is specified.
Output
enable	Boolean value that returns whether the site is enabled or disabled.

Return value: Reports the status of the operation.