NCBI C++ ToolKit
Public Member Functions | Private Attributes | Friends | List of all members
CPhyExportParams Class Reference

Search Toolkit Book for CPhyExportParams

#include <gui/packages/pkg_alignment/phy_export_params.hpp>

+ Inheritance diagram for CPhyExportParams:
+ Collaboration diagram for CPhyExportParams:

Public Member Functions

 CPhyExportParams ()
 Default constructor for CPhyExportParams. More...
 CPhyExportParams (const CPhyExportParams &data)
 Copy constructor for CPhyExportParams. More...
 ~CPhyExportParams ()
 Destructor for CPhyExportParams. More...
void operator= (const CPhyExportParams &data)
 Assignment operator for CPhyExportParams. More...
bool operator== (const CPhyExportParams &data) const
 Equality operator for CPhyExportParams. More...
void Copy (const CPhyExportParams &data)
 Copy function for CPhyExportParams. More...
void Init ()
 Initialises member variables. More...
virtual void SetRegistryPath (const string &path)
 IRegSettings. More...
virtual void SaveSettings () const
 IRegSettings. More...
virtual void LoadSettings ()
const wxString & GetFileName () const
wxString * SetFileName ()
void SetFileName (const wxString &value)
const wxString & GetFileFormat () const
void SetFileFormat (const wxString &value)
const wxString & GetLabelFormat () const
void SetLabelFormat (const wxString &value)
CBioTreeContainerGetBioTree ()
void SetBioTree (CBioTreeContainer *value)
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()

Private Attributes

wxString m_FileName
wxString m_FileFormat
wxString m_LabelFormat
CRef< CBioTreeContainerm_pBioTree
string m_RegPath


class CPhyLoadPage

Detailed Description

CPhyExportParams class declaration

Definition at line 47 of file phy_export_params.hpp.

Constructor & Destructor Documentation

◆ CPhyExportParams() [1/2]

CPhyExportParams::CPhyExportParams ( )

Default constructor for CPhyExportParams.

CPhyExportParams type definition

Default constructor for CPhyExportParams

Definition at line 50 of file phy_export_params.cpp.

References Init().

◆ CPhyExportParams() [2/2]

CPhyExportParams::CPhyExportParams ( const CPhyExportParams data)

Copy constructor for CPhyExportParams.

Copy constructor for CPhyExportParams

Definition at line 59 of file phy_export_params.cpp.

References Copy(), data, and Init().

◆ ~CPhyExportParams()

CPhyExportParams::~CPhyExportParams ( )

Destructor for CPhyExportParams.

Destructor for CPhyExportParams

Definition at line 69 of file phy_export_params.cpp.

Member Function Documentation

◆ Copy()

void CPhyExportParams::Copy ( const CPhyExportParams data)

Copy function for CPhyExportParams.

Copy function for CPhyExportParams

Definition at line 100 of file phy_export_params.cpp.

References data, m_FileFormat, m_FileName, m_LabelFormat, and m_pBioTree.

Referenced by CPhyExportParams(), and operator=().

◆ GetBioTree()

CBioTreeContainer* CPhyExportParams::GetBioTree ( )

Definition at line 88 of file phy_export_params.hpp.

References CRef< C, Locker >::GetPointerOrNull(), and m_pBioTree.

Referenced by CPhyExportJob::Run().

◆ GetFileFormat()

const wxString& CPhyExportParams::GetFileFormat ( ) const

◆ GetFileName()

const wxString& CPhyExportParams::GetFileName ( void  ) const

◆ GetLabelFormat()

const wxString& CPhyExportParams::GetLabelFormat ( ) const

Definition at line 85 of file phy_export_params.hpp.

References m_LabelFormat.

Referenced by CPhyExportJob::Run().

◆ Init()

void CPhyExportParams::Init ( void  )

Initialises member variables.

Member initialisation for CPhyExportParams

Definition at line 114 of file phy_export_params.cpp.

References m_FileFormat, m_FileName, m_LabelFormat, m_pBioTree, NULL, and wxT.

Referenced by CPhyExportParams().

◆ LoadSettings()

void CPhyExportParams::LoadSettings ( )

◆ operator=()

void CPhyExportParams::operator= ( const CPhyExportParams data)

Assignment operator for CPhyExportParams.

Assignment operator for CPhyExportParams

Definition at line 77 of file phy_export_params.cpp.

References Copy(), and data.

◆ operator==()

bool CPhyExportParams::operator== ( const CPhyExportParams data) const

Equality operator for CPhyExportParams.

Equality operator for CPhyExportParams

Definition at line 86 of file phy_export_params.cpp.

References data, m_FileFormat, and m_FileName.

◆ SaveSettings()

void CPhyExportParams::SaveSettings ( ) const

◆ SetBioTree()

void CPhyExportParams::SetBioTree ( CBioTreeContainer value)

Definition at line 89 of file phy_export_params.hpp.

References m_pBioTree, and rapidjson::value.

Referenced by CPhyTreeView::OnExportTree(), and CPhyExporter::SetObjects().

◆ SetFileFormat()

void CPhyExportParams::SetFileFormat ( const wxString &  value)

◆ SetFileName() [1/2]

wxString* CPhyExportParams::SetFileName ( )

Definition at line 79 of file phy_export_params.hpp.

References m_FileName.

Referenced by CExportTreeDlg::TransferDataFromWindow().

◆ SetFileName() [2/2]

void CPhyExportParams::SetFileName ( const wxString &  value)

Definition at line 80 of file phy_export_params.hpp.

References m_FileName, and rapidjson::value.

◆ SetLabelFormat()

void CPhyExportParams::SetLabelFormat ( const wxString &  value)

Definition at line 86 of file phy_export_params.hpp.

References m_LabelFormat, and rapidjson::value.

Referenced by CPhyTreeView::OnExportTree().

◆ SetRegistryPath()

virtual void CPhyExportParams::SetRegistryPath ( const string path)


Implements IRegSettings.

Definition at line 73 of file phy_export_params.hpp.

References m_RegPath.

Referenced by CPhyExporter::SetRegistryPath().

Friends And Related Function Documentation

◆ CPhyLoadPage

friend class CPhyLoadPage

Definition at line 49 of file phy_export_params.hpp.

Member Data Documentation

◆ m_FileFormat

wxString CPhyExportParams::m_FileFormat

◆ m_FileName

wxString CPhyExportParams::m_FileName

◆ m_LabelFormat

wxString CPhyExportParams::m_LabelFormat

Definition at line 97 of file phy_export_params.hpp.

Referenced by Copy(), GetLabelFormat(), Init(), and SetLabelFormat().

◆ m_pBioTree

CRef<CBioTreeContainer> CPhyExportParams::m_pBioTree

Definition at line 98 of file phy_export_params.hpp.

Referenced by Copy(), GetBioTree(), Init(), and SetBioTree().

◆ m_RegPath

string CPhyExportParams::m_RegPath

Definition at line 103 of file phy_export_params.hpp.

Referenced by LoadSettings(), SaveSettings(), and SetRegistryPath().

The documentation for this class was generated from the following files:
Modified on Fri Apr 12 17:15:58 2024 by rev. 669887