IECO interface
The IECO interface represents an Engineering Change Order interface in the Work Space Manager. Basically an Engineering Change Order attempts to keep a project containing source documents and its corresponding primary implementation documents synchronized. For example a schematic project and its PCB document, every time something changes in a schematic project, it is necessary to bring the changes forward to the PCB document via the Engineering Change Order feature.
public interface IECO
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| DM_AddMemberToObject | bool | Adds a specific action in the ECO manager. |
| DM_AddObject | bool | Adds a reference object for the ECO to compare the target document against this reference document. |
| DM_Begin | void | Denotes that the ECO manager has started. |
| DM_ChangeObject | bool | Changes a specific action in the ECO manager. |
| DM_End | void | Denotes that the ECO manager has ended. |
| DM_RemoveMemberFromObject | bool | Removes a specific action in the ECO manager. |
| DM_RemoveObject | bool | Removes a reference object depending on what ECO mode is. |
DM_AddMemberToObject
Adds a specific action in the ECO manager.
bool DM_AddMemberToObject(TECO_Mode argMode, IDMObject argReferenceMember, IDMObject argReferenceParent, IDMObject argTargetParent);
bool DM_AddMemberToObject(int argMode, object argReferenceMember, object argReferenceParent, object argTargetParent);
| Parameter | Type | Passing |
|---|---|---|
argMode | TECO_Mode | value |
argReferenceMember | IDMObject | value |
argReferenceParent | IDMObject | value |
argTargetParent | IDMObject | value |
Returns: bool
The first overload is an extension method of IECOHelper (using EDP;) with typed parameters; the second is declared by the interface.
DM_AddObject
Adds a reference object for the ECO to compare the target document against this reference document.
bool DM_AddObject(TECO_Mode argMode, IDMObject argReferenceObject);
bool DM_AddObject(int argMode, object argReferenceObject);
| Parameter | Type | Passing |
|---|---|---|
argMode | TECO_Mode | value |
argReferenceObject | IDMObject | value |
Returns: bool
The first overload is an extension method of IECOHelper (using EDP;) with typed parameters; the second is declared by the interface.
DM_Begin
Denotes that the ECO manager has started.
void DM_Begin();
Returns: nothing (void)
DM_ChangeObject
Changes a specific action in the ECO manager.
bool DM_ChangeObject(TECO_Mode argMode, TModificationKind argKind, IDMObject argObjectToChange, IDMObject argReferenceObject, IUpdateParameterOptions argUpdateParameterOptions);
bool DM_ChangeObject(int argMode, int argKind, object argObjectToChange, object argReferenceObject, object argUpdateParameterOptions);
| Parameter | Type | Passing |
|---|---|---|
argMode | TECO_Mode | value |
argKind | TModificationKind | value |
argObjectToChange | IDMObject | value |
argReferenceObject | IDMObject | value |
argUpdateParameterOptions | IUpdateParameterOptions | value |
Returns: bool
The first overload is an extension method of IECOHelper (using EDP;) with typed parameters; the second is declared by the interface.
DM_End
Denotes that the ECO manager has ended.
void DM_End();
Returns: nothing (void)
DM_RemoveMemberFromObject
Removes a specific action in the ECO manager.
bool DM_RemoveMemberFromObject(TECO_Mode argMode, IDMObject argMemberObject, IDMObject argParentObject);
bool DM_RemoveMemberFromObject(int argMode, object argMemberObject, object argParentObject);
| Parameter | Type | Passing |
|---|---|---|
argMode | TECO_Mode | value |
argMemberObject | IDMObject | value |
argParentObject | IDMObject | value |
Returns: bool
The first overload is an extension method of IECOHelper (using EDP;) with typed parameters; the second is declared by the interface.
DM_RemoveObject
Removes a reference object depending on what ECO mode is.
bool DM_RemoveObject(TECO_Mode argMode, IDMObject argObjectToRemove);
bool DM_RemoveObject(int argMode, object argObjectToRemove);
| Parameter | Type | Passing |
|---|---|---|
argMode | TECO_Mode | value |
argObjectToRemove | IDMObject | value |
Returns: bool
The first overload is an extension method of IECOHelper (using EDP;) with typed parameters; the second is declared by the interface.