KiCad PCB EDA Suite
class_module.h File Reference

Module description (excepted pads) More...

#include <list>
#include <dlist.h>
#include <layers_id_colors_and_visibility.h>
#include <class_board_item.h>
#include <board_item_container.h>
#include <lib_id.h>
#include <class_text_mod.h>
#include <PolyLine.h>
#include "zones.h"
#include <3d_cache/3d_info.h>
#include <functional>

Go to the source code of this file.

Classes

class  MODULE
 

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_DEFAULT = 0, MOD_CMS = 1, MOD_VIRTUAL = 2 }
 Enum MODULE_ATTR_T is the set of attributes allowed within a MODULE, using MODULE::SetAttributes() and MODULE::GetAttributes(). More...
 

Detailed Description

Module description (excepted pads)

Definition in file class_module.h.

Macro Definition Documentation

#define MODULE_is_LOCKED   0x01

module LOCKED: no autoplace allowed

Definition at line 218 of file class_module.h.

Referenced by MODULE::IsLocked(), and MODULE::SetLocked().

#define MODULE_is_PLACED   0x02

In autoplace: module automatically placed.

Definition at line 219 of file class_module.h.

Referenced by MODULE::GetMsgPanelInfo(), MODULE::IsPlaced(), and MODULE::SetIsPlaced().

#define MODULE_PADS_LOCKED   0x08

In autoplace: module waiting for autoplace.

Definition at line 221 of file class_module.h.

Referenced by MODULE::MODULE(), MODULE::PadsLocked(), and MODULE::SetPadsLocked().

#define MODULE_to_PLACE   0x04

In autoplace: module waiting for autoplace.

Definition at line 220 of file class_module.h.

Referenced by MODULE::NeedsPlaced(), and MODULE::SetNeedsPlaced().

Enumeration Type Documentation

Enumerator
DO_NOT_INCLUDE_NPTH 
INCLUDE_NPTH 

Definition at line 62 of file class_module.h.

63 {
64  DO_NOT_INCLUDE_NPTH = false,
65  INCLUDE_NPTH = true
66 };

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_DEFAULT 

default

MOD_CMS 

Set for modules listed in the automatic insertion list (usually SMD footprints)

MOD_VIRTUAL 

Virtual component: when created by copper shapes on board (Like edge card connectors, mounting hole...)

Definition at line 74 of file class_module.h.

75 {
76  MOD_DEFAULT = 0,
77  MOD_CMS = 1,
78  MOD_VIRTUAL = 2
80 };
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:77
default
Definition: class_module.h:76
Virtual component: when created by copper shapes on board (Like edge card connectors, mounting hole...)
Definition: class_module.h:79