IEmbeddedStackSync interface

No description yet.

public interface IEmbeddedStackSync

Namespace: Embedded · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
BeginSync	void
CheckIsSupported	bool
EndSync	void
FpgaComponentSetOptionValue	bool
FpgaComponentSetParameters	bool
FpgaComponentSync	bool
FpgaSetInterruptMask	bool
GetPlugin	string
GetPluginCount	int
GetPluginFromHardwareId	string
GetSwPlatformClockSpeed	string
PluginGetCaption	string
PluginGetDebugXmlFile	string
PluginGetDescription	string
PluginGetHelpFile	string
PluginGetInstanceCount	int
PluginGetOptionValue	string
PluginGetPinCaptions	string
PluginGetPinMappingCaptions	string
PluginGetPinMappingOptionName	string
PluginGetPinMappingValues	string
PluginGetPinValues	string
PluginHasInstance	bool
PluginInstanceGetHardwareId	string
PluginInstanceGetId	string
PluginInstanceGetLinksUpCount	int
PluginInstanceGetLinkUpInstanceId	string
PluginInstanceGetName	string
PluginInstanceGetOptionValue	string
PluginInstanceGetPlugin	string
PluginInstanceSetName	bool
PluginInstanceSetOptionValue	bool
PluginIsPeripheral	bool
PluginSetOptionValue	bool

BeginSync

No description yet.

void BeginSync();

Returns: nothing (void)

CheckIsSupported

No description yet.

bool CheckIsSupported(string argHardwareId);

Parameter	Type	Passing
argHardwareId	string	value

Returns: bool

EndSync

No description yet.

void EndSync();

Returns: nothing (void)

FpgaComponentSetOptionValue

No description yet.

bool FpgaComponentSetOptionValue(string argComponentId, string argnOptionName, string argValue);

Parameter	Type	Passing
argComponentId	string	value
argnOptionName	string	value
argValue	string	value

Returns: bool

FpgaComponentSetParameters

No description yet.

bool FpgaComponentSetParameters(string argComponentId, string argParamString);

Parameter	Type	Passing
argComponentId	string	value
argParamString	string	value

Returns: bool

FpgaComponentSync

No description yet.

bool FpgaComponentSync(string argComponentId, string argName, string argHardwareId);

Parameter	Type	Passing
argComponentId	string	value
argName	string	value
argHardwareId	string	value

Returns: bool

FpgaSetInterruptMask

No description yet.

bool FpgaSetInterruptMask(int argMask);

Parameter	Type	Passing
argMask	int	value

Returns: bool

GetPlugin

No description yet.

string GetPlugin(int argnIndex);

Parameter	Type	Passing
argnIndex	int	value

Returns: string

GetPluginCount

No description yet.

int GetPluginCount();

Returns: int

GetPluginFromHardwareId

No description yet.

string GetPluginFromHardwareId(string argHardwareId);

Parameter	Type	Passing
argHardwareId	string	value

Returns: string

GetSwPlatformClockSpeed

No description yet.

string GetSwPlatformClockSpeed();

Returns: string

PluginGetCaption

No description yet.

string PluginGetCaption(string argPluginName);

Parameter	Type	Passing
argPluginName	string	value

Returns: string

PluginGetDebugXmlFile

No description yet.

string PluginGetDebugXmlFile(string argPluginName);

Parameter	Type	Passing
argPluginName	string	value

Returns: string

PluginGetDescription

No description yet.

string PluginGetDescription(string argPluginName);

Parameter	Type	Passing
argPluginName	string	value

Returns: string

PluginGetHelpFile

No description yet.

string PluginGetHelpFile(string argPluginName);

Parameter	Type	Passing
argPluginName	string	value

Returns: string

PluginGetInstanceCount

No description yet.

int PluginGetInstanceCount(string argPluginName);

Parameter	Type	Passing
argPluginName	string	value

Returns: int

PluginGetOptionValue

No description yet.

string PluginGetOptionValue(string argPluginName, string argnOptionName);

Parameter	Type	Passing
argPluginName	string	value
argnOptionName	string	value

Returns: string

PluginGetPinCaptions

No description yet.

string PluginGetPinCaptions(string argPluginName, string argInstanceId, string argPinName);

Parameter	Type	Passing
argPluginName	string	value
argInstanceId	string	value
argPinName	string	value

Returns: string

PluginGetPinMappingCaptions

No description yet.

string PluginGetPinMappingCaptions(string argPluginName, string argInstanceId);

Parameter	Type	Passing
argPluginName	string	value
argInstanceId	string	value

Returns: string

PluginGetPinMappingOptionName

No description yet.

string PluginGetPinMappingOptionName(string argPluginName);

Parameter	Type	Passing
argPluginName	string	value

Returns: string

PluginGetPinMappingValues

No description yet.

string PluginGetPinMappingValues(string argPluginName, string argInstanceId);

Parameter	Type	Passing
argPluginName	string	value
argInstanceId	string	value

Returns: string

PluginGetPinValues

No description yet.

string PluginGetPinValues(string argPluginName, string argInstanceId, string argPinName);

Parameter	Type	Passing
argPluginName	string	value
argInstanceId	string	value
argPinName	string	value

Returns: string

PluginHasInstance

No description yet.

bool PluginHasInstance(string argPluginName, string argInstanceId);

Parameter	Type	Passing
argPluginName	string	value
argInstanceId	string	value

Returns: bool

PluginInstanceGetHardwareId

No description yet.

string PluginInstanceGetHardwareId(string argnInstanceId);

Parameter	Type	Passing
argnInstanceId	string	value

Returns: string

PluginInstanceGetId

No description yet.

string PluginInstanceGetId(string argPluginName, int argnInstanceIndex);

Parameter	Type	Passing
argPluginName	string	value
argnInstanceIndex	int	value

Returns: string

PluginInstanceGetLinksUpCount

No description yet.

int PluginInstanceGetLinksUpCount(string argnInstanceId);

Parameter	Type	Passing
argnInstanceId	string	value

Returns: int

PluginInstanceGetLinkUpInstanceId

No description yet.

string PluginInstanceGetLinkUpInstanceId(string argnInstanceId, int argnIndex);

Parameter	Type	Passing
argnInstanceId	string	value
argnIndex	int	value

Returns: string

PluginInstanceGetName

No description yet.

string PluginInstanceGetName(string argnInstanceId);

Parameter	Type	Passing
argnInstanceId	string	value

Returns: string

PluginInstanceGetOptionValue

No description yet.

string PluginInstanceGetOptionValue(string argnInstanceId, string argnOptionName);

Parameter	Type	Passing
argnInstanceId	string	value
argnOptionName	string	value

Returns: string

PluginInstanceGetPlugin

No description yet.

string PluginInstanceGetPlugin(string argnInstanceId);

Parameter	Type	Passing
argnInstanceId	string	value

Returns: string

PluginInstanceSetName

No description yet.

bool PluginInstanceSetName(string argnInstanceId, string argName);

Parameter	Type	Passing
argnInstanceId	string	value
argName	string	value

Returns: bool

PluginInstanceSetOptionValue

No description yet.

bool PluginInstanceSetOptionValue(string argnInstanceId, string argnOptionName, string argValue);

Parameter	Type	Passing
argnInstanceId	string	value
argnOptionName	string	value
argValue	string	value

Returns: bool

PluginIsPeripheral

No description yet.

bool PluginIsPeripheral(string argPluginName);

Parameter	Type	Passing
argPluginName	string	value

Returns: bool

PluginSetOptionValue

No description yet.

bool PluginSetOptionValue(string argPluginName, string argnOptionName, string argValue);

Parameter	Type	Passing
argPluginName	string	value
argnOptionName	string	value
argValue	string	value

Returns: bool

Returned by

IEmbeddedStack.GetEmbeddedStackSyncInterface