Altium C++ SDK 3.0
Loading...
Searching...
No Matches
PCB::IPCB_Rule Struct Reference

#include <EDP.PCB.Interfaces.h>

Inheritance diagram for PCB::IPCB_Rule:
PCB::IPCB_Primitive PCB::IPCB_AcuteAngle PCB::IPCB_BrokenNetRule PCB::IPCB_CheckNetAntennaeRule PCB::IPCB_ClearanceConstraint PCB::IPCB_ComponentClearanceConstraint PCB::IPCB_ComponentRotationsRule PCB::IPCB_ConfinementConstraint PCB::IPCB_DaisyChainStubLengthConstraint PCB::IPCB_DifferentialPairsRoutingRule PCB::IPCB_FanoutControlRule PCB::IPCB_HoleToHoleClearanceRule PCB::IPCB_LayerPairsRule PCB::IPCB_MatchedNetLengthsConstraint PCB::IPCB_MaxMinHeightConstraint PCB::IPCB_MaxMinHoleSizeConstraint PCB::IPCB_MaxMinLengthConstraint PCB::IPCB_MaxMinWidthConstraint PCB::IPCB_MaxOvershootFall PCB::IPCB_MaxOvershootRise PCB::IPCB_MaxUndershootFall PCB::IPCB_MaxUndershootRise PCB::IPCB_MaximumViaCountRule PCB::IPCB_MinimumAnnularRing PCB::IPCB_MinimumSolderMaskSliverRule PCB::IPCB_ModifiedPolygonRule PCB::IPCB_NetsToIgnoreRule PCB::IPCB_ParallelSegmentConstraint PCB::IPCB_PasteMaskExpansionRule PCB::IPCB_PermittedLayersRule PCB::IPCB_PolygonConnectStyleRule PCB::IPCB_PowerPlaneClearanceRule PCB::IPCB_PowerPlaneConnectStyleRule PCB::IPCB_RoutingCornerStyleRule PCB::IPCB_RoutingLayersRule PCB::IPCB_RoutingPriorityRule PCB::IPCB_RoutingTopologyRule PCB::IPCB_RoutingViaStyleRule PCB::IPCB_RuleFlightTime_FallingEdge PCB::IPCB_RuleFlightTime_RisingEdge PCB::IPCB_RuleMaxMinImpedance PCB::IPCB_RuleMaxSignalBaseValue PCB::IPCB_RuleMaxSlopeFallingEdge PCB::IPCB_RuleMaxSlopeRisingEdge PCB::IPCB_RuleMinSignalTopValue PCB::IPCB_RuleSupplyNets PCB::IPCB_SMDNeckDownConstraint PCB::IPCB_SMDPADEntryConstraint PCB::IPCB_SMDToCornerConstraint PCB::IPCB_SMDToPlaneConstraint PCB::IPCB_ShortCircuitConstraint PCB::IPCB_SignalStimulus PCB::IPCB_SilkToSilkClearanceRule PCB::IPCB_SilkToSolderMaskClearanceRule PCB::IPCB_SolderMaskExpansionRule PCB::IPCB_TestPointStyleRule PCB::IPCB_TestPointUsage PCB::IPCB_UnConnectedPinRule PCB::IPCB_ViasUnderSMDConstraint

Public Member Functions

std::wstring GetState_Scope1Expression ()
std::wstring GetState_Scope2Expression ()
TRuleKind GetState_RuleKind ()
TNetScope GetState_NetScope ()
TRuleLayerKind GetState_LayerKind ()
std::wstring GetState_Comment ()
std::wstring GetState_Name ()
bool GetState_DRCEnabled ()
bool GetState_DefinedByLogicalDocument ()
void SetState_Scope1Expression (std::wstring const Value)
void SetState_Scope2Expression (std::wstring const Value)
void SetState_RuleKind (TRuleKind Value)
void SetState_NetScope (TNetScope Value)
void SetState_LayerKind (TRuleLayerKind Value)
void SetState_Comment (std::wstring Value)
void SetState_Name (std::wstring Value)
void SetState_DRCEnabled (bool Value)
void SetState_DefinedByLogicalDocument (bool Value)
int Priority ()
bool ScopeKindIsValid (TScopeKind AScopeKind)
bool Scope1Includes (IPCB_Primitive *P)
bool Scope2Includes (IPCB_Primitive *P)
bool NetScopeMatches (IPCB_Primitive *P1, IPCB_Primitive *P2)
bool CheckBinaryScope (IPCB_Primitive *P1, IPCB_Primitive *P2)
bool CheckUnaryScope (IPCB_Primitive *P)
std::wstring GetState_DataSummaryString ()
std::wstring GetState_ShortDescriptorString ()
std::wstring GetState_ScopeDescriptorString ()
IPCB_Violation * ActualCheck (IPCB_Primitive *P1, IPCB_Primitive *P2)
bool IsUnary ()
void Export_ToParameters_1 (std::wstring *AParams)
bool ActualCheck_1 (IPCB_Primitive *P1, IPCB_Primitive *P2, DXP::IInterfaceList *Violations)
int GetState_CollisionExpansion ()
std::wstring GetState_ViolationDescriptorString (IPCB_Violation *V)
std::wstring GetWhatsThisHelpString ()
Public Member Functions inherited from PCB::IPCB_Primitive
IPCB_Board * GetState_Board ()
TObjectId GetState_ObjectID ()
TV6_Layer GetState_Layer ()
bool GetState_Selected ()
void SetState_Selected (bool B)
bool GetState_IsPreRoute ()
void SetState_IsPreRoute (bool B)
bool GetState_InSelectionMemory (int Index)
void SetState_InSelectionMemory (int Index, bool Value)
bool GetState_PadCacheRobotFlag ()
void SetState_PadCacheRobotFlag (bool Value)
bool GetState_Enabled ()
void SetState_Enabled (bool Value)
bool GetState_Enabled_Direct ()
void SetState_Enabled_Direct (bool Value)
bool GetState_Enabled_vNet ()
void SetState_Enabled_vNet (bool Value)
bool GetState_Enabled_vPolygon ()
void SetState_Enabled_vPolygon (bool Value)
bool GetState_Enabled_vComponent ()
void SetState_Enabled_vComponent (bool Value)
bool GetState_Enabled_vCoordinate ()
void SetState_Enabled_vCoordinate (bool Value)
bool GetState_Enabled_vDimension ()
void SetState_Enabled_vDimension (bool Value)
bool GetState_Used ()
void SetState_Used (bool Value)
bool GetState_DRCError ()
void SetState_DRCError (bool Value)
bool GetState_MiscFlag1 ()
void SetState_MiscFlag1 (bool Value)
bool GetState_MiscFlag2 ()
void SetState_MiscFlag2 (bool Value)
bool GetState_MiscFlag3 ()
void SetState_MiscFlag3 (bool Value)
bool GetState_EnableDraw ()
void SetState_EnableDraw (bool Value)
bool GetState_Moveable ()
void SetState_Moveable (bool Value)
bool GetState_UserRouted ()
void SetState_UserRouted (bool Value)
bool GetState_TearDrop ()
void SetState_TearDrop (bool Value)
bool GetState_IsTenting ()
void SetState_IsTenting (bool Value)
bool GetState_IsTenting_Top ()
void SetState_IsTenting_Top (bool Value)
bool GetState_IsTenting_Bottom ()
void SetState_IsTenting_Bottom (bool Value)
bool GetState_IsTestPoint_Top ()
void SetState_IsTestPoint_Top (bool Value)
bool GetState_IsTestPoint_Bottom ()
void SetState_IsTestPoint_Bottom (bool Value)
bool GetState_IsAssyTestPoint_Top ()
void SetState_IsAssyTestPoint_Top (bool Value)
bool GetState_IsAssyTestPoint_Bottom ()
void SetState_IsAssyTestPoint_Bottom (bool Value)
bool GetState_IsKeepout ()
void SetState_IsKeepout (bool Value)
bool GetState_AllowGlobalEdit ()
void SetState_AllowGlobalEdit (bool Value)
bool GetState_PolygonOutline ()
void SetState_PolygonOutline (bool Value)
bool GetState_InBoard ()
void SetState_InBoard (bool Value)
bool GetState_InPolygon ()
void SetState_InPolygon (bool Value)
bool GetState_InComponent ()
void SetState_InComponent (bool Value)
bool GetState_InNet ()
void SetState_InNet (bool Value)
bool GetState_InCoordinate ()
void SetState_InCoordinate (bool Value)
bool GetState_InDimension ()
void SetState_InDimension (bool Value)
bool GetState_IsElectricalPrim ()
void SetState_Board (IPCB_Board *ABoard)
void SetState_Layer (TV6_Layer ALayer)
std::wstring GetState_ObjectIDString ()
std::wstring GetState_Identifier ()
std::wstring GetState_DescriptorString ()
std::wstring GetState_DetailString ()
int GetState_Index ()
void SetState_Index (int AIndex)
int GetState_UnionIndex ()
void SetState_UnionIndex (int Value)
TPlaneConnectStyle GetState_PowerPlaneConnectStyle ()
int GetState_ReliefConductorWidth ()
int GetState_ReliefEntries ()
int GetState_ReliefAirGap ()
int GetState_PasteMaskExpansion ()
int GetState_SolderMaskExpansion ()
int GetState_PowerPlaneClearance ()
int GetState_PowerPlaneReliefExpansion ()
IPCB_Net * GetState_Net ()
IPCB_Component * GetState_Component ()
IPCB_Polygon * GetState_Polygon ()
IPCB_Coordinate * GetState_Coordinate ()
IPCB_Dimension * GetState_Dimension ()
TViewableObjectID GetState_ViewableObjectID ()
void SetState_Net (IPCB_Net *Value)
void SetState_Component (IPCB_Component *Value)
void SetState_Polygon (IPCB_Polygon *Value)
void SetState_Coordinate (IPCB_Coordinate *Value)
void SetState_Dimension (IPCB_Dimension *Value)
C_CoordRect BoundingRectangle ()
C_CoordRect BoundingRectangleForSelection ()
C_CoordRect BoundingRectangleForPainting ()
bool IsHidden ()
bool IsFreePrimitive ()
bool IsSaveable (TAdvPCBFileFormatVersion AVer)
void MoveByXY (int AX, int AY)
void MoveToXY (int AX, int AY)
void RotateBy (double Angle)
void FlipXY (int Axis, TMirrorOperation MirrOp)
void SwapLayerPairs ()
void GraphicallyInvalidate ()
void BeginModify ()
void EndModify ()
void CancelModify ()
void Export_ToParameters (std::wstring *AParams)
int RequiredParamterSpace ()
void SetState_V7Layer (C_V7_Layer L)
C_V7_Layer GetState_V7Layer ()
C_CoordRect BoundingRectangleChildren ()
IPCB_Primitive * Replicate ()
std::wstring GetState_UniqueId ()
std::wstring GetState_Handle ()
void SetState_UniqueID (std::wstring const Value)
bool GetState_DrawAsPreview ()
void SetState_DrawAsPreview (bool Value)
void SetState_Preview (bool Enable, long Color, float Opacity, int z, int Height, float sx, float sy, float SZ)

Member Function Documentation

◆ ActualCheck()

IPCB_Violation * PCB::IPCB_Rule::ActualCheck ( IPCB_Primitive * P1,
IPCB_Primitive * P2 )

◆ ActualCheck_1()

bool PCB::IPCB_Rule::ActualCheck_1 ( IPCB_Primitive * P1,
IPCB_Primitive * P2,
DXP::IInterfaceList * Violations )

◆ CheckBinaryScope()

bool PCB::IPCB_Rule::CheckBinaryScope ( IPCB_Primitive * P1,
IPCB_Primitive * P2 )

◆ CheckUnaryScope()

bool PCB::IPCB_Rule::CheckUnaryScope ( IPCB_Primitive * P)

◆ Export_ToParameters_1()

void PCB::IPCB_Rule::Export_ToParameters_1 ( std::wstring * AParams)

◆ GetState_CollisionExpansion()

int PCB::IPCB_Rule::GetState_CollisionExpansion ( )

◆ GetState_Comment()

std::wstring PCB::IPCB_Rule::GetState_Comment ( )

◆ GetState_DataSummaryString()

std::wstring PCB::IPCB_Rule::GetState_DataSummaryString ( )

◆ GetState_DefinedByLogicalDocument()

bool PCB::IPCB_Rule::GetState_DefinedByLogicalDocument ( )

◆ GetState_DRCEnabled()

bool PCB::IPCB_Rule::GetState_DRCEnabled ( )

◆ GetState_LayerKind()

TRuleLayerKind PCB::IPCB_Rule::GetState_LayerKind ( )

◆ GetState_Name()

std::wstring PCB::IPCB_Rule::GetState_Name ( )

◆ GetState_NetScope()

TNetScope PCB::IPCB_Rule::GetState_NetScope ( )

◆ GetState_RuleKind()

TRuleKind PCB::IPCB_Rule::GetState_RuleKind ( )

◆ GetState_Scope1Expression()

std::wstring PCB::IPCB_Rule::GetState_Scope1Expression ( )

◆ GetState_Scope2Expression()

std::wstring PCB::IPCB_Rule::GetState_Scope2Expression ( )

◆ GetState_ScopeDescriptorString()

std::wstring PCB::IPCB_Rule::GetState_ScopeDescriptorString ( )

◆ GetState_ShortDescriptorString()

std::wstring PCB::IPCB_Rule::GetState_ShortDescriptorString ( )

◆ GetState_ViolationDescriptorString()

std::wstring PCB::IPCB_Rule::GetState_ViolationDescriptorString ( IPCB_Violation * V)

◆ GetWhatsThisHelpString()

std::wstring PCB::IPCB_Rule::GetWhatsThisHelpString ( )

◆ IsUnary()

bool PCB::IPCB_Rule::IsUnary ( )

◆ NetScopeMatches()

bool PCB::IPCB_Rule::NetScopeMatches ( IPCB_Primitive * P1,
IPCB_Primitive * P2 )

◆ Priority()

int PCB::IPCB_Rule::Priority ( )

◆ Scope1Includes()

bool PCB::IPCB_Rule::Scope1Includes ( IPCB_Primitive * P)

◆ Scope2Includes()

bool PCB::IPCB_Rule::Scope2Includes ( IPCB_Primitive * P)

◆ ScopeKindIsValid()

bool PCB::IPCB_Rule::ScopeKindIsValid ( TScopeKind AScopeKind)

◆ SetState_Comment()

void PCB::IPCB_Rule::SetState_Comment ( std::wstring Value)

◆ SetState_DefinedByLogicalDocument()

void PCB::IPCB_Rule::SetState_DefinedByLogicalDocument ( bool Value)

◆ SetState_DRCEnabled()

void PCB::IPCB_Rule::SetState_DRCEnabled ( bool Value)

◆ SetState_LayerKind()

void PCB::IPCB_Rule::SetState_LayerKind ( TRuleLayerKind Value)

◆ SetState_Name()

void PCB::IPCB_Rule::SetState_Name ( std::wstring Value)

◆ SetState_NetScope()

void PCB::IPCB_Rule::SetState_NetScope ( TNetScope Value)

◆ SetState_RuleKind()

void PCB::IPCB_Rule::SetState_RuleKind ( TRuleKind Value)

◆ SetState_Scope1Expression()

void PCB::IPCB_Rule::SetState_Scope1Expression ( std::wstring const Value)

◆ SetState_Scope2Expression()

void PCB::IPCB_Rule::SetState_Scope2Expression ( std::wstring const Value)
The documentation for this struct was generated from the following file: