ICMPObject Class

Contains all methods for working with components.

Definition

Namespace: PCBI.Automation
Assembly: PCB-Investigator (in PCB-Investigator.exe) Version: 0
C#
public class ICMPObject : IObject, InterfaceCMPObject, 
	InterfaceObject, IBoundableD
Inheritance
Object    IObject    ICMPObject
Implements
InterfaceCMPObject, InterfaceObject, IBoundableD

Properties

Bounds [read only] Bounds in mils of board location.
CenterPoint [read only] Bounds in mils of board location.
CompHEIGHT Height of the component in mils.
IsSelected Is the object selected?
(Overrides IObjectIsSelected)
LayerName The name of the parent layer.
MirrorX [read only] Mirror in X direction of the component.
MirrorY [read only] Mirror in Y direction of the component.
ObjectColor Get or set the component color. Default added color action to undo buffer, for ignoring undo buffer use ObjectColorTemporary.
(Overrides IObjectObjectColor)
PartName Get partname of the component.
PlacedTop Is the CMP on the top layer?
PolarityMarker The index of the polarity pin (1 based) or -1 if there is no polarity pin defined.
Position Get the position of the CMP.
Ref The "Name" of the Object.
Rotation Rotation of the component.
Tag Space to add optional objects.
(Overrides IObjectTag)
Tolerance [read only] Tolerance of the components value.
Toleranz [read only] Toleranz of the components value. Obsolete will be removed in later versions, please use Tolerance.
Type Gets the type of the object.
(Overrides IObjectType)
UsedPackageName The package name.
Value Get the value as string.
VariantCount [read only] Count of different variants.
Variants [read only] If available is a list of variants of the component.

Methods

AddComponentAttribute Add an attribute or override the value if exist.
ChangePackage Change package with option to update net list.
Clone Clone the component object.
DistanceTo(ICMPObject, Boolean) Calculate the distance between two objects.
DistanceTo(InterfaceCMPObject, Boolean) Calculate the distance between two objects.
DistanceTo(InterfaceODBObject, Boolean) Calculate the distance between two objects.
DistanceTo(IODBObject, Boolean) Calculate the distance between two objects.
DistanceTo(ICMPObject, PointF, PointF, Boolean) Calculate the distance between two objects.
DistanceTo(InterfaceCMPObject, PointF, PointF, Boolean) Calculate the distance between two objects.
Equals Compares two components.
(Overrides ObjectEquals(Object))
EqualsNull Determines whether the component is null.
GetAreaOutline Gets the transformed Area Polygon of a component null if area does not exist
GetAttributes The Attributes of the Object
(Inherited from IObject)
GetBodyBoundsD The bounds of the component body (without Pins). Max of Package-Body and Real_Body_Outline!
GetBodyBoundsD(Boolean) The bounds of the component body (without Pins). Max of Package-Body and Real_Body_Outline if IncludeMPNOutline = true otherwise CAD body bounds!
GetBounds The size of the object.
(Overrides IObjectGetBounds)
GetBoundsD The bounds of the object.
(Overrides IObjectGetBoundsD)
GetCADPinsPerMPNPins Check foreach MPN pin the location in this component and return a list of intersecting pins.
GetComponentAttributeClasses GetComponentAtributes returns a Dictionary of strings with all component attributes.
GetComponentAttributeDictionary GetComponentAtributes returns a Dictionary of strings with all component attributes.
GetComponentAttributeHashtable GetComponentAtributes returns a Hashtable of strings with all component attributes.
GetComponentAttributes GetComponentAtributes returns a list of strings with all component attributes. This list contains used geometry attributes and component attributes!
GetComponentImage Create a image of the component.
GetGeometryAttributes Returns a stringlist with all geometry attributes.
GetGeometryAttributesHashtable Returns a Hashtable with all geometry attributes.
GetHashCode Gets the HashCode.
(Overrides ObjectGetHashCode)
GetInterfacePinList Returns all Pins of the Component (in the order of the package pin definition).
GetMPNPackageBodyPoly Creates outline of the MPNPackage as IPolyClass or returns null
GetMPNPackageData Returns MPNPackageData if exists. Should not be edited here!
GetMPNPackageMatrix Returns Transformation Matrix for the MPNPackageData if exists. Should not be edited here!
GetMPNPackagePinPolys Creates outline of the MPNPackage Pins as IPolyClass or returns empty list
GetOutline Creates a list of all elements building the outline. This includes no pins!
(Overrides IObjectGetOutline)
GetOutline(Boolean) Creates a list of all elements building the outline.
GetOutlineD Creates a list of all elements building the outline. This includes no pins!
(Overrides IObjectGetOutlineD)
GetPackageSpecifics Creates the IPackageSpecifics of the component package.
GetPackageSpecificsD Creates the IPackageSpecificsD of the component package.
GetPackageSurfaceSpecificsD Create a surface from the outline of the package.
GetPin(Int32) Get pin by package index.
GetPin(String) Returns the Pin with its PinLabel or false if the value is null.
GetPinConnectionToBoardNet(InterfaceStep, NullableBoolean) Calculate the diameter of all outgoing elements
GetPinConnectionToBoardNet(IStep, NullableBoolean) Calculate the diameter of all outgoing elements
GetPinCount Returns pin count of the component
GetPinList Returns all Pins of the Component (in the order of the package pin definition).
GetPolygonOutline Creates outline as IPolyClass without pins (only body).
(Overrides IObjectGetPolygonOutline)
GetPolygonOutline(Boolean) Creates outline as IPolyClass
GetPosition Get the position of the component as PointD.
GetSimplePolygonOutline Creates outline as IPolyClass. This is simple outline with only closed outline parts (e.g. genCad files contain often single lines or non closed structures).
GetSpecialAreaColor Returns the set color for a given AreaType. Areas are only drawn, when activated in PCBI.Automation.DrawingParameters.IComponentParameters
GetSpecifics Gets a ObjectSpecifics (e.g. PadSpecifics) with special data.
(Overrides IObjectGetSpecifics)
GetSpecificsD Gets a ObjectSpecifics (e.g. PadSpecifics) with special data.
(Overrides IObjectGetSpecificsD)
GetTangentLayerName Search for the contact signal layer.
GetTransformMatrix Returns the transformation matrix with translation, rotation and mirroring
HasAreaDefinition Returns true when package of this component contains the given area definition.
IsInComponent(PointD) Checks whether the point is included in the components bounds.
IsInComponent(PointF) Checks whether the point is included in the components bounds.
IsPointOfSecondObjectIncluded(ICMPObject, Boolean) Returns true if the SecondObject have a Point in this object.
IsPointOfSecondObjectIncluded(InterfaceCMPObject, Boolean) Returns true if the SecondObject has a Point in this object.
IsPointOfSecondObjectIncluded(InterfaceODBObject, Boolean) Returns true if the SecondObject has a Point in this object.
IsPointOfSecondObjectIncluded(IODBObject, Boolean) Returns true if the SecondObject have a Point in this object.
Mirror Mirror the component in X direction.
ObjectColorTemporary Set the component color temporary, whitout event for need save changes. Caution: If you save while the object exists is the color added!
(Overrides IObjectObjectColorTemporary(Color))
RemoveAttribute(String) Remove an attribute from this component.
RemoveAttribute(String, Boolean) Remove an attribute from this component.
ReplaceItemBy(ICMPObject) Replace this object by other object on same position of layer element list.
ReplaceItemBy(InterfaceCMPObject) Replace this object by other object on same position of layer element list.
ResetColor Resets the set color
(Overrides IObjectResetColor)
ResetSpecialAreaColors Resets all AreaType Colors to default Areas are only drawn, when activated in PCBI.Automation.DrawingParameters.IComponentParameters
Select Select the object respectively deselect the object.
(Overrides IObjectSelect(Boolean))
SetSpecialAreaColor Sets the color for a given AreaType. Color.Empty resets to default drawing like defined in the DrawingParameters Areas are only drawn, when activated in PCBI.Automation.DrawingParameters.IComponentParameters
SetSpecifics(InterfaceObjectSpecificsD) Set the specific values of the object
(Inherited from IObject)
SetSpecifics(IObjectSpecifics) Set the specific values of the component.
(Overrides IObjectSetSpecifics(IObjectSpecifics))
SetSpecifics(IObjectSpecificsD) Set the specific values of the component.
(Overrides IObjectSetSpecifics(IObjectSpecificsD))
SetSpecifics(IComponentSpecifics, IPackageSpecifics) Set the specific values of the component and update netlist.
SetSpecifics(IComponentSpecificsD, IPackageSpecificsD) Set the specific values of the component and update netlist.
SetSpecifics(InterfaceComponentSpecificsD, InterfacePackageSpecificsD) Set the specific values of the component.
ToString
(Overrides ObjectToString)

Operators

Equality(ICMPObject, ICMPObject) override the operator == to campair two components
Inequality(ICMPObject, ICMPObject) override the operator !=

Fields

Extension Methods

CreateGuid
(Defined by GUIDExtensions)
GetGuid
(Defined by GUIDExtensions)
GetPropValue
(Defined by ExtensionsMethods)
GetTransformedPolyClasses Get all transformed elements foreach object on this component layer with the transformed matrix list.
(Defined by VirtualStepAndRepeatExtensions)

See Also