KiCad PCB EDA Suite
class_module.h File Reference
#include <deque>
#include <board_item_container.h>
#include <class_board_item.h>
#include <collectors.h>
#include <convert_to_biu.h>
#include <layers_id_colors_and_visibility.h>
#include <lib_id.h>
#include <list>
#include "zones.h"
#include <class_text_mod.h>
#include <class_zone.h>
#include <functional>

Go to the source code of this file.

Classes

class  MODULE_3D_SETTINGS
 
struct  MODULE_3D_SETTINGS::VECTOR3D
 
class  MODULE
 
struct  MODULE::cmp_drawings
 
struct  MODULE::cmp_pads
 

Namespaces

 KIGFX
 Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
 

Macros

#define MODULE_is_LOCKED   0x01
 module LOCKED: no autoplace allowed More...
 
#define MODULE_is_PLACED   0x02
 In autoplace: module automatically placed. More...
 
#define MODULE_to_PLACE   0x04
 In autoplace: module waiting for autoplace. More...
 
#define MODULE_PADS_LOCKED   0x08
 In autoplace: module waiting for autoplace. More...
 

Enumerations

enum  INCLUDE_NPTH_T { DO_NOT_INCLUDE_NPTH = false, INCLUDE_NPTH = true }
 
enum  MODULE_ATTR_T {
  MOD_THROUGH_HOLE = 0x0001, MOD_SMD = 0x0002, MOD_EXCLUDE_FROM_POS_FILES = 0x0004, MOD_EXCLUDE_FROM_BOM = 0x0008,
  MOD_BOARD_ONLY = 0x0010
}
 Enum MODULE_ATTR_T is the set of attributes allowed within a MODULE, using MODULE::SetAttributes() and MODULE::GetAttributes(). More...
 

Macro Definition Documentation

◆ MODULE_is_LOCKED

#define MODULE_is_LOCKED   0x01

module LOCKED: no autoplace allowed

Definition at line 305 of file class_module.h.

◆ MODULE_is_PLACED

#define MODULE_is_PLACED   0x02

In autoplace: module automatically placed.

Definition at line 306 of file class_module.h.

◆ MODULE_PADS_LOCKED

#define MODULE_PADS_LOCKED   0x08

In autoplace: module waiting for autoplace.

Definition at line 308 of file class_module.h.

◆ MODULE_to_PLACE

#define MODULE_to_PLACE   0x04

In autoplace: module waiting for autoplace.

Definition at line 307 of file class_module.h.

Enumeration Type Documentation

◆ INCLUDE_NPTH_T

Enumerator
DO_NOT_INCLUDE_NPTH 
INCLUDE_NPTH 

Definition at line 54 of file class_module.h.

55 {
56  DO_NOT_INCLUDE_NPTH = false,
57  INCLUDE_NPTH = true
58 };

◆ MODULE_ATTR_T

Enum MODULE_ATTR_T is the set of attributes allowed within a MODULE, using MODULE::SetAttributes() and MODULE::GetAttributes().

These are to be ORed together when calling MODULE::SetAttributes()

Enumerator
MOD_THROUGH_HOLE 
MOD_SMD 
MOD_EXCLUDE_FROM_POS_FILES 
MOD_EXCLUDE_FROM_BOM 
MOD_BOARD_ONLY 

Definition at line 66 of file class_module.h.

67 {
68  MOD_THROUGH_HOLE = 0x0001,
69  MOD_SMD = 0x0002,
71  MOD_EXCLUDE_FROM_BOM = 0x0008,
72  MOD_BOARD_ONLY = 0x0010 // Footprint has no corresponding symbol
73 };