ARRAY_OPTIONS Class Reference

Options that govern the setup of an "array" of multiple item. More...

#include <array_options.h>

Inheritance diagram for ARRAY_OPTIONS:

Classes
struct	TRANSFORM
	Transform applied to an object by this array. More...

Public Types
enum	ARRAY_TYPE_T { ARRAY_GRID , ARRAY_CIRCULAR }

Public Member Functions
	ARRAY_OPTIONS (ARRAY_TYPE_T aType)
virtual	~ARRAY_OPTIONS ()
virtual TRANSFORM	GetTransform (int aN, const VECTOR2I &aPos) const =0
	Get the transform of the n-th point in the array. More...
virtual int	GetArraySize () const =0
	The number of points in this array. More...
virtual wxString	GetItemNumber (int n) const =0
	Get the position number (name) for the n'th array point. More...
bool	ShouldNumberItems () const
void	SetShouldNumber (bool aShouldNumber)
bool	ShouldReannotateFootprints () const
void	SetSShouldReannotateFootprints (bool aShouldReannotate)
bool	GetNumberingStartIsSpecified () const
void	SetNumberingStartIsSpecified (bool aIsSpecified)

Protected Attributes
ARRAY_TYPE_T	m_type
bool	m_shouldNumber
	True if this array numbers the new items. More...
bool	m_reannotateFootprints
	True if this array will rename any footprints to be unique. More...
bool	m_numberingStartIsSpecified
	True if this array's number starts from the preset point False if the array numbering starts from some externally provided point. More...

Detailed Description

Options that govern the setup of an "array" of multiple item.

The base ARRAY_OPTIONS do not encode a specific geometry or numbering method, this is done by derived classes.

Definition at line 36 of file array_options.h.

Member Enumeration Documentation

ARRAY_TYPE_T

enum ARRAY_OPTIONS::ARRAY_TYPE_T

Enumerator
ARRAY_GRID	A grid (x*y) array.
ARRAY_CIRCULAR	A circular array.

Definition at line 39 of file array_options.h.

Constructor & Destructor Documentation

ARRAY_OPTIONS()

ARRAY_OPTIONS::ARRAY_OPTIONS ( ARRAY_TYPE_T  aType )

inline

Definition at line 45 of file array_options.h.

~ARRAY_OPTIONS()

virtual ARRAY_OPTIONS::~ARRAY_OPTIONS ( )

inlinevirtual

Definition at line 53 of file array_options.h.

Member Function Documentation

GetArraySize()

virtual int ARRAY_OPTIONS::GetArraySize ( ) const

pure virtual

The number of points in this array.

Implemented in ARRAY_GRID_OPTIONS, and ARRAY_CIRCULAR_OPTIONS.

Referenced by CheckArrayNumbering(), and CheckArrayTransforms().

GetItemNumber()

virtual wxString ARRAY_OPTIONS::GetItemNumber ( int  n ) const

pure virtual

Get the position number (name) for the n'th array point.

Parameters

n	array point index, from 0 to GetArraySize() - 1

Returns

the point's name

Implemented in ARRAY_GRID_OPTIONS, and ARRAY_CIRCULAR_OPTIONS.

Referenced by CheckArrayNumbering(), and ARRAY_PAD_NUMBER_PROVIDER::getNextNumber().

GetNumberingStartIsSpecified()

bool ARRAY_OPTIONS::GetNumberingStartIsSpecified ( ) const

inline

Returns

is the numbering is enabled and should start at a point specified in these options or is it implicit according to the calling code?

Definition at line 117 of file array_options.h.

References m_numberingStartIsSpecified, and m_shouldNumber.

Referenced by ARRAY_PAD_NUMBER_PROVIDER::ARRAY_PAD_NUMBER_PROVIDER().

GetTransform()

virtual TRANSFORM ARRAY_OPTIONS::GetTransform ( int  aN, const VECTOR2I &  aPos  ) const

pure virtual

Get the transform of the n-th point in the array.

Parameters

aN	the index of the array point (0 is the original point)
aPos	the existing item position

Returns

a transform (an offset and a rotation)

Implemented in ARRAY_GRID_OPTIONS, and ARRAY_CIRCULAR_OPTIONS.

Referenced by CheckArrayTransforms(), and TransformItem().

SetNumberingStartIsSpecified()

void ARRAY_OPTIONS::SetNumberingStartIsSpecified ( bool  aIsSpecified )

inline

Definition at line 122 of file array_options.h.

References m_numberingStartIsSpecified.

SetShouldNumber()

void ARRAY_OPTIONS::SetShouldNumber ( bool  aShouldNumber )

inline

Definition at line 93 of file array_options.h.

References m_shouldNumber.

SetSShouldReannotateFootprints()

void ARRAY_OPTIONS::SetSShouldReannotateFootprints ( bool  aShouldReannotate )

inline

Definition at line 107 of file array_options.h.

References m_reannotateFootprints.

ShouldNumberItems()

bool ARRAY_OPTIONS::ShouldNumberItems ( ) const

inline

Returns

are the items in this array numbered, or are all the items numbered the same?

Definition at line 88 of file array_options.h.

References m_shouldNumber.

ShouldReannotateFootprints()

bool ARRAY_OPTIONS::ShouldReannotateFootprints ( ) const

inline

Returns

are the footprints in this array reannotated to be unique (true), or do they keep the original annotation (false)?

Definition at line 102 of file array_options.h.

References m_reannotateFootprints.

Member Data Documentation

m_numberingStartIsSpecified

bool ARRAY_OPTIONS::m_numberingStartIsSpecified

protected

True if this array's number starts from the preset point False if the array numbering starts from some externally provided point.

Definition at line 139 of file array_options.h.

Referenced by GetNumberingStartIsSpecified(), and SetNumberingStartIsSpecified().

m_reannotateFootprints

bool ARRAY_OPTIONS::m_reannotateFootprints

protected

True if this array will rename any footprints to be unique.

Definition at line 135 of file array_options.h.

Referenced by SetSShouldReannotateFootprints(), and ShouldReannotateFootprints().

m_shouldNumber

bool ARRAY_OPTIONS::m_shouldNumber

protected

True if this array numbers the new items.

Definition at line 132 of file array_options.h.

Referenced by GetNumberingStartIsSpecified(), SetShouldNumber(), and ShouldNumberItems().

m_type

ARRAY_TYPE_T ARRAY_OPTIONS::m_type

protected

Definition at line 129 of file array_options.h.

---

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

• array_options.h