Skip to main content
View as Markdown

IDeviceManager interface

No description yet.

public interface IDeviceManager

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties​

PropertyTypeAccessDescription
DefaultDevicestringget; set

DefaultDevice​

No description yet.

string GetDefaultDevice();
void SetDefaultDevice(string argDeviceName);

Type: string · Access: read/write

Methods​

MethodReturnsDescription
_Finalizevoid
AreDevicesPinCompatiblebool
CanGetDevicebool
ChoosePhysicalDevicestring
CompareIdCodesbool
GetAllVendorsstring
GetDeviceINexusDevice
GetDeviceCachedInfobool
GetDeviceFamilyManagerIDeviceFamilyManager
GetDeviceFromDeviceIdINexusDevice
GetDeviceInformationIDeviceInformation
GetDeviceNamesForIdCodestring
GetDevicesForFamilystring
GetFamiliesForDeviceTypestring
GetFamiliesForVendorstring
GetGenericDeviceManagerIGenericDeviceManager
Initializebool
ReleaseDevicevoid

_Finalize​

No description yet.

void _Finalize();

Returns: nothing (void)

AreDevicesPinCompatible​

No description yet.

bool AreDevicesPinCompatible(string argDeviceName1, string argDeviceName2);
ParameterTypePassing
argDeviceName1stringvalue
argDeviceName2stringvalue

Returns: bool

CanGetDevice​

No description yet.

bool CanGetDevice(string argDeviceName);
ParameterTypePassing
argDeviceNamestringvalue

Returns: bool

ChoosePhysicalDevice​

No description yet.

string ChoosePhysicalDevice(string argDeviceName, string argFilterParameters);
ParameterTypePassing
argDeviceNamestringvalue
argFilterParametersstringvalue

Returns: string

CompareIdCodes​

No description yet.

bool CompareIdCodes(uint argIdCodeA, uint argIdCodeB);
ParameterTypePassing
argIdCodeAuintvalue
argIdCodeBuintvalue

Returns: bool

GetAllVendors​

No description yet.

string GetAllVendors();

Returns: string

GetDevice​

No description yet.

INexusDevice GetDevice(string argDeviceName);
ParameterTypePassing
argDeviceNamestringvalue

Returns: INexusDevice

Extension method of IDeviceManagerHelper (using SCH;).

GetDeviceCachedInfo​

No description yet.

bool GetDeviceCachedInfo(string argDeviceName, out DeviceCachedInformation argInformation);
bool GetDeviceCachedInfo(string argDeviceName, out IDeviceCachedInformation argInformation);
ParameterTypePassing
argDeviceNamestringvalue
argInformationDeviceCachedInformationout

Returns: bool

The first overload is an extension method of IDeviceManagerHelper (using SCH;) with typed parameters; the second is declared by the interface.

GetDeviceFamilyManager​

No description yet.

IDeviceFamilyManager GetDeviceFamilyManager();

Returns: IDeviceFamilyManager

Extension method of IDeviceManagerHelper (using SCH;).

GetDeviceFromDeviceId​

No description yet.

INexusDevice GetDeviceFromDeviceId(string argnId);
ParameterTypePassing
argnIdstringvalue

Returns: INexusDevice

Extension method of IDeviceManagerHelper (using SCH;).

GetDeviceInformation​

No description yet.

IDeviceInformation GetDeviceInformation(string argDeviceName);
ParameterTypePassing
argDeviceNamestringvalue

Returns: IDeviceInformation

Extension method of IDeviceManagerHelper (using SCH;).

GetDeviceNamesForIdCode​

No description yet.

string GetDeviceNamesForIdCode(uint argIdCode);
ParameterTypePassing
argIdCodeuintvalue

Returns: string

GetDevicesForFamily​

No description yet.

string GetDevicesForFamily(string argFamily);
ParameterTypePassing
argFamilystringvalue

Returns: string

GetFamiliesForDeviceType​

No description yet.

string GetFamiliesForDeviceType(string argDeviceType);
ParameterTypePassing
argDeviceTypestringvalue

Returns: string

GetFamiliesForVendor​

No description yet.

string GetFamiliesForVendor(string argVendor);
ParameterTypePassing
argVendorstringvalue

Returns: string

GetGenericDeviceManager​

No description yet.

IGenericDeviceManager GetGenericDeviceManager();

Returns: IGenericDeviceManager

Extension method of IDeviceManagerHelper (using SCH;).

Initialize​

No description yet.

bool Initialize();

Returns: bool

ReleaseDevice​

No description yet.

void ReleaseDevice(INexusDevice argNexusDevice);
void ReleaseDevice(object argNexusDevice);
ParameterTypePassing
argNexusDeviceINexusDevicevalue

Returns: nothing (void)

The first overload is an extension method of IDeviceManagerHelper (using SCH;) with typed parameters; the second is declared by the interface.