LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
librepcb::library Namespace Reference

Namespaces

 editor
 
 manager
 

Classes

class  CmdLibraryCategoryEdit
 The CmdLibraryCategoryEdit class. More...
 
class  ComponentCategory
 The ComponentCategory class. More...
 
class  LibraryCategory
 The LibraryCategory class extends the LibraryBaseElement class with some attributes and methods which are used for all library category classes. More...
 
class  PackageCategory
 The PackageCategory class. More...
 
class  CmdLibraryBaseElementEdit
 The CmdLibraryBaseElementEdit class. More...
 
class  CmdLibraryEdit
 The CmdLibraryEdit class. More...
 
class  CmdLibraryElementEdit
 The CmdLibraryElementEdit class. More...
 
class  CmdComponentEdit
 The CmdComponentEdit class. More...
 
class  CmdComponentSignalEdit
 The CmdComponentSignalEdit class. More...
 
class  CmdComponentSymbolVariantEdit
 The CmdComponentSymbolVariantEdit class. More...
 
class  CmpSigPinDisplayType
 The CmpSigPinDisplayType clas. More...
 
struct  NormDependentPrefixMapPolicy
 
class  Component
 The Component class represents a "generic" device in the library. More...
 
class  ComponentCheck
 The ComponentCheck class. More...
 
class  ComponentPinSignalMapItem
 The ComponentPinSignalMapItem class maps a symbol pin to a component signal. More...
 
struct  ComponentPinSignalMapNameProvider
 
class  ComponentPinSignalMapHelpers
 
struct  ComponentPrefixVerifier
 
struct  ComponentPrefixConstraint
 
class  ComponentSignal
 The ComponentSignal class represents one signal of a component. More...
 
struct  ComponentSignalListNameProvider
 
class  ComponentSymbolVariant
 The ComponentSymbolVariant class represents a symbol variant of a component. More...
 
struct  ComponentSymbolVariantListNameProvider
 
class  ComponentSymbolVariantItem
 The ComponentSymbolVariantItem class represents one symbol of a component symbol variant. More...
 
struct  ComponentSymbolVariantItemListNameProvider
 
class  ComponentSymbolVariantItemListHelpers
 
struct  ComponentSymbolVariantItemSuffixVerifier
 
struct  ComponentSymbolVariantItemSuffixConstraint
 
class  MsgDuplicateSignalName
 The MsgDuplicateSignalName class. More...
 
class  MsgMissingComponentDefaultValue
 The MsgMissingComponentDefaultValue class. More...
 
class  MsgMissingComponentPrefix
 The MsgMissingComponentPrefix class. More...
 
class  MsgMissingSymbolVariant
 The MsgMissingSymbolVariant class. More...
 
class  MsgMissingSymbolVariantItem
 The MsgMissingSymbolVariantItem class. More...
 
class  CmdDeviceEdit
 The CmdDeviceEdit class. More...
 
class  CmdDevicePadSignalMapItemEdit
 The CmdDevicePadSignalMapItemEdit class. More...
 
class  Device
 The Device class represents an instance of a component (a "real" component) More...
 
class  DevicePadSignalMapItem
 The DevicePadSignalMapItem class. More...
 
struct  DevicePadSignalMapNameProvider
 
class  DevicePadSignalMapHelpers
 
class  Library
 The Library class represents a library directory. More...
 
class  LibraryBaseElement
 The LibraryBaseElement class. More...
 
class  LibraryBaseElementCheck
 The LibraryBaseElementCheck class. More...
 
class  LibraryElement
 The LibraryElement class extends the LibraryBaseElement class with some attributes and methods which are used for all library classes except categories. More...
 
class  LibraryElementCheck
 The LibraryElementCheck class. More...
 
class  LibraryElementCheckMessage
 The LibraryElementCheckMessage class. More...
 
class  MsgMissingAuthor
 The MsgMissingAuthor class. More...
 
class  MsgMissingCategories
 The MsgMissingCategories class. More...
 
class  MsgNameNotTitleCase
 The MsgNameNotTitleCase class. More...
 
class  CmdFootprintEdit
 The CmdFootprintEdit class. More...
 
class  CmdFootprintPadEdit
 The CmdFootprintPadEdit class. More...
 
class  CmdPackagePadEdit
 The CmdPackagePadEdit class. More...
 
class  Footprint
 The Footprint class represents one footprint variant of a package. More...
 
struct  FootprintListNameProvider
 
class  FootprintGraphicsItem
 The FootprintGraphicsItem class. More...
 
class  FootprintPad
 The FootprintPad class represents a pad of a footprint. More...
 
struct  FootprintPadListNameProvider
 
class  FootprintPadGraphicsItem
 The FootprintPadGraphicsItem class. More...
 
class  FootprintPadPreviewGraphicsItem
 The FootprintPadPreviewGraphicsItem class. More...
 
class  FootprintPreviewGraphicsItem
 The FootprintPreviewGraphicsItem class. More...
 
class  MsgDuplicatePadName
 The MsgDuplicatePadName class. More...
 
class  MsgMissingFootprint
 The MsgMissingFootprint class. More...
 
class  MsgMissingFootprintName
 The MsgMissingFootprintName class. More...
 
class  MsgMissingFootprintValue
 The MsgMissingFootprintValue class. More...
 
class  MsgPadOverlapsWithPlacement
 The MsgPadOverlapsWithPlacement class. More...
 
class  MsgWrongFootprintTextLayer
 The MsgWrongFootprintTextLayer class. More...
 
class  Package
 The Package class represents a package of a component (including footprint and 3D model) More...
 
class  PackageCheck
 The PackageCheck class. More...
 
class  PackagePad
 The PackagePad class represents one logical pad of a package. More...
 
struct  PackagePadListNameProvider
 
class  CmdSymbolPinEdit
 The CmdSymbolPinEdit class. More...
 
class  MsgDuplicatePinName
 The MsgDuplicatePinName class. More...
 
class  MsgMissingSymbolName
 The MsgMissingSymbolName class. More...
 
class  MsgMissingSymbolValue
 The MsgMissingSymbolValue class. More...
 
class  MsgOverlappingSymbolPins
 The MsgOverlappingSymbolPins class. More...
 
class  MsgSymbolPinNotOnGrid
 The MsgSymbolPinNotOnGrid class. More...
 
class  MsgWrongSymbolTextLayer
 The MsgWrongSymbolTextLayer class. More...
 
class  Symbol
 The Symbol class represents the part of a component which is added to schematics. More...
 
class  SymbolCheck
 The SymbolCheck class. More...
 
class  SymbolGraphicsItem
 The SymbolGraphicsItem class. More...
 
class  SymbolPin
 The SymbolPin class represents one pin of a symbol. More...
 
struct  SymbolPinListNameProvider
 
class  SymbolPinGraphicsItem
 The SymbolPinGraphicsItem class. More...
 
class  SymbolPinPreviewGraphicsItem
 The SymbolPinPreviewGraphicsItem class. More...
 
class  SymbolPreviewGraphicsItem
 The SymbolPreviewGraphicsItem class. More...
 

Typedefs

using NormDependentPrefixMap = SerializableKeyValueMap< NormDependentPrefixMapPolicy >
 
using ComponentPinSignalMap = SerializableObjectList< ComponentPinSignalMapItem, ComponentPinSignalMapNameProvider >
 
using CmdComponentPinSignalMapItemInsert = CmdListElementInsert< ComponentPinSignalMapItem, ComponentPinSignalMapNameProvider >
 
using CmdComponentPinSignalMapItemRemove = CmdListElementRemove< ComponentPinSignalMapItem, ComponentPinSignalMapNameProvider >
 
using CmdComponentPinSignalMapItemsSwap = CmdListElementsSwap< ComponentPinSignalMapItem, ComponentPinSignalMapNameProvider >
 
using ComponentPrefix = type_safe::constrained_type< QString, ComponentPrefixConstraint, ComponentPrefixVerifier >
 
using ComponentSignalList = SerializableObjectList< ComponentSignal, ComponentSignalListNameProvider >
 
using CmdComponentSignalInsert = CmdListElementInsert< ComponentSignal, ComponentSignalListNameProvider >
 
using CmdComponentSignalRemove = CmdListElementRemove< ComponentSignal, ComponentSignalListNameProvider >
 
using CmdComponentSignalsSwap = CmdListElementsSwap< ComponentSignal, ComponentSignalListNameProvider >
 
using ComponentSymbolVariantList = SerializableObjectList< ComponentSymbolVariant, ComponentSymbolVariantListNameProvider >
 
using CmdComponentSymbolVariantInsert = CmdListElementInsert< ComponentSymbolVariant, ComponentSymbolVariantListNameProvider >
 
using CmdComponentSymbolVariantRemove = CmdListElementRemove< ComponentSymbolVariant, ComponentSymbolVariantListNameProvider >
 
using CmdComponentSymbolVariantsSwap = CmdListElementsSwap< ComponentSymbolVariant, ComponentSymbolVariantListNameProvider >
 
using ComponentSymbolVariantItemList = SerializableObjectList< ComponentSymbolVariantItem, ComponentSymbolVariantItemListNameProvider >
 
using CmdComponentSymbolVariantItemInsert = CmdListElementInsert< ComponentSymbolVariantItem, ComponentSymbolVariantItemListNameProvider >
 
using CmdComponentSymbolVariantItemRemove = CmdListElementRemove< ComponentSymbolVariantItem, ComponentSymbolVariantItemListNameProvider >
 
using CmdComponentSymbolVariantItemsSwap = CmdListElementsSwap< ComponentSymbolVariantItem, ComponentSymbolVariantItemListNameProvider >
 
using ComponentSymbolVariantItemSuffix = type_safe::constrained_type< QString, ComponentSymbolVariantItemSuffixConstraint, ComponentSymbolVariantItemSuffixVerifier >
 
using DevicePadSignalMap = SerializableObjectList< DevicePadSignalMapItem, DevicePadSignalMapNameProvider >
 
using CmdDevicePadSignalMapItemInsert = CmdListElementInsert< DevicePadSignalMapItem, DevicePadSignalMapNameProvider >
 
using CmdDevicePadSignalMapItemRemove = CmdListElementRemove< DevicePadSignalMapItem, DevicePadSignalMapNameProvider >
 
using CmdDevicePadSignalMapItemsSwap = CmdListElementsSwap< DevicePadSignalMapItem, DevicePadSignalMapNameProvider >
 
typedef QVector
< std::shared_ptr< const
LibraryElementCheckMessage > > 
LibraryElementCheckMessageList
 
using FootprintList = SerializableObjectList< Footprint, FootprintListNameProvider >
 
using CmdFootprintInsert = CmdListElementInsert< Footprint, FootprintListNameProvider >
 
using CmdFootprintRemove = CmdListElementRemove< Footprint, FootprintListNameProvider >
 
using CmdFootprintsSwap = CmdListElementsSwap< Footprint, FootprintListNameProvider >
 
using FootprintPadList = SerializableObjectList< FootprintPad, FootprintPadListNameProvider >
 
using CmdFootprintPadInsert = CmdListElementInsert< FootprintPad, FootprintPadListNameProvider >
 
using CmdFootprintPadRemove = CmdListElementRemove< FootprintPad, FootprintPadListNameProvider >
 
using CmdFootprintPadsSwap = CmdListElementsSwap< FootprintPad, FootprintPadListNameProvider >
 
using PackagePadList = SerializableObjectList< PackagePad, PackagePadListNameProvider >
 
using CmdPackagePadInsert = CmdListElementInsert< PackagePad, PackagePadListNameProvider >
 
using CmdPackagePadRemove = CmdListElementRemove< PackagePad, PackagePadListNameProvider >
 
using CmdPackagePadsSwap = CmdListElementsSwap< PackagePad, PackagePadListNameProvider >
 
using SymbolPinList = SerializableObjectList< SymbolPin, SymbolPinListNameProvider >
 
using CmdSymbolPinInsert = CmdListElementInsert< SymbolPin, SymbolPinListNameProvider >
 
using CmdSymbolPinRemove = CmdListElementRemove< SymbolPin, SymbolPinListNameProvider >
 
using CmdSymbolPinsSwap = CmdListElementsSwap< SymbolPin, SymbolPinListNameProvider >
 

Typedef Documentation

using ComponentPrefix = type_safe::constrained_type<QString, ComponentPrefixConstraint, ComponentPrefixVerifier>

ComponentPrefix is a wrapper around QString which guarantees to contain a valid prefix used for librepcb::library::Component (e.g. "R" for a resistor)

A component prefix is considered as valid if it:

  • contains only the characters [a-zA-Z_]
  • is not longer than 16 characters

The constructor throws an exception if constructed from a QString which is not a valid component prefix according these rules.

ComponentSymbolVariantItemSuffix is a wrapper around QString which guarantees to contain a valid suffix used for librepcb::library::ComponentSymbolVariantItem

Such a suffix is considered as valid if it:

  • contains only the characters [0-9a-zA-Z_-]
  • is not longer than 16 characters

The constructor throws an exception if constructed from a QString which is not a valid suffix according these rules.

typedef QVector<std::shared_ptr<const LibraryElementCheckMessage> > LibraryElementCheckMessageList