Method SetGlobalSiteData

Namespace

NationalInstruments.SemiconductorTestLibrary.DataAbstraction

Assembly

NationalInstruments.SemiconductorTestLibrary.Abstractions.dll

SetGlobalSiteData<T>(ISemiconductorModuleContext, string, SiteData<T>, bool)

Associates a data item with a dataId. Use this method to store a SiteData object you initialize in one location and access later in a downstream location using the GetGlobalSiteData<T>(ISemiconductorModuleContext, string, bool) method.

public static void SetGlobalSiteData<T>(this ISemiconductorModuleContext tsmContext, string dataId, SiteData<T> siteData, bool overrideIfExisting = true)

Parameters

tsmContext ISemiconductorModuleContext

The NationalInstruments.TestStand.SemiconductorModule.CodeModuleAPI.ISemiconductorModuleContext object.

dataId string

A unique ID to distinguish the data.

siteData SiteData<T>

A data item to store and later retrieve using the specified dataId. If the data item is null, the method deletes the data with the specified dataId if it exists.

overrideIfExisting bool

Specifies whether to override the existing data for a specific site with data from the given SiteData object.

Type Parameters

T

Data type of value to use with SiteData<T> object.

Exceptions

NISemiconductorTestException

Thrown when data for a specific site already exists but overrideIfExisting is set to false.