X2_ATTRIBUTE_FILEFUNCTION ( from TF.FileFunction in Gerber file) Example file function: TF.FileFunction,Copper,L1,Top*%. More...

#include <X2_gerber_attributes.h>

Inheritance diagram for X2_ATTRIBUTE_FILEFUNCTION:

Public Member Functions
	X2_ATTRIBUTE_FILEFUNCTION (X2_ATTRIBUTE &aAttributeBase)

bool	IsCopper ()
	return true if the filefunction type is "Copper"

bool	IsDrillFile ()

const wxString &	GetFileType ()
	the type of layer (Copper, Soldermask ... )

const wxString &	GetBrdLayerId ()
	the brd layer identifier: Ln, only for Copper type or Top, Bot for other types

const wxString	GetDrillLayerPair ()

const wxString &	GetLPType ()

const wxString &	GetRouteType ()

const wxString &	GetBrdLayerSide ()
	the brd layer Pos: Top, Bot, Inr same as GetBrdLayerId() for non copper type

const wxString &	GetLabel ()
	the filefunction label, if any

int	GetZOrder ()
	the Order of the board layer, from front (Top) side to back (Bot) side

int	GetZSubOrder ()
	the Order of the bdr copper layer, from front (Top) side to back (Bot) side

wxArrayString &	GetPrms ()

const wxString &	GetPrm (int aIdx)

const wxString &	GetAttribute ()

int	GetPrmCount ()

bool	ParseAttribCmd (FILE aFile, char aBuffer, int aBuffSize, char *&aText, int &aLineNum)
	Parse a TF command terminated with a % and fill m_Prms by the parameters found.

void	DbgListPrms ()
	Debug function: print using wxLogMessage le list of parameters.

bool	IsFileFunction ()
	Return true if the attribute is .FileFunction.

bool	IsFileMD5 ()
	Return true if the attribute is .MD5.

bool	IsFilePart ()
	Return true if the attribute is .Part.

Protected Attributes
wxArrayString	m_Prms
	the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.

Private Member Functions
void	set_Z_Order ()
	Initialize the z order priority of the current file, from its attributes.

Private Attributes
int	m_z_order

int	m_z_sub_order

Detailed Description

X2_ATTRIBUTE_FILEFUNCTION ( from TF.FileFunction in Gerber file) Example file function: TF.FileFunction,Copper,L1,Top*%.

Type. Such as copper, solder mask etc.
Position. Specifies where the file appears in the PCB layer structure. Corresponding position substring: Copper layer: L1, L2, L3...to indicate the layer position followed by Top, Inr or Bot. L1 is always the top copper layer. E.g. L2,Inr. Extra layer, e.g. solder mask: Top or Bot - defines the attachment of the layer. Drill/rout layer: E.g. 1,4 - where 1 is the start and 4 is the end copper layer. The pair 1,4 defines the span of the drill/rout file Optional index. This can be used in instances where for example there are two solder masks on the same side. The index counts from the PCB surface outwards.

Definition at line 149 of file X2_gerber_attributes.h.

Constructor & Destructor Documentation

◆ X2_ATTRIBUTE_FILEFUNCTION()

X2_ATTRIBUTE_FILEFUNCTION::X2_ATTRIBUTE_FILEFUNCTION ( X2_ATTRIBUTE & aAttributeBase )

Definition at line 151 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::GetPrmCount(), X2_ATTRIBUTE::GetPrms(), X2_ATTRIBUTE::m_Prms, m_z_order, and set_Z_Order().

Member Function Documentation

◆ DbgListPrms()

void X2_ATTRIBUTE::DbgListPrms ( )

inherited

Debug function: print using wxLogMessage le list of parameters.

Definition at line 76 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::GetPrmCount(), and X2_ATTRIBUTE::m_Prms.

◆ GetAttribute()

const wxString & X2_ATTRIBUTE::GetAttribute ( )

inherited

Returns: the attribute name (for instance .FileFunction) which is given by TF command (i.e. the first parameter read).

Definition at line 59 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by X2_ATTRIBUTE::IsFileFunction(), X2_ATTRIBUTE::IsFileMD5(), and X2_ATTRIBUTE::IsFilePart().

◆ GetBrdLayerId()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerId ( )

the brd layer identifier: Ln, only for Copper type or Top, Bot for other types

Definition at line 172 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), and set_Z_Order().

◆ GetBrdLayerSide()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerSide ( )

the brd layer Pos: Top, Bot, Inr same as GetBrdLayerId() for non copper type

Definition at line 188 of file X2_gerber_attributes.cpp.

References IsCopper(), and X2_ATTRIBUTE::m_Prms.

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), and GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetDrillLayerPair()

const wxString X2_ATTRIBUTE_FILEFUNCTION::GetDrillLayerPair ( )

Returns: the brd layer pair identifier: n,m for drill files (files with m_Prms.Item( 1 ) = "Plated" or "NotPlated")

Definition at line 179 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetFileType()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetFileType ( )

the type of layer (Copper, Soldermask ... )

Definition at line 165 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), IsCopper(), IsDrillFile(), and set_Z_Order().

◆ GetLabel()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetLabel ( )

the filefunction label, if any

Definition at line 199 of file X2_gerber_attributes.cpp.

References IsCopper(), and X2_ATTRIBUTE::m_Prms.

◆ GetLPType()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetLPType ( )

Returns: the Layer Pair type for drill files (PTH, NPTH, Blind or Buried)

Definition at line 208 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetPrm()

const wxString & X2_ATTRIBUTE::GetPrm ( int aIdx )

inherited

Returns: a parameter read in TF command.

Parameters

aIdx	= the index of the parameter aIdx = 0 is the parameter read after the TF function (the same as GetAttribute())

Definition at line 65 of file X2_gerber_attributes.cpp.

References dummy, X2_ATTRIBUTE::GetPrmCount(), and X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE::RemoveAttribute().

◆ GetPrmCount()

int X2_ATTRIBUTE::GetPrmCount ( )

inlineinherited

Returns: the number of parameters read in TF (or similar like TA TO ...) command.

Definition at line 82 of file X2_gerber_attributes.h.

References X2_ATTRIBUTE::m_Prms.

Referenced by X2_ATTRIBUTE::DbgListPrms(), X2_ATTRIBUTE::GetPrm(), and X2_ATTRIBUTE_FILEFUNCTION().

◆ GetPrms()

wxArrayString & X2_ATTRIBUTE::GetPrms ( )

inlineinherited

Returns: the parameters list read in TF command.

Definition at line 62 of file X2_gerber_attributes.h.

References X2_ATTRIBUTE::m_Prms.

Referenced by X2_ATTRIBUTE_FILEFUNCTION().

◆ GetRouteType()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetRouteType ( )

Returns: the drill/routing type for drill files (Drill, Route, Mixed)

Definition at line 215 of file X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetZOrder()

int X2_ATTRIBUTE_FILEFUNCTION::GetZOrder ( )

inline

the Order of the board layer, from front (Top) side to back (Bot) side

Definition at line 187 of file X2_gerber_attributes.h.

References m_z_order.

Referenced by sortZorder().

◆ GetZSubOrder()

int X2_ATTRIBUTE_FILEFUNCTION::GetZSubOrder ( )

inline

the Order of the bdr copper layer, from front (Top) side to back (Bot) side

Definition at line 189 of file X2_gerber_attributes.h.

References m_z_sub_order.

Referenced by sortZorder().

◆ IsCopper()

bool X2_ATTRIBUTE_FILEFUNCTION::IsCopper ( )

return true if the filefunction type is "Copper"

Definition at line 222 of file X2_gerber_attributes.cpp.

References GetFileType().

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GetBrdLayerSide(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), GetLabel(), and set_Z_Order().

◆ IsDrillFile()

bool X2_ATTRIBUTE_FILEFUNCTION::IsDrillFile ( )

Returns: true if the filefunction type is "Plated" or "NotPlated" therefore a drill file

Definition at line 229 of file X2_gerber_attributes.cpp.

References GetFileType().

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ IsFileFunction()

bool X2_ATTRIBUTE::IsFileFunction ( )

inlineinherited

Return true if the attribute is .FileFunction.

Definition at line 106 of file X2_gerber_attributes.h.

References X2_ATTRIBUTE::GetAttribute().

◆ IsFileMD5()

bool X2_ATTRIBUTE::IsFileMD5 ( )

inlineinherited

Return true if the attribute is .MD5.

Definition at line 114 of file X2_gerber_attributes.h.

References X2_ATTRIBUTE::GetAttribute().

◆ IsFilePart()

bool X2_ATTRIBUTE::IsFilePart ( )

inlineinherited

Return true if the attribute is .Part.

Definition at line 122 of file X2_gerber_attributes.h.

References X2_ATTRIBUTE::GetAttribute().

◆ ParseAttribCmd()

bool X2_ATTRIBUTE::ParseAttribCmd	(	FILE *	aFile,
		char *	aBuffer,
		int	aBuffSize,
		char *&	aText,
		int &	aLineNum
	)

inherited

Parse a TF command terminated with a % and fill m_Prms by the parameters found.

Parameters

aFile	= a FILE* ptr to the current Gerber file.
aBuffer	= the buffer containing current Gerber data (can be null)
aBuffSize	= the size of the buffer
aText	= a pointer to the first char to read from Gerber data stored in aBuffer After parsing, text points the last char of the command line ('') (X2 mode) or the end of line if the line does not contain '' or aBuffer == NULL (X1 mode)
aLineNum	= a point to the current line number of aFile

Returns: true if no error.

Definition at line 85 of file X2_gerber_attributes.cpp.

References From_UTF8(), and X2_ATTRIBUTE::m_Prms.

◆ set_Z_Order()

void X2_ATTRIBUTE_FILEFUNCTION::set_Z_Order ( )

private

Initialize the z order priority of the current file, from its attributes.

Definition at line 237 of file X2_gerber_attributes.cpp.

References GetBrdLayerId(), GetFileType(), IsCopper(), m_z_order, and m_z_sub_order.

Referenced by X2_ATTRIBUTE_FILEFUNCTION().

Member Data Documentation

◆ m_Prms

wxArrayString X2_ATTRIBUTE::m_Prms

protectedinherited

the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.

'

Definition at line 128 of file X2_gerber_attributes.h.

Referenced by X2_ATTRIBUTE::DbgListPrms(), X2_ATTRIBUTE::GetAttribute(), GetBrdLayerId(), GetBrdLayerSide(), GetDrillLayerPair(), GetFileType(), GetLabel(), GetLPType(), X2_ATTRIBUTE::GetPrm(), X2_ATTRIBUTE::GetPrmCount(), X2_ATTRIBUTE::GetPrms(), GetRouteType(), X2_ATTRIBUTE::ParseAttribCmd(), and X2_ATTRIBUTE_FILEFUNCTION().

◆ m_z_order

int X2_ATTRIBUTE_FILEFUNCTION::m_z_order

private

Definition at line 199 of file X2_gerber_attributes.h.

Referenced by GetZOrder(), set_Z_Order(), and X2_ATTRIBUTE_FILEFUNCTION().

◆ m_z_sub_order

int X2_ATTRIBUTE_FILEFUNCTION::m_z_sub_order

private

Definition at line 200 of file X2_gerber_attributes.h.

Referenced by GetZSubOrder(), and set_Z_Order().

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ X2_ATTRIBUTE_FILEFUNCTION()

Member Function Documentation

◆ DbgListPrms()

◆ GetAttribute()

◆ GetBrdLayerId()

◆ GetBrdLayerSide()

◆ GetDrillLayerPair()

◆ GetFileType()

◆ GetLabel()

◆ GetLPType()

◆ GetPrm()

◆ GetPrmCount()

◆ GetPrms()

◆ GetRouteType()

◆ GetZOrder()

◆ GetZSubOrder()

◆ IsCopper()

◆ IsDrillFile()

◆ IsFileFunction()

◆ IsFileMD5()

◆ IsFilePart()

◆ ParseAttribCmd()

◆ set_Z_Order()

Member Data Documentation

◆ m_Prms

◆ m_z_order

◆ m_z_sub_order