X2_ATTRIBUTE Class Reference

The attribute value consists of a number of substrings separated by a comma. More...

#include <X2_gerber_attributes.h>

Inheritance diagram for X2_ATTRIBUTE:

Public Member Functions
	X2_ATTRIBUTE ()
	~X2_ATTRIBUTE ()
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. More...
void	DbgListPrms ()
	Debug function: print using wxLogMessage le list of parameters. More...
bool	IsFileFunction ()
	Return true if the attribute is .FileFunction. More...
bool	IsFileMD5 ()
	Return true if the attribute is .MD5. More...
bool	IsFilePart ()
	Return true if the attribute is .Part. More...

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

Detailed Description

The attribute value consists of a number of substrings separated by a comma.

Definition at line 53 of file X2_gerber_attributes.h.

Constructor & Destructor Documentation

X2_ATTRIBUTE()

X2_ATTRIBUTE::X2_ATTRIBUTE

(

)

Definition at line 49 of file X2_gerber_attributes.cpp.

{
}

~X2_ATTRIBUTE()

X2_ATTRIBUTE::~X2_ATTRIBUTE

(

)

Definition at line 54 of file X2_gerber_attributes.cpp.

{
}

Member Function Documentation

DbgListPrms()

void X2_ATTRIBUTE::DbgListPrms

(

)

Debug function: print using wxLogMessage le list of parameters.

Definition at line 76 of file X2_gerber_attributes.cpp.

{
    wxLogMessage( wxT( "prms count %d" ), GetPrmCount() );

    for( int ii = 0; ii < GetPrmCount(); ii++ )
        wxLogMessage( m_Prms.Item( ii ) );
}

References GetPrmCount(), and m_Prms.

GetAttribute()

const wxString & X2_ATTRIBUTE::GetAttribute

(

)

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.

{
    return m_Prms.Item( 0 );
}

References m_Prms.

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

GetPrm()

const wxString & X2_ATTRIBUTE::GetPrm

(

int

aIdx

)

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.

{
    static const wxString dummy;

    if( GetPrmCount() > aIdx && aIdx >= 0 )
        return m_Prms.Item( aIdx );

    return dummy;
}

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

Referenced by GERBER_FILE_IMAGE::RemoveAttribute().

GetPrmCount()

int X2_ATTRIBUTE::GetPrmCount ( )

inline

Returns

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

Definition at line 82 of file X2_gerber_attributes.h.

{ return int( m_Prms.GetCount() ); }

References m_Prms.

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

GetPrms()

wxArrayString& X2_ATTRIBUTE::GetPrms ( )

inline

Returns

the parameters list read in TF command.

Definition at line 62 of file X2_gerber_attributes.h.

{ return m_Prms; }

References m_Prms.

Referenced by X2_ATTRIBUTE_FILEFUNCTION::X2_ATTRIBUTE_FILEFUNCTION().

IsFileFunction()

bool X2_ATTRIBUTE::IsFileFunction ( )

inline

Return true if the attribute is .FileFunction.

Definition at line 106 of file X2_gerber_attributes.h.

    {
        return GetAttribute().IsSameAs( wxT(".FileFunction"), false );
    }

References GetAttribute().

IsFileMD5()

bool X2_ATTRIBUTE::IsFileMD5 ( )

inline

Return true if the attribute is .MD5.

Definition at line 114 of file X2_gerber_attributes.h.

    {
        return GetAttribute().IsSameAs( wxT(".MD5"), false );
    }

References GetAttribute().

IsFilePart()

bool X2_ATTRIBUTE::IsFilePart ( )

inline

Return true if the attribute is .Part.

Definition at line 122 of file X2_gerber_attributes.h.

    {
        return GetAttribute().IsSameAs( wxT(".Part"), false );
    }

References GetAttribute().

ParseAttribCmd()

bool X2_ATTRIBUTE::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.

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.

{
    // parse a TF, TA, TO ... command and fill m_Prms by the parameters found.
    // the "%TF" (start of command) is already read by the caller

    bool ok = true;
    std::string data;

    for( ; ; )
    {
        while( *aText )
        {
            switch( *aText )
            {
            case '%':       // end of command
                return ok;  // success completion

            case ' ':
            case '\r':
            case '\n':
                aText++;
                break;

            case '*':       // End of block
                m_Prms.Add( FROM_UTF8( data.c_str() ) );
                data.clear();
                aText++;
                break;

            case ',':       // End of parameter (separator)
                aText++;
                m_Prms.Add( FROM_UTF8( data.c_str() ) );
                data.clear();
                break;

            default:
                data += *aText;
                aText++;
                break;
            }
        }

        // end of current line, read another one.
        if( aBuffer && aFile )
        {
            if( fgets( aBuffer, aBuffSize, aFile ) == nullptr )
            {
                // end of file
                ok = false;
                break;
            }

            aLineNum++;
            aText = aBuffer;
        }
        else
        {
            return ok;
        }
    }

    return ok;
}

References FROM_UTF8(), and m_Prms.

Member Data Documentation

m_Prms

wxArrayString X2_ATTRIBUTE::m_Prms

protected

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 DbgListPrms(), GetAttribute(), X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerId(), X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerSide(), X2_ATTRIBUTE_FILEFUNCTION::GetDrillLayerPair(), X2_ATTRIBUTE_FILEFUNCTION::GetFileType(), X2_ATTRIBUTE_FILEFUNCTION::GetLabel(), X2_ATTRIBUTE_FILEFUNCTION::GetLPType(), GetPrm(), GetPrmCount(), GetPrms(), X2_ATTRIBUTE_FILEFUNCTION::GetRouteType(), ParseAttribCmd(), and X2_ATTRIBUTE_FILEFUNCTION::X2_ATTRIBUTE_FILEFUNCTION().

---

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

• X2_gerber_attributes.h
• X2_gerber_attributes.cpp