IViolation interface
The IViolation interface represents a violation object on a design document in the Workspace Manager of Altium Designer.
public interface IViolation : IDMObject
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Inherits: IDMObject
Methods
| Method | Returns | Description |
|---|---|---|
| DM_AddRelatedObject | void | This method adds the object that is part of the violation. |
| DM_CompilationStage | TCompilationStage | This method returns the status of the complation stage: during compilation or during flattening process. |
| DM_ConnectionCode1 | TConnectionCode | |
| DM_ConnectionCode2 | TConnectionCode | |
| DM_DescriptorString | string | This method returns the description string for this violation interface. |
| DM_DetailString | string | This method returns the detailed description stirng of this violation interface. |
| DM_ErrorKind | TErrorKind | Returns the kind of error this violation has been assigned to. |
| DM_ErrorLevel | TErrorLevel | Returns the level of error this violation has been assigned to. |
| DM_IsSuppressed | bool | |
| DM_RelatedObjectCount | int | This method returns the number of related objects of the violation. |
| DM_RelatedObjects | IDMObject | This method returns the indexed related object of the violation. |
DM_AddRelatedObject
This method adds the object that is part of the violation.
void DM_AddRelatedObject(IDMObject argnObject);
void DM_AddRelatedObject(object argnObject);
| Parameter | Type | Passing |
|---|---|---|
argnObject | IDMObject | value |
Returns: nothing (void)
The first overload is an extension method of IViolationHelper (using EDP;) with typed parameters; the second is declared by the interface.
DM_CompilationStage
This method returns the status of the complation stage: during compilation or during flattening process.
TCompilationStage DM_CompilationStage();
Returns: TCompilationStage
Extension method of IViolationHelper (using EDP;).
DM_ConnectionCode1
No description yet.
TConnectionCode DM_ConnectionCode1();
Returns: TConnectionCode
Extension method of IViolationHelper (using EDP;).
DM_ConnectionCode2
No description yet.
TConnectionCode DM_ConnectionCode2();
Returns: TConnectionCode
Extension method of IViolationHelper (using EDP;).
DM_DescriptorString
This method returns the description string for this violation interface.
string DM_DescriptorString();
Returns: string
DM_DetailString
This method returns the detailed description stirng of this violation interface.
string DM_DetailString();
Returns: string
DM_ErrorKind
Returns the kind of error this violation has been assigned to.
TErrorKind DM_ErrorKind();
Returns: TErrorKind
Extension method of IViolationHelper (using EDP;).
DM_ErrorLevel
Returns the level of error this violation has been assigned to. Various error levels include : eErrorLevelNoReport,eErrorLevelWarning,eErrorLevelError,eErrorLevelFatal
TErrorLevel DM_ErrorLevel();
Returns: TErrorLevel
Extension method of IViolationHelper (using EDP;).
DM_IsSuppressed
No description yet.
bool DM_IsSuppressed();
Returns: bool
DM_RelatedObjectCount
This method returns the number of related objects of the violation.
int DM_RelatedObjectCount();
Returns: int
DM_RelatedObjects
This method returns the indexed related object of the violation.
IDMObject DM_RelatedObjects(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IDMObject
Extension method of IViolationHelper (using EDP;).
Inherited members
- From IDMObject: DM_CalculateParameterValue, DM_CurrentSheetInstanceNumber, DM_FullCrossProbeString, DM_GeneralField, DM_GetVCSProject, DM_ImageIndex, DM_IsFormulaString, DM_IsInferredObject, DM_LocationString, DM_LocationX, DM_LocationY, DM_LongDescriptorString, DM_NetIndex_Flat, DM_NetIndex_Sheet, DM_NetIndex_SubNet, DM_ObjectKindString, DM_ObjectKindStringForCrossProbe, DM_OwnerDocument, DM_OwnerDocumentFullPath, DM_OwnerDocumentName, DM_ParameterCount, DM_Parameters, DM_PcbHandle, DM_PCBObjectHandle, DM_PCBObjectInterface, DM_PrimaryCrossProbeString, DM_SchHandle, DM_SCHObjectHandle, DM_SCHObjectInterface, DM_SecondaryCrossProbeString, DM_SetVCSProject, DM_SheetIndex_Logical, DM_SheetIndex_Physical, DM_ShortDescriptorString, DM_ValidForNavigation, DM_VHDLEntity