OpenCPN Partial API docs
Loading...
Searching...
No Matches
ChartDB Class Reference
Inheritance diagram for ChartDB:
ChartDatabase

Public Member Functions

bool LoadBinary (const wxString &filename, ArrayOfCDI &dir_array_check)
 
bool SaveBinary (const wxString &filename)
 
int BuildChartStack (ChartStack *cstk, float lat, float lon, int groupIndex)
 
int BuildChartStack (ChartStack *cstk, float lat, float lon, int db_add, int groupIndex)
 
bool EqualStacks (ChartStack *, ChartStack *)
 
bool CopyStack (ChartStack *pa, ChartStack *pb)
 
wxString GetFullPath (ChartStack *ps, int stackindex)
 
int GetStackChartScale (ChartStack *ps, int stackindex, char *buf, int nbuf)
 
int GetCSPlyPoint (ChartStack *ps, int stackindex, int plyindex, float *lat, float *lon)
 
ChartTypeEnum GetCSChartType (ChartStack *ps, int stackindex)
 
ChartFamilyEnum GetCSChartFamily (ChartStack *ps, int stackindex)
 
bool SearchForChartDir (const wxString &dir)
 
ChartBaseOpenStackChartConditional (ChartStack *ps, int start_index, bool bLargest, ChartTypeEnum New_Type, ChartFamilyEnum New_Family_Fallback)
 
wxArrayPtrVoid * GetChartCache (void)
 
std::vector< int > GetCSArray (ChartStack *ps)
 
int GetStackEntry (ChartStack *ps, wxString fp)
 
bool IsChartInCache (int dbindex)
 
bool IsChartInCache (wxString path)
 
bool IsChartInGroup (const int db_index, const int group)
 
bool IsENCInGroup (const int group)
 
bool IsNonMBTileInGroup (const int group)
 
ChartBaseOpenChartFromStack (ChartStack *pStack, int StackEntry, ChartInitFlag iflag=FULL_INIT)
 
ChartBaseOpenChartFromDB (int index, ChartInitFlag init_flag)
 
ChartBaseOpenChartFromDBAndLock (int index, ChartInitFlag init_flag, bool lock=true)
 
ChartBaseOpenChartFromDBAndLock (wxString chart_path, ChartInitFlag init_flag)
 
ChartBaseOpenChartFromDB (wxString chart_path, ChartInitFlag init_flag)
 
void ApplyColorSchemeToCachedCharts (ColorScheme cs)
 
void PurgeCache ()
 
void PurgeCachePlugins ()
 
bool DeleteCacheChart (ChartBase *pChart)
 
void LockCache (bool bl)
 
void LockCache ()
 
void UnLockCache ()
 
bool IsCacheLocked ()
 
wxXmlDocument GetXMLDescription (int dbIndex, bool b_getGeom)
 
bool LockCacheChart (int index)
 
bool IsChartLocked (int index)
 
void UnLockCacheChart (int index)
 
void UnLockAllCacheCharts ()
 
void ClearCacheInUseFlags (void)
 
void PurgeCacheUnusedCharts (double factor)
 
bool IsBusy ()
 
bool CheckExclusiveTileGroup (int canvasIndex)
 
bool CheckAnyCanvasExclusiveTileGroup ()
 
- Public Member Functions inherited from ChartDatabase
bool Create (ArrayOfCDI &dir_array, wxGenericProgressDialog *pprog)
 
bool Update (ArrayOfCDI &dir_array, bool bForce, wxGenericProgressDialog *pprog)
 
bool Read (const wxString &filePath)
 
bool Write (const wxString &filePath)
 
bool AddSingleChart (wxString &fullpath, bool b_force_full_search=true)
 
bool RemoveSingleChart (wxString &ChartFullPath)
 
const wxString & GetDBFileName () const
 
ArrayOfCDI & GetChartDirArray ()
 
wxArrayString & GetChartDirArrayString ()
 
void SetChartDirArray (ArrayOfCDI array)
 
bool CompareChartDirArray (ArrayOfCDI &test_array)
 
wxString GetMagicNumberCached (wxString dir)
 
void UpdateChartClassDescriptorArray (void)
 
int GetChartTableEntries () const
 
const ChartTableEntryGetChartTableEntry (int index) const
 
ChartTableEntryGetpChartTableEntry (int index) const
 
ChartTable & GetChartTable ()
 
bool IsValid () const
 
int DisableChart (wxString &PathToDisable)
 
bool GetCentroidOfLargestScaleChart (double *clat, double *clon, ChartFamilyEnum family)
 
int GetDBChartType (int dbIndex)
 
int GetDBChartFamily (int dbIndex)
 
float GetDBChartSkew (int dbIndex)
 
int GetDBChartProj (int dbIndex)
 
int GetDBChartScale (int dbIndex)
 
bool GetDBBoundingBox (int dbindex, LLBBox &box)
 
const LLBBox & GetDBBoundingBox (int dbIndex)
 
int GetnAuxPlyEntries (int dbIndex)
 
int GetDBPlyPoint (int dbIndex, int plyindex, float *lat, float *lon)
 
int GetDBAuxPlyPoint (int dbIndex, int plyindex, int iAuxPly, float *lat, float *lon)
 
int GetVersion ()
 
wxString GetFullChartInfo (ChartBase *pc, int dbIndex, int *char_width, int *line_count)
 
int FinddbIndex (wxString PathToFind)
 
wxString GetDBChartFileName (int dbIndex)
 
void ApplyGroupArray (ChartGroupArray *pGroupArray)
 
bool IsChartAvailable (int dbIndex)
 
std::vector< float > GetReducedPlyPoints (int dbIndex)
 
std::vector< float > GetReducedAuxPlyPoints (int dbIndex, int iTable)
 
bool IsBusy ()
 

Protected Member Functions

virtual ChartBaseGetChart (const wxChar *theFilePath, ChartClassDescriptor &chart_desc) const
 
- Protected Member Functions inherited from ChartDatabase
virtual ChartBaseGetChart (const wxChar *theFilePath, ChartClassDescriptor &chart_desc) const
 
int AddChartDirectory (const wxString &theDir, bool bshow_prog)
 
void SetValid (bool valid)
 
ChartTableEntryCreateChartTableEntry (const wxString &filePath, wxString &utf8Path, ChartClassDescriptor &chart_desc)
 

Additional Inherited Members

- Public Attributes inherited from ChartDatabase
ChartTable active_chartTable
 
std::map< wxString, int > active_chartTable_pathindex
 
- Protected Attributes inherited from ChartDatabase
ArrayOfChartClassDescriptor m_ChartClassDescriptorArray
 
ArrayOfCDI m_dir_array
 
bool m_b_busy
 

Detailed Description

Definition at line 93 of file chartdb.h.

Constructor & Destructor Documentation

◆ ChartDB()

ChartDB::ChartDB ( )

Definition at line 200 of file chartdb.cpp.

◆ ~ChartDB()

ChartDB::~ChartDB ( )
virtual

Definition at line 226 of file chartdb.cpp.

Member Function Documentation

◆ ApplyColorSchemeToCachedCharts()

void ChartDB::ApplyColorSchemeToCachedCharts ( ColorScheme  cs)

Definition at line 1463 of file chartdb.cpp.

◆ BuildChartStack() [1/2]

int ChartDB::BuildChartStack ( ChartStack cstk,
float  lat,
float  lon,
int  db_add,
int  groupIndex 
)

Definition at line 450 of file chartdb.cpp.

◆ BuildChartStack() [2/2]

int ChartDB::BuildChartStack ( ChartStack cstk,
float  lat,
float  lon,
int  groupIndex 
)

Definition at line 459 of file chartdb.cpp.

◆ CheckAnyCanvasExclusiveTileGroup()

bool ChartDB::CheckAnyCanvasExclusiveTileGroup ( )

Definition at line 1801 of file chartdb.cpp.

◆ CheckExclusiveTileGroup()

bool ChartDB::CheckExclusiveTileGroup ( int  canvasIndex)

Definition at line 1762 of file chartdb.cpp.

◆ ClearCacheInUseFlags()

void ChartDB::ClearCacheInUseFlags ( void  )

Definition at line 310 of file chartdb.cpp.

◆ CopyStack()

bool ChartDB::CopyStack ( ChartStack pa,
ChartStack pb 
)

Definition at line 751 of file chartdb.cpp.

◆ DeleteCacheChart()

bool ChartDB::DeleteCacheChart ( ChartBase pChart)

Definition at line 1432 of file chartdb.cpp.

◆ EqualStacks()

bool ChartDB::EqualStacks ( ChartStack pa,
ChartStack pb 
)

Definition at line 736 of file chartdb.cpp.

◆ GetChart()

ChartBase * ChartDB::GetChart ( const wxChar *  theFilePath,
ChartClassDescriptor chart_desc 
) const
protectedvirtual

Reimplemented from ChartDatabase.

Definition at line 396 of file chartdb.cpp.

◆ GetChartCache()

wxArrayPtrVoid * ChartDB::GetChartCache ( void  )
inline

Definition at line 119 of file chartdb.h.

◆ GetCSArray()

std::vector< int > ChartDB::GetCSArray ( ChartStack ps)

Definition at line 857 of file chartdb.cpp.

◆ GetCSChartFamily()

ChartFamilyEnum ChartDB::GetCSChartFamily ( ChartStack ps,
int  stackindex 
)

Definition at line 829 of file chartdb.cpp.

◆ GetCSChartType()

ChartTypeEnum ChartDB::GetCSChartType ( ChartStack ps,
int  stackindex 
)

Definition at line 820 of file chartdb.cpp.

◆ GetCSPlyPoint()

int ChartDB::GetCSPlyPoint ( ChartStack ps,
int  stackindex,
int  plyindex,
float *  lat,
float *  lon 
)

Definition at line 773 of file chartdb.cpp.

◆ GetFullPath()

wxString ChartDB::GetFullPath ( ChartStack ps,
int  stackindex 
)

Definition at line 764 of file chartdb.cpp.

◆ GetStackChartScale()

int ChartDB::GetStackChartScale ( ChartStack ps,
int  stackindex,
char *  buf,
int  nbuf 
)

Definition at line 793 of file chartdb.cpp.

◆ GetStackEntry()

int ChartDB::GetStackEntry ( ChartStack ps,
wxString  fp 
)

Definition at line 808 of file chartdb.cpp.

◆ GetXMLDescription()

wxXmlDocument ChartDB::GetXMLDescription ( int  dbIndex,
bool  b_getGeom 
)

Definition at line 1530 of file chartdb.cpp.

◆ IsBusy()

bool ChartDB::IsBusy ( )
inline

Definition at line 158 of file chartdb.h.

◆ IsCacheLocked()

bool ChartDB::IsCacheLocked ( )
inline

Definition at line 146 of file chartdb.h.

◆ IsChartInCache() [1/2]

bool ChartDB::IsChartInCache ( int  dbindex)

Definition at line 870 of file chartdb.cpp.

◆ IsChartInCache() [2/2]

bool ChartDB::IsChartInCache ( wxString  path)

Definition at line 890 of file chartdb.cpp.

◆ IsChartInGroup()

bool ChartDB::IsChartInGroup ( const int  db_index,
const int  group 
)

Definition at line 619 of file chartdb.cpp.

◆ IsChartLocked()

bool ChartDB::IsChartLocked ( int  index)

Definition at line 909 of file chartdb.cpp.

◆ IsENCInGroup()

bool ChartDB::IsENCInGroup ( const int  group)

Definition at line 637 of file chartdb.cpp.

◆ IsNonMBTileInGroup()

bool ChartDB::IsNonMBTileInGroup ( const int  group)

Definition at line 668 of file chartdb.cpp.

◆ LoadBinary()

bool ChartDB::LoadBinary ( const wxString &  filename,
ArrayOfCDI &  dir_array_check 
)

Definition at line 233 of file chartdb.cpp.

◆ LockCache() [1/2]

void ChartDB::LockCache ( )
inline

Definition at line 144 of file chartdb.h.

◆ LockCache() [2/2]

void ChartDB::LockCache ( bool  bl)
inline

Definition at line 143 of file chartdb.h.

◆ LockCacheChart()

bool ChartDB::LockCacheChart ( int  index)

Definition at line 926 of file chartdb.cpp.

◆ OpenChartFromDB() [1/2]

ChartBase * ChartDB::OpenChartFromDB ( int  index,
ChartInitFlag  init_flag 
)

Definition at line 974 of file chartdb.cpp.

◆ OpenChartFromDB() [2/2]

ChartBase * ChartDB::OpenChartFromDB ( wxString  chart_path,
ChartInitFlag  init_flag 
)

Definition at line 978 of file chartdb.cpp.

◆ OpenChartFromDBAndLock() [1/2]

ChartBase * ChartDB::OpenChartFromDBAndLock ( int  index,
ChartInitFlag  init_flag,
bool  lock = true 
)

Definition at line 989 of file chartdb.cpp.

◆ OpenChartFromDBAndLock() [2/2]

ChartBase * ChartDB::OpenChartFromDBAndLock ( wxString  chart_path,
ChartInitFlag  init_flag 
)

Definition at line 997 of file chartdb.cpp.

◆ OpenChartFromStack()

ChartBase * ChartDB::OpenChartFromStack ( ChartStack pStack,
int  StackEntry,
ChartInitFlag  iflag = FULL_INIT 
)

Definition at line 984 of file chartdb.cpp.

◆ OpenStackChartConditional()

ChartBase * ChartDB::OpenStackChartConditional ( ChartStack ps,
int  start_index,
bool  bLargest,
ChartTypeEnum  New_Type,
ChartFamilyEnum  New_Family_Fallback 
)

Definition at line 1486 of file chartdb.cpp.

◆ PurgeCache()

void ChartDB::PurgeCache ( )

Definition at line 270 of file chartdb.cpp.

◆ PurgeCachePlugins()

void ChartDB::PurgeCachePlugins ( )

Definition at line 285 of file chartdb.cpp.

◆ PurgeCacheUnusedCharts()

void ChartDB::PurgeCacheUnusedCharts ( double  factor)

Definition at line 324 of file chartdb.cpp.

◆ SaveBinary()

bool ChartDB::SaveBinary ( const wxString &  filename)
inline

Definition at line 99 of file chartdb.h.

◆ UnLockAllCacheCharts()

void ChartDB::UnLockAllCacheCharts ( )

Definition at line 959 of file chartdb.cpp.

◆ UnLockCache()

void ChartDB::UnLockCache ( )
inline

Definition at line 145 of file chartdb.h.

◆ UnLockCacheChart()

void ChartDB::UnLockCacheChart ( int  index)

Definition at line 944 of file chartdb.cpp.


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