KiCad PCB EDA Suite
LAYER Struct Reference

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

#include <class_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 75 of file class_board.h.

Constructor & Destructor Documentation

◆ LAYER()

LAYER::LAYER ( )
inline

Definition at line 77 of file class_board.h.

78  {
79  clear();
80  }
void clear()
Definition: class_board.h:82

References clear().

Member Function Documentation

◆ clear()

void LAYER::clear ( )
inline

Definition at line 82 of file class_board.h.

83  {
84  m_type = LT_SIGNAL;
85  m_visible = true;
86  m_number = 0;
87  m_name.clear();
88  m_userName.clear();
89  }
wxString m_name
The canonical name of the layer.
Definition: class_board.h:102
LAYER_T m_type
The type of the layer.
Definition: class_board.h:104
bool m_visible
Definition: class_board.h:105
wxString m_userName
The user defined name of the layer.
Definition: class_board.h:103
int m_number
The layer ID.
Definition: class_board.h:106

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 const char* to convert
Returns
LAYER_T - The binary representation of the layer type, or LAYER_T(-1) if the string is invalid

Definition at line 407 of file class_board.cpp.

408 {
409  if( strcmp( aType, "signal" ) == 0 )
410  return LT_SIGNAL;
411  else if( strcmp( aType, "power" ) == 0 )
412  return LT_POWER;
413  else if( strcmp( aType, "mixed" ) == 0 )
414  return LT_MIXED;
415  else if( strcmp( aType, "jumper" ) == 0 )
416  return LT_JUMPER;
417  else
418  return LT_UNDEFINED;
419 }

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
const char* - The string representation of the layer type.

Definition at line 394 of file class_board.cpp.

395 {
396  switch( aType )
397  {
398  default:
399  case LT_SIGNAL: return "signal";
400  case LT_POWER: return "power";
401  case LT_MIXED: return "mixed";
402  case LT_JUMPER: return "jumper";
403  }
404 }

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 102 of file class_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 106 of file class_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 104 of file class_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 103 of file class_board.h.

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

◆ m_visible

bool LAYER::m_visible

Definition at line 105 of file class_board.h.

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


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