KiCad PCB EDA Suite
LAYER Struct Reference

Container to hold information pertinent to a layer of a BOARD. More...

#include <board.h>

Public Member Functions

 LAYER ()
 
void clear ()
 

Static Public Member Functions

static const char * ShowType (LAYER_T aType)
 Convert a LAYER_T enum to a string representation of the layer type. More...
 
static LAYER_T ParseType (const char *aType)
 Convert a string to a LAYER_T. More...
 

Public Attributes

wxString m_name
 The canonical name of the layer. More...
 
wxString m_userName
 The user defined name of the layer. More...
 
LAYER_T m_type
 The type of the layer. More...
 
bool m_visible
 
int m_number
 The layer ID. More...
 

Detailed Description

Container to hold information pertinent to a layer of a BOARD.

Definition at line 81 of file board.h.

Constructor & Destructor Documentation

◆ LAYER()

LAYER::LAYER ( )
inline

Definition at line 83 of file board.h.

84  {
85  clear();
86  }
void clear()
Definition: board.h:88

References clear().

Member Function Documentation

◆ clear()

void LAYER::clear ( )
inline

Definition at line 88 of file board.h.

89  {
90  m_type = LT_SIGNAL;
91  m_visible = true;
92  m_number = 0;
93  m_name.clear();
94  m_userName.clear();
95  }
wxString m_name
The canonical name of the layer.
Definition: board.h:108
LAYER_T m_type
The type of the layer.
Definition: board.h:110
bool m_visible
Definition: board.h:111
wxString m_userName
The user defined name of the layer.
Definition: board.h:109
int m_number
The layer ID.
Definition: board.h:112

References LT_SIGNAL, m_name, m_number, m_type, m_userName, and m_visible.

Referenced by LAYER(), and PCB_PARSER::parseLayer().

◆ ParseType()

LAYER_T LAYER::ParseType ( const char *  aType)
static

Convert a string to a LAYER_T.

Parameters
aTypeThe layer name to convert.
Returns
The binary representation of the layer type, or LAYER_T(-1) if the string is invalid.

Definition at line 440 of file board.cpp.

441 {
442  if( strcmp( aType, "signal" ) == 0 )
443  return LT_SIGNAL;
444  else if( strcmp( aType, "power" ) == 0 )
445  return LT_POWER;
446  else if( strcmp( aType, "mixed" ) == 0 )
447  return LT_MIXED;
448  else if( strcmp( aType, "jumper" ) == 0 )
449  return LT_JUMPER;
450  else
451  return LT_UNDEFINED;
452 }
Definition: board.h:72
Definition: board.h:73

References LT_JUMPER, LT_MIXED, LT_POWER, LT_SIGNAL, and LT_UNDEFINED.

Referenced by LEGACY_PLUGIN::loadSETUP(), and PCB_PARSER::parseLayer().

◆ ShowType()

const char * LAYER::ShowType ( LAYER_T  aType)
static

Convert a LAYER_T enum to a string representation of the layer type.

Parameters
aTypeThe LAYER_T to convert
Returns
The string representation of the layer type.

Definition at line 427 of file board.cpp.

428 {
429  switch( aType )
430  {
431  default:
432  case LT_SIGNAL: return "signal";
433  case LT_POWER: return "power";
434  case LT_MIXED: return "mixed";
435  case LT_JUMPER: return "jumper";
436  }
437 }
Definition: board.h:72
Definition: board.h:73

References LT_JUMPER, LT_MIXED, LT_POWER, and LT_SIGNAL.

Referenced by PCB_IO::formatBoardLayers().

Member Data Documentation

◆ m_name

wxString LAYER::m_name

The canonical name of the layer.

See also
LSET::Name

Definition at line 108 of file board.h.

Referenced by BOARD::BOARD(), clear(), PCB_PARSER::parseLayer(), and PCB_PARSER::parseLayers().

◆ m_number

int LAYER::m_number

The layer ID.

See also
PCB_LAYER_ID

Definition at line 112 of file board.h.

Referenced by clear(), PCB_PARSER::parseLayer(), and PCB_PARSER::parseLayers().

◆ m_type

LAYER_T LAYER::m_type

The type of the layer.

See also
LAYER_T

Definition at line 110 of file board.h.

Referenced by BOARD::BOARD(), clear(), BOARD::GetLayerType(), PCB_PARSER::parseLayer(), PCB_PARSER::parseLayers(), and BOARD::SetLayerType().

◆ m_userName

wxString LAYER::m_userName

The user defined name of the layer.

Definition at line 109 of file board.h.

Referenced by clear(), PCB_PARSER::parseLayer(), and BOARD::SetLayerName().

◆ m_visible

bool LAYER::m_visible

Definition at line 111 of file board.h.

Referenced by clear(), PCB_PARSER::parseLayer(), and PCB_PARSER::parseLayers().


The documentation for this struct was generated from the following files: