KiCad PCB EDA Suite
SCH_FIND_COLLECTOR Class Reference

Class SCH_FIND_COLLECTOR is used to iterate over all of the items in a schematic or sheet and collect all the items that match the given search criteria. More...

#include <sch_collectors.h>

Inheritance diagram for SCH_FIND_COLLECTOR:
COLLECTOR

Public Member Functions

 SCH_FIND_COLLECTOR (const KICAD_T *aScanTypes=SCH_COLLECTOR::AllItems)
 Function dump is a helper to dump the items in the find list for debugging purposes. More...
 
void Empty ()
 
void SetForceSearch (bool doSearch=true)
 
int GetLibHash () const
 
void SetLibHash (int aHash)
 
int GetFoundIndex () const
 
void SetFoundIndex (int aIndex)
 
bool PassedEnd () const
 Function PassedEnd tests if m_foundIndex is beyond the end of the list give the current find/replace criterial in m_findReplaceData. More...
 
void UpdateIndex ()
 Function UpdateIndex updates the list index according to the current find and replace criteria. More...
 
SCH_FIND_COLLECTOR_DATA GetFindData (int aIndex)
 Function GetFindData returns the data associated with the item found at aIndex. More...
 
bool IsSearchRequired (const SCH_FIND_REPLACE_DATA &aFindReplaceData)
 Function IsSearchRequired checks the current collector state against aFindReplaceData to see if a new search needs to be performed to update the collector. More...
 
wxString GetText ()
 Function GetText() More...
 
EDA_ITEMGetItem (SCH_FIND_COLLECTOR_DATA &aFindData)
 Function GetItem returns the item and associated data of the current index. More...
 
bool ReplaceItem (SCH_SHEET_PATH *aSheetPath=NULL)
 Function ReplaceItem performs a string replace of the item at the current index. More...
 
SEARCH_RESULT Inspect (EDA_ITEM *aItem, void *aTestData) override
 
void SetReplaceString (const wxString &aReplaceString)
 Update the replace string without changing anything else. More...
 
void Collect (SCH_FIND_REPLACE_DATA &aFindReplaceData, SCH_SHEET_PATH *aSheetPath=NULL)
 Function Collect scans aSheetPath using this class's Inspector method for items matching aFindReplaceData. More...
 
void IncrementIndex ()
 
bool IsValidIndex (int aIndex)
 Function IsValidIndex tests if aIndex is with the limits of the list of collected items. More...
 
int GetCount () const
 Function GetCount returns the number of objects in the list. More...
 
void Append (EDA_ITEM *item)
 Function Append adds an item to the end of the list. More...
 
void Remove (int aIndex)
 Function Remove removes the item at aIndex (first position is 0);. More...
 
void Remove (const EDA_ITEM *aItem)
 Function Remove removes the item aItem (if exists in the collector). More...
 
EDA_ITEMoperator[] (int aIndex) const
 Function operator[int] is used for read only access and returns the object at aIndex. More...
 
EDA_ITEM *const * BasePtr () const
 Function BasePtr returns the address of the first element in the array. More...
 
bool HasItem (const EDA_ITEM *aItem) const
 Function HasItem tests if aItem has already been collected. More...
 
void SetScanTypes (const KICAD_T *scanTypes)
 Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() function. More...
 
void SetTimeNow ()
 
time_t GetTime ()
 
void SetRefPos (const wxPoint &aRefPos)
 
const wxPointGetRefPos () const
 
void SetBoundingBox (const EDA_RECT &aRefBox)
 
const EDA_RECTGetBoundingBox () const
 
bool IsSimilarPointAndTime (const wxPoint &aRefPos)
 Function IsSimilarPointAndTime returns true if the given reference point is "similar" (defined here) to the internal reference point and the current time is within a few seconds of the internal m_TimeAtCollection. More...
 
int CountType (KICAD_T aType)
 Function CountType counts the number of items matching aType. More...
 

Protected Attributes

INSPECTOR_FUNC m_inspector
 a class common bridge into the polymorphic Inspect() More...
 
const KICAD_Tm_ScanTypes
 Which object types to scan. More...
 
std::vector< EDA_ITEM * > m_List
 A place to hold collected objects without taking ownership of their memory. More...
 
wxPoint m_RefPos
 A point to test against, and that was used to make the collection. More...
 
EDA_RECT m_RefBox
 A bounding box to test against, and that was used to make the collection. More...
 
time_t m_TimeAtCollection
 The time at which the collection was made. More...
 

Private Attributes

std::vector< SCH_FIND_COLLECTOR_DATAm_data
 Data associated with each found item. More...
 
SCH_FIND_REPLACE_DATA m_findReplaceData
 The criteria used to test for matching items. More...
 
SCH_SHEET_PATHm_sheetPath
 The path of the sheet currently being iterated over. More...
 
int m_foundIndex
 The current found item list index. More...
 
bool m_forceSearch
 A flag to indicate that the schemtic has been modified and a new search must be performed even if the search criteria hasn't changed. More...
 
int m_lib_hash
 last known library change hash, used to detect library changes which should trigger cache obsolescence. More...
 

Detailed Description

Class SCH_FIND_COLLECTOR is used to iterate over all of the items in a schematic or sheet and collect all the items that match the given search criteria.

Definition at line 226 of file sch_collectors.h.

Constructor & Destructor Documentation

SCH_FIND_COLLECTOR::SCH_FIND_COLLECTOR ( const KICAD_T aScanTypes = SCH_COLLECTOR::AllItems)
inline

Function dump is a helper to dump the items in the find list for debugging purposes.

Constructor SCH_FIND_COLLECTOR

Definition at line 261 of file sch_collectors.h.

References SetForceSearch(), and COLLECTOR::SetScanTypes().

262  {
263  SetScanTypes( aScanTypes );
264  m_foundIndex = 0;
265  SetForceSearch( false );
266  m_sheetPath = NULL;
267  m_lib_hash = 0;
268  }
SCH_SHEET_PATH * m_sheetPath
The path of the sheet currently being iterated over.
void SetScanTypes(const KICAD_T *scanTypes)
Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() f...
void SetForceSearch(bool doSearch=true)
int m_lib_hash
last known library change hash, used to detect library changes which should trigger cache obsolescenc...
int m_foundIndex
The current found item list index.

Member Function Documentation

void COLLECTOR::Append ( EDA_ITEM item)
inlineinherited

Function Append adds an item to the end of the list.

Parameters
itemAn EDA_ITEM* to add.

Definition at line 126 of file class_collector.h.

Referenced by GENERAL_COLLECTOR::Collect(), SELECTION_TOOL::guessSelectionCandidates(), LIB_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), Inspect(), SCH_TYPE_COLLECTOR::Inspect(), PCB_TYPE_COLLECTOR::Inspect(), and PCB_LAYER_COLLECTOR::Inspect().

127  {
128  m_List.push_back( item );
129  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
EDA_ITEM* const* COLLECTOR::BasePtr ( ) const
inlineinherited

Function BasePtr returns the address of the first element in the array.

Only call this if there is at least one element in the vector m_List, otherwise a C++ exception should get thrown.

Definition at line 178 of file class_collector.h.

179  {
180  return &m_List[0];
181  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
void SCH_FIND_COLLECTOR::Collect ( SCH_FIND_REPLACE_DATA aFindReplaceData,
SCH_SHEET_PATH aSheetPath = NULL 
)

Function Collect scans aSheetPath using this class's Inspector method for items matching aFindReplaceData.

Parameters
aFindReplaceDataA SCH_FIND_REPLACE_DATA object containing the search criteria.
aSheetPathA pointer to a SCH_SHEET_PATH object to test for matches. A NULL value searches the entire schematic hierarchy.

Definition at line 523 of file sch_collectors.cpp.

References Empty(), g_RootSheet, IsSearchRequired(), EDA_ITEM::IterateForward(), SCH_SHEET_PATH::LastDrawList(), m_data, m_findReplaceData, m_forceSearch, m_foundIndex, COLLECTOR::m_inspector, COLLECTOR::m_List, COLLECTOR::m_ScanTypes, m_sheetPath, and SetForceSearch().

Referenced by SCH_EDIT_FRAME::OnFindReplace(), and SCH_EDIT_FRAME::OnFindSchematicItem().

525 {
526  if( !IsSearchRequired( aFindReplaceData ) && !m_List.empty() && !m_forceSearch )
527  return;
528 
529  m_findReplaceData = aFindReplaceData;
530  Empty(); // empty the collection just in case
531  m_data.clear();
532  m_foundIndex = 0;
533  SetForceSearch( false );
534 
535  if( aSheetPath )
536  {
537  m_sheetPath = aSheetPath;
539  }
540  else
541  {
542  SCH_SHEET_LIST schematic( g_RootSheet );
543 
544  for( unsigned i = 0; i < schematic.size(); i++ )
545  {
546  m_sheetPath = &schematic[i];
548  }
549  }
550 
551 #if defined(DEBUG)
552  dump();
553 #endif
554 
555  if( m_List.size() != m_data.size() )
556  {
557  wxFAIL_MSG( wxT( "List size mismatch." ) );
558  m_List.clear();
559  m_data.clear();
560  }
561 }
SCH_ITEM * LastDrawList() const
Function LastDrawList.
Class SCH_SHEET_LIST.
static SEARCH_RESULT IterateForward(EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function IterateForward walks through the object tree calling the inspector() on each object type req...
bool IsSearchRequired(const SCH_FIND_REPLACE_DATA &aFindReplaceData)
Function IsSearchRequired checks the current collector state against aFindReplaceData to see if a new...
SCH_SHEET_PATH * m_sheetPath
The path of the sheet currently being iterated over.
std::vector< SCH_FIND_COLLECTOR_DATA > m_data
Data associated with each found item.
INSPECTOR_FUNC m_inspector
a class common bridge into the polymorphic Inspect()
void SetForceSearch(bool doSearch=true)
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:55
int m_foundIndex
The current found item list index.
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
const KICAD_T * m_ScanTypes
Which object types to scan.
bool m_forceSearch
A flag to indicate that the schemtic has been modified and a new search must be performed even if the...
SCH_FIND_REPLACE_DATA m_findReplaceData
The criteria used to test for matching items.
int COLLECTOR::CountType ( KICAD_T  aType)
inlineinherited

Function CountType counts the number of items matching aType.

Parameters
aTypetype we are interested in
Returns
number of occurences

Definition at line 258 of file class_collector.h.

Referenced by SELECTION_TOOL::guessSelectionCandidates().

259  {
260  int cnt = 0;
261  for( size_t i = 0; i < m_List.size(); i++ )
262  {
263  if( m_List[i]->Type() == aType )
264  cnt++;
265  }
266  return cnt;
267  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
void SCH_FIND_COLLECTOR::Empty ( )
inline

Definition at line 270 of file sch_collectors.h.

References COLLECTOR::Empty().

Referenced by Collect().

271  {
272  m_foundIndex = 0;
274  m_data.clear();
275  }
void Empty()
Function Empty sets the list to empty.
std::vector< SCH_FIND_COLLECTOR_DATA > m_data
Data associated with each found item.
int m_foundIndex
The current found item list index.
const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const
inlineinherited

Definition at line 227 of file class_collector.h.

References COLLECTOR::m_RefBox.

227 { return m_RefBox; }
EDA_RECT m_RefBox
A bounding box to test against, and that was used to make the collection.
SCH_FIND_COLLECTOR_DATA SCH_FIND_COLLECTOR::GetFindData ( int  aIndex)

Function GetFindData returns the data associated with the item found at aIndex.

Parameters
aIndexThe list index of the data to return.
Returns
The associated found item data at aIndex if aIndex is within the list limits. Otherwise an empty data item will be returned.

Definition at line 420 of file sch_collectors.cpp.

References m_data.

421 {
422  wxCHECK_MSG( (unsigned) aIndex < m_data.size(), SCH_FIND_COLLECTOR_DATA(),
423  wxT( "Attempt to get find data outside of list boundary." ) );
424 
425  return m_data[ aIndex ];
426 }
Class SCH_FIND_COLLECTOR_DATA is used as a data container for the associated item found by the SCH_FI...
std::vector< SCH_FIND_COLLECTOR_DATA > m_data
Data associated with each found item.
int SCH_FIND_COLLECTOR::GetFoundIndex ( ) const
inline

Definition at line 282 of file sch_collectors.h.

References m_foundIndex.

Referenced by SCH_EDIT_FRAME::OnFindReplace().

282 { return m_foundIndex; }
int m_foundIndex
The current found item list index.
EDA_ITEM * SCH_FIND_COLLECTOR::GetItem ( SCH_FIND_COLLECTOR_DATA aFindData)

Function GetItem returns the item and associated data of the current index.

Parameters
aFindDataA reference to a SCH_FIND_COLLECTOR_DATA object to place the associated data for the current item into if the current item index is valid.
Returns
A pointer to the current EDA_ITEM in the list if the list index is valid Otherwise NULL is returned and the aFindData object is not updated.

Definition at line 459 of file sch_collectors.cpp.

References m_data, m_foundIndex, COLLECTOR::m_List, and PassedEnd().

Referenced by SCH_EDIT_FRAME::OnFindReplace(), SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

460 {
461  if( PassedEnd() )
462  return NULL;
463 
464  aData = m_data[ m_foundIndex ];
465  return m_List[ m_foundIndex ];
466 }
std::vector< SCH_FIND_COLLECTOR_DATA > m_data
Data associated with each found item.
int m_foundIndex
The current found item list index.
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
bool PassedEnd() const
Function PassedEnd tests if m_foundIndex is beyond the end of the list give the current find/replace ...
int SCH_FIND_COLLECTOR::GetLibHash ( ) const
inline

Definition at line 279 of file sch_collectors.h.

References m_lib_hash.

Referenced by SCH_EDIT_FRAME::IsSearchCacheObsolete().

279 { return m_lib_hash; }
int m_lib_hash
last known library change hash, used to detect library changes which should trigger cache obsolescenc...
const wxPoint& COLLECTOR::GetRefPos ( ) const
inlineinherited

Definition at line 224 of file class_collector.h.

References COLLECTOR::m_RefPos.

Referenced by PCB_EDIT_FRAME::OnRightClick().

224 { return m_RefPos; }
wxPoint m_RefPos
A point to test against, and that was used to make the collection.
wxString SCH_FIND_COLLECTOR::GetText ( )

Function GetText()

Returns
A wxString object containing the description of the item found at the current index or a wxEmptyString if the list is empty or the index is invalid.

Definition at line 429 of file sch_collectors.cpp.

References GetChars(), COLLECTOR::GetCount(), SCH_FIND_COLLECTOR_DATA::GetParent(), EDA_ITEM::GetSelectMenuText(), SCH_FIND_COLLECTOR_DATA::GetSheetPath(), COLLECTOR::IsValidIndex(), m_data, m_foundIndex, and COLLECTOR::m_List.

Referenced by SCH_EDIT_FRAME::updateFindReplaceView().

430 {
431  wxCHECK_MSG( (GetCount() != 0) && IsValidIndex( m_foundIndex ), wxEmptyString,
432  wxT( "Cannot get found item at invalid index." ) );
433 
435  EDA_ITEM* foundItem = m_List[ m_foundIndex ];
436 
437  wxCHECK_MSG( foundItem != NULL, wxEmptyString, wxT( "Invalid found item pointer." ) );
438 
439  wxString msg;
440 
441  if( data.GetParent() )
442  {
443  msg.Printf( _( "Child item %s of parent item %s found in sheet %s" ),
444  GetChars( foundItem->GetSelectMenuText() ),
445  GetChars( data.GetParent()->GetSelectMenuText() ),
446  GetChars( data.GetSheetPath() ) );
447  }
448  else
449  {
450  msg.Printf( _( "Item %s found in sheet %s" ),
451  GetChars( foundItem->GetSelectMenuText() ),
452  GetChars( data.GetSheetPath() ) );
453  }
454 
455  return msg;
456 }
int GetCount() const
Function GetCount returns the number of objects in the list.
bool IsValidIndex(int aIndex)
Function IsValidIndex tests if aIndex is with the limits of the list of collected items...
wxString GetSheetPath() const
Class SCH_FIND_COLLECTOR_DATA is used as a data container for the associated item found by the SCH_FI...
std::vector< SCH_FIND_COLLECTOR_DATA > m_data
Data associated with each found item.
virtual wxString GetSelectMenuText() const
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
SCH_ITEM * GetParent() const
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
int m_foundIndex
The current found item list index.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
time_t COLLECTOR::GetTime ( )
inlineinherited

Definition at line 218 of file class_collector.h.

References COLLECTOR::m_TimeAtCollection.

219  {
220  return m_TimeAtCollection;
221  }
time_t m_TimeAtCollection
The time at which the collection was made.
bool COLLECTOR::HasItem ( const EDA_ITEM aItem) const
inlineinherited

Function HasItem tests if aItem has already been collected.

Parameters
aItemThe EDA_ITEM* to be tested.
Returns
True if aItem is already collected.

Definition at line 190 of file class_collector.h.

191  {
192  for( size_t i = 0; i < m_List.size(); i++ )
193  {
194  if( m_List[i] == aItem )
195  return true;
196  }
197 
198  return false;
199  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
void SCH_FIND_COLLECTOR::IncrementIndex ( )
inline

Definition at line 375 of file sch_collectors.h.

Referenced by SCH_EDIT_FRAME::OnFindReplace().

375 { m_foundIndex += 1; }
int m_foundIndex
The current found item list index.
SEARCH_RESULT SCH_FIND_COLLECTOR::Inspect ( EDA_ITEM aItem,
void *  aTestData 
)
overridevirtual

Implements COLLECTOR.

Definition at line 488 of file sch_collectors.cpp.

References COLLECTOR::Append(), SCH_COMPONENT::GetPosition(), SCH_COMPONENT::GetTransform(), LIB_PIN_T, m_data, m_findReplaceData, m_sheetPath, EDA_ITEM::Matches(), SCH_SHEET_PATH::PathHumanReadable(), SCH_COMPONENT_T, SEARCH_CONTINUE, TRANSFORM::TransformCoordinate(), EDA_ITEM::Type(), and wxPoint::y.

489 {
490  wxPoint position;
491 
492  if( aItem->Matches( m_findReplaceData, m_sheetPath, &position ) )
493  {
494  if( aItem->Type() == LIB_PIN_T )
495  {
496  wxCHECK_MSG( aTestData && ( (EDA_ITEM*) aTestData )->Type() == SCH_COMPONENT_T,
497  SEARCH_CONTINUE, wxT( "Cannot inspect invalid data. Bad programmer!" ) );
498 
499  // Pin positions are relative to their parent component's position and
500  // orientation in the schematic. The pin's position must be converted
501  // schematic coordinates.
502  SCH_COMPONENT* component = (SCH_COMPONENT*) aTestData;
503  TRANSFORM transform = component->GetTransform();
504  position.y = -position.y;
505  position = transform.TransformCoordinate( position ) + component->GetPosition();
506  }
507 
508  Append( aItem );
510  (SCH_ITEM*) aTestData ) );
511  }
512 
513  return SEARCH_CONTINUE;
514 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
TRANSFORM & GetTransform() const
SCH_SHEET_PATH * m_sheetPath
The path of the sheet currently being iterated over.
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:414
Class SCH_FIND_COLLECTOR_DATA is used as a data container for the associated item found by the SCH_FI...
std::vector< SCH_FIND_COLLECTOR_DATA > m_data
Data associated with each found item.
void Append(EDA_ITEM *item)
Function Append adds an item to the end of the list.
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
wxString PathHumanReadable() const
Function PathHumanReadable returns the sheet path in a human readable form, i.e.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
wxPoint GetPosition() const override
Function GetPosition.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
SCH_FIND_REPLACE_DATA m_findReplaceData
The criteria used to test for matching items.
bool SCH_FIND_COLLECTOR::IsSearchRequired ( const SCH_FIND_REPLACE_DATA aFindReplaceData)
inline

Function IsSearchRequired checks the current collector state against aFindReplaceData to see if a new search needs to be performed to update the collector.

Parameters
aFindReplaceDataA SCH_FIND_REPLACE_DATA object containing the search criteria to test for changes against the current search criteria.
Returns
True if aFindReplaceData would require a new search to be performaed or the force search flag is true. Otherwise, false is returned.

Definition at line 323 of file sch_collectors.h.

References SCH_FIND_REPLACE_DATA::ChangesCompare(), and SCH_FIND_REPLACE_DATA::IsWrapping().

Referenced by Collect(), and SCH_EDIT_FRAME::IsSearchCacheObsolete().

324  {
325  return m_findReplaceData.ChangesCompare( aFindReplaceData ) || m_forceSearch ||
326  (m_findReplaceData.IsWrapping() != aFindReplaceData.IsWrapping());
327  }
bool ChangesCompare(const SCH_FIND_REPLACE_DATA &aFindReplaceData)
Function ChangesCompare tests aFindReplaceData to see if it would result in a change in the search st...
bool m_forceSearch
A flag to indicate that the schemtic has been modified and a new search must be performed even if the...
SCH_FIND_REPLACE_DATA m_findReplaceData
The criteria used to test for matching items.
bool COLLECTOR::IsSimilarPointAndTime ( const wxPoint aRefPos)
inlineinherited

Function IsSimilarPointAndTime returns true if the given reference point is "similar" (defined here) to the internal reference point and the current time is within a few seconds of the internal m_TimeAtCollection.

Parameters
aRefPosA wxPoint to compare to.
Returns
bool - true if the point and time are similar, else false.

Definition at line 238 of file class_collector.h.

References abs, GetNewTimeStamp(), wxPoint::x, and wxPoint::y.

239  {
240  const int distMax = 2; // adjust these here
241  const time_t timeMax = 3; // seconds
242 
243  int dx = abs( aRefPos.x - m_RefPos.x );
244  int dy = abs( aRefPos.y - m_RefPos.y );
245 
246  if( dx <= distMax && dy <= distMax &&
247  (int)GetNewTimeStamp() - m_TimeAtCollection <= timeMax )
248  return true;
249  else
250  return false;
251  }
time_t GetNewTimeStamp()
Definition: common.cpp:166
#define abs(a)
Definition: auxiliary.h:84
time_t m_TimeAtCollection
The time at which the collection was made.
wxPoint m_RefPos
A point to test against, and that was used to make the collection.
bool COLLECTOR::IsValidIndex ( int  aIndex)
inlineinherited

Function IsValidIndex tests if aIndex is with the limits of the list of collected items.

Parameters
aIndexThe index to test.
Returns
True if aIndex is with the limits of the list of collected items, otherwise false.

Definition at line 98 of file class_collector.h.

Referenced by GetText(), and ReplaceItem().

99  {
100  return ( (unsigned) aIndex < m_List.size() );
101  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
EDA_ITEM* COLLECTOR::operator[] ( int  aIndex) const
inlineinherited

Function operator[int] is used for read only access and returns the object at aIndex.

Parameters
aIndexThe index into the list.
Returns
EDA_ITEM* - or something derived from it, or NULL.

Definition at line 164 of file class_collector.h.

References COLLECTOR::GetCount().

165  {
166  if( (unsigned)aIndex < (unsigned)GetCount() ) // (unsigned) excludes aIndex<0 also
167  return m_List[ aIndex ];
168 
169  return NULL;
170  }
int GetCount() const
Function GetCount returns the number of objects in the list.
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
bool SCH_FIND_COLLECTOR::PassedEnd ( ) const

Function PassedEnd tests if m_foundIndex is beyond the end of the list give the current find/replace criterial in m_findReplaceData.

Returns
True if m_foundIndex has crossed the end of the found item list.

Definition at line 353 of file sch_collectors.cpp.

References FR_SEARCH_REPLACE, FR_SEARCH_WRAP, COLLECTOR::GetCount(), m_findReplaceData, and m_foundIndex.

Referenced by GetItem(), SCH_EDIT_FRAME::OnFindReplace(), and ReplaceItem().

354 {
355  bool retv = false;
356 
357  wxUint32 flags = m_findReplaceData.GetFlags();
358 
359  if( GetCount() == 0 )
360  return true;
361 
362  if( !(flags & FR_SEARCH_WRAP) || (flags & FR_SEARCH_REPLACE) )
363  {
364  if( flags & wxFR_DOWN )
365  {
366  if( m_foundIndex >= GetCount() )
367  retv = true;
368  }
369  else
370  {
371  if( m_foundIndex < 0 )
372  retv = true;
373  }
374  }
375 
376  return retv;
377 }
int GetCount() const
Function GetCount returns the number of objects in the list.
Wrap around the beginning or end of search list.
int m_foundIndex
The current found item list index.
Perform a search for a item that has replaceable text.
SCH_FIND_REPLACE_DATA m_findReplaceData
The criteria used to test for matching items.
void COLLECTOR::Remove ( int  aIndex)
inlineinherited

Function Remove removes the item at aIndex (first position is 0);.

Parameters
aIndexThe index into the list.

Definition at line 136 of file class_collector.h.

Referenced by SELECTION_TOOL::guessSelectionCandidates(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), GERBVIEW_SELECTION_TOOL::selectPoint(), and SELECTION_TOOL::selectPoint().

137  {
138  m_List.erase( m_List.begin() + aIndex );
139  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
void COLLECTOR::Remove ( const EDA_ITEM aItem)
inlineinherited

Function Remove removes the item aItem (if exists in the collector).

Parameters
aItemthe item to be removed.

Definition at line 146 of file class_collector.h.

147  {
148  for( size_t i = 0; i < m_List.size(); i++ )
149  {
150  if( m_List[i] == aItem )
151  {
152  m_List.erase( m_List.begin() + i);
153  return;
154  }
155  }
156  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
bool SCH_FIND_COLLECTOR::ReplaceItem ( SCH_SHEET_PATH aSheetPath = NULL)

Function ReplaceItem performs a string replace of the item at the current index.

Returns
True if the text replace occurred otherwise false.

Definition at line 469 of file sch_collectors.cpp.

References COLLECTOR::IsValidIndex(), m_findReplaceData, m_foundIndex, COLLECTOR::m_List, PassedEnd(), EDA_ITEM::Replace(), and SetForceSearch().

Referenced by SCH_EDIT_FRAME::OnFindReplace().

470 {
471  if( PassedEnd() )
472  return false;
473 
474  wxCHECK_MSG( IsValidIndex( m_foundIndex ), false,
475  wxT( "Invalid replace list index in SCH_FIND_COLLECTOR." ) );
476 
477  EDA_ITEM* item = m_List[ m_foundIndex ];
478 
479  bool replaced = item->Replace( m_findReplaceData, aSheetPath );
480 
481  if( replaced )
482  SetForceSearch();
483 
484  return replaced;
485 }
bool IsValidIndex(int aIndex)
Function IsValidIndex tests if aIndex is with the limits of the list of collected items...
bool Replace(wxFindReplaceData &aSearchData, wxString &aText)
Helper function used in search and replace dialog Function Replace performs a text replace on aText u...
void SetForceSearch(bool doSearch=true)
int m_foundIndex
The current found item list index.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
bool PassedEnd() const
Function PassedEnd tests if m_foundIndex is beyond the end of the list give the current find/replace ...
SCH_FIND_REPLACE_DATA m_findReplaceData
The criteria used to test for matching items.
void COLLECTOR::SetBoundingBox ( const EDA_RECT aRefBox)
inlineinherited

Definition at line 226 of file class_collector.h.

226 { m_RefBox = aRefBox; }
EDA_RECT m_RefBox
A bounding box to test against, and that was used to make the collection.
void SCH_FIND_COLLECTOR::SetForceSearch ( bool  doSearch = true)
inline

Definition at line 277 of file sch_collectors.h.

Referenced by Collect(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), ReplaceItem(), and SCH_FIND_COLLECTOR().

277 { m_forceSearch = doSearch; }
bool m_forceSearch
A flag to indicate that the schemtic has been modified and a new search must be performed even if the...
void SCH_FIND_COLLECTOR::SetFoundIndex ( int  aIndex)
inline

Definition at line 283 of file sch_collectors.h.

Referenced by SCH_EDIT_FRAME::OnFindReplace().

284  {
285  m_foundIndex = ( (unsigned) aIndex < m_data.size() ) ? aIndex : 0;
286  }
std::vector< SCH_FIND_COLLECTOR_DATA > m_data
Data associated with each found item.
int m_foundIndex
The current found item list index.
void SCH_FIND_COLLECTOR::SetLibHash ( int  aHash)
inline

Definition at line 280 of file sch_collectors.h.

Referenced by SCH_EDIT_FRAME::IsSearchCacheObsolete().

280 { m_lib_hash = aHash; }
int m_lib_hash
last known library change hash, used to detect library changes which should trigger cache obsolescenc...
void COLLECTOR::SetRefPos ( const wxPoint aRefPos)
inlineinherited

Definition at line 223 of file class_collector.h.

Referenced by LIB_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), SCH_COLLECTOR::Collect(), and GENERAL_COLLECTOR::Collect().

223 { m_RefPos = aRefPos; }
wxPoint m_RefPos
A point to test against, and that was used to make the collection.
void SCH_FIND_COLLECTOR::SetReplaceString ( const wxString &  aReplaceString)

Update the replace string without changing anything else.

Definition at line 517 of file sch_collectors.cpp.

References m_findReplaceData.

Referenced by SCH_EDIT_FRAME::OnFindReplace().

518 {
519  m_findReplaceData.SetReplaceString( aReplaceString );
520 }
SCH_FIND_REPLACE_DATA m_findReplaceData
The criteria used to test for matching items.
void COLLECTOR::SetScanTypes ( const KICAD_T scanTypes)
inlineinherited

Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() function.

Parameters
scanTypesAn array of KICAD_T, terminated by EOT. No copy is is made of this array (so cannot come from caller's stack).

Definition at line 208 of file class_collector.h.

Referenced by LIB_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), SCH_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), GENERAL_COLLECTOR::GENERAL_COLLECTOR(), GERBER_COLLECTOR::GERBER_COLLECTOR(), LIB_COLLECTOR::LIB_COLLECTOR(), SCH_COLLECTOR::SCH_COLLECTOR(), and SCH_FIND_COLLECTOR().

209  {
210  m_ScanTypes = scanTypes;
211  }
const KICAD_T * m_ScanTypes
Which object types to scan.
void COLLECTOR::SetTimeNow ( )
inlineinherited

Definition at line 213 of file class_collector.h.

References GetNewTimeStamp().

Referenced by GERBER_COLLECTOR::Collect(), and GENERAL_COLLECTOR::Collect().

214  {
216  }
time_t GetNewTimeStamp()
Definition: common.cpp:166
time_t m_TimeAtCollection
The time at which the collection was made.
void SCH_FIND_COLLECTOR::UpdateIndex ( )

Function UpdateIndex updates the list index according to the current find and replace criteria.

Definition at line 399 of file sch_collectors.cpp.

References FR_SEARCH_WRAP, COLLECTOR::GetCount(), m_findReplaceData, and m_foundIndex.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem().

400 {
401  wxUint32 flags = m_findReplaceData.GetFlags();
402 
403  if( flags & wxFR_DOWN )
404  {
405  if( m_foundIndex < GetCount() )
406  m_foundIndex += 1;
407  if( (m_foundIndex >= GetCount()) && (flags & FR_SEARCH_WRAP) )
408  m_foundIndex = 0;
409  }
410  else
411  {
412  if( m_foundIndex >= 0 )
413  m_foundIndex -= 1;
414  if( (m_foundIndex < 0) && (flags & FR_SEARCH_WRAP) )
415  m_foundIndex = GetCount() - 1;
416  }
417 }
int GetCount() const
Function GetCount returns the number of objects in the list.
Wrap around the beginning or end of search list.
int m_foundIndex
The current found item list index.
SCH_FIND_REPLACE_DATA m_findReplaceData
The criteria used to test for matching items.

Member Data Documentation

std::vector< SCH_FIND_COLLECTOR_DATA > SCH_FIND_COLLECTOR::m_data
private

Data associated with each found item.

Definition at line 229 of file sch_collectors.h.

Referenced by Collect(), GetFindData(), GetItem(), GetText(), and Inspect().

SCH_FIND_REPLACE_DATA SCH_FIND_COLLECTOR::m_findReplaceData
private

The criteria used to test for matching items.

Definition at line 232 of file sch_collectors.h.

Referenced by Collect(), Inspect(), PassedEnd(), ReplaceItem(), SetReplaceString(), and UpdateIndex().

bool SCH_FIND_COLLECTOR::m_forceSearch
private

A flag to indicate that the schemtic has been modified and a new search must be performed even if the search criteria hasn't changed.

Definition at line 242 of file sch_collectors.h.

Referenced by Collect().

int SCH_FIND_COLLECTOR::m_foundIndex
private

The current found item list index.

Definition at line 238 of file sch_collectors.h.

Referenced by Collect(), GetFoundIndex(), GetItem(), GetText(), PassedEnd(), ReplaceItem(), and UpdateIndex().

int SCH_FIND_COLLECTOR::m_lib_hash
private

last known library change hash, used to detect library changes which should trigger cache obsolescence.

Definition at line 246 of file sch_collectors.h.

Referenced by GetLibHash().

EDA_RECT COLLECTOR::m_RefBox
protectedinherited

A bounding box to test against, and that was used to make the collection.

Definition at line 72 of file class_collector.h.

Referenced by COLLECTOR::GetBoundingBox().

wxPoint COLLECTOR::m_RefPos
protectedinherited

A point to test against, and that was used to make the collection.

Definition at line 69 of file class_collector.h.

Referenced by COLLECTOR::GetRefPos(), LIB_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), and SCH_COLLECTOR::IsDraggableJunction().

const KICAD_T* COLLECTOR::m_ScanTypes
protectedinherited
SCH_SHEET_PATH* SCH_FIND_COLLECTOR::m_sheetPath
private

The path of the sheet currently being iterated over.

Definition at line 235 of file sch_collectors.h.

Referenced by Collect(), and Inspect().

time_t COLLECTOR::m_TimeAtCollection
protectedinherited

The time at which the collection was made.

Definition at line 75 of file class_collector.h.

Referenced by COLLECTOR::GetTime().


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