IUnifiedDataModel interface
No description yet.
public interface IUnifiedDataModel
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| AddDocument | void | |
| BeginRead | void | |
| BeginWrite | void | |
| CreateGlobalObject | object | |
| DestroyGlobalObject | void | |
| DocumentChanged | void | |
| DocumentPathChanged | void | |
| EndRead | void | |
| EndWrite | void | |
| GetDocumentPath | string | |
| InDocumentLoading | bool | |
| InDocumentLoading_1 | bool | |
| LoadDocumentByPath | object | |
| MakeGlobal | void | |
| ReleaseDocument | bool | |
| RemoveDocument | bool | |
| RemoveDocumentByPath | bool | |
| SupportsDocumentExt | bool | |
| SupportsDocumentInterface | bool | |
| SupportsExt | bool | |
| SupportsInterface | bool | |
| UnloadDocument | bool |
AddDocument
No description yet.
void AddDocument(string argDocumentID, string argFullPath, object argIntf);
| Parameter | Type | Passing |
|---|---|---|
argDocumentID | string | value |
argFullPath | string | value |
argIntf | object | value |
Returns: nothing (void)
BeginRead
No description yet.
void BeginRead();
Returns: nothing (void)
Examples: Extension_TestPortHarnessDev
BeginWrite
No description yet.
void BeginWrite();
Returns: nothing (void)
CreateGlobalObject
No description yet.
object CreateGlobalObject(string argDocumentKind, int argObjectId);
| Parameter | Type | Passing |
|---|---|---|
argDocumentKind | string | value |
argObjectId | int | value |
Returns: object
DestroyGlobalObject
No description yet.
void DestroyGlobalObject(string argHandle);
| Parameter | Type | Passing |
|---|---|---|
argHandle | string | value |
Returns: nothing (void)
DocumentChanged
No description yet.
void DocumentChanged(string argFullPath, string argNewID);
| Parameter | Type | Passing |
|---|---|---|
argFullPath | string | value |
argNewID | string | value |
Returns: nothing (void)
DocumentPathChanged
No description yet.
void DocumentPathChanged(string argOldPath, string argNewPath);
| Parameter | Type | Passing |
|---|---|---|
argOldPath | string | value |
argNewPath | string | value |
Returns: nothing (void)
EndRead
No description yet.
void EndRead();
Returns: nothing (void)
Examples: Extension_TestPortHarnessDev
EndWrite
No description yet.
void EndWrite();
Returns: nothing (void)
GetDocumentPath
No description yet.
string GetDocumentPath(string argHandle);
| Parameter | Type | Passing |
|---|---|---|
argHandle | string | value |
Returns: string
InDocumentLoading
No description yet.
bool InDocumentLoading();
Returns: bool
InDocumentLoading_1
No description yet.
bool InDocumentLoading_1(string argFullPath);
| Parameter | Type | Passing |
|---|---|---|
argFullPath | string | value |
Returns: bool
LoadDocumentByPath
No description yet.
object LoadDocumentByPath(string argFullPath);
| Parameter | Type | Passing |
|---|---|---|
argFullPath | string | value |
Returns: object
MakeGlobal
No description yet.
void MakeGlobal(object argObject);
| Parameter | Type | Passing |
|---|---|---|
argObject | object | value |
Returns: nothing (void)
ReleaseDocument
No description yet.
bool ReleaseDocument(string argDocumentID);
| Parameter | Type | Passing |
|---|---|---|
argDocumentID | string | value |
Returns: bool
RemoveDocument
No description yet.
bool RemoveDocument(string argDocumentID);
| Parameter | Type | Passing |
|---|---|---|
argDocumentID | string | value |
Returns: bool
RemoveDocumentByPath
No description yet.
bool RemoveDocumentByPath(string argFullPath);
| Parameter | Type | Passing |
|---|---|---|
argFullPath | string | value |
Returns: bool
SupportsDocumentExt
No description yet.
bool SupportsDocumentExt(string argDocumentID, string argIID, out object argIntf);
| Parameter | Type | Passing |
|---|---|---|
argDocumentID | string | value |
argIID | string | value |
argIntf | object | out |
Returns: bool
SupportsDocumentInterface
No description yet.
bool SupportsDocumentInterface(string argDocumentID, out object argIntf);
| Parameter | Type | Passing |
|---|---|---|
argDocumentID | string | value |
argIntf | object | out |
Returns: bool
SupportsExt
No description yet.
bool SupportsExt(string argHandle, string argIID, out object argIntf);
| Parameter | Type | Passing |
|---|---|---|
argHandle | string | value |
argIID | string | value |
argIntf | object | out |
Returns: bool
SupportsInterface
No description yet.
bool SupportsInterface(string argHandle, out object argIntf);
| Parameter | Type | Passing |
|---|---|---|
argHandle | string | value |
argIntf | object | out |
Returns: bool
Examples: Extension_TestPortHarnessDev
UnloadDocument
No description yet.
bool UnloadDocument(string argDocumentID);
| Parameter | Type | Passing |
|---|---|---|
argDocumentID | string | value |
Returns: bool
Returned by
Examples
Used in the SDK examples: Extension_TestPortHarnessDev.