CFlatFileExportParams Class Reference

Search Toolkit Book for CFlatFileExportParams

#include <gui/packages/pkg_sequence/flatfile_export_params.hpp>

Inheritance diagram for CFlatFileExportParams:

Collaboration diagram for CFlatFileExportParams:

Public Member Functions
	CFlatFileExportParams ()
	Default constructor for IRegSettings. More...
	CFlatFileExportParams (const CFlatFileExportParams &data)
	Copy constructor for IRegSettings. More...
	~CFlatFileExportParams ()
	Destructor for IRegSettings. More...
void	operator= (const CFlatFileExportParams &data)
	Assignment operator for IRegSettings. More...
bool	operator== (const CFlatFileExportParams &data) const
	Equality operator for IRegSettings. More...
void	Copy (const CFlatFileExportParams &data)
	Copy function for IRegSettings. More...
void	Init ()
	Initialises member variables. More...
virtual void	SetRegistryPath (const string &path)
	IRegSettings. More...
virtual void	SaveSettings () const
	IRegSettings. More...
virtual void	LoadSettings ()
SConstScopedObject	GetSeqLoc () const
wxString	GetFileName () const
void	SetFileName (wxString value)
int	GetMode () const
void	SetMode (int value)
Public Member Functions inherited from IRegSettings
virtual	~IRegSettings ()

Private Attributes
wxString	m_FileName
int	m_Mode
string	m_RegPath
SConstScopedObject	m_SeqLoc

Friends
class	CFlatFileExportPage

Detailed Description

CFlatFileExportParams class declaration

Definition at line 45 of file flatfile_export_params.hpp.

Constructor & Destructor Documentation

CFlatFileExportParams() [1/2]

CFlatFileExportParams::CFlatFileExportParams

(

)

Default constructor for IRegSettings.

CFlatFileExportParams type definition

Default constructor for CFlatFileExportParams

Definition at line 48 of file flatfile_export_params.cpp.

References Init().

CFlatFileExportParams() [2/2]

CFlatFileExportParams::CFlatFileExportParams

(

const CFlatFileExportParams &

data

)

Copy constructor for IRegSettings.

Copy constructor for CFlatFileExportParams

Definition at line 57 of file flatfile_export_params.cpp.

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

~CFlatFileExportParams()

CFlatFileExportParams::~CFlatFileExportParams

(

)

Destructor for IRegSettings.

Destructor for CFlatFileExportParams

Definition at line 67 of file flatfile_export_params.cpp.

Member Function Documentation

Copy()

void CFlatFileExportParams::Copy

(

const CFlatFileExportParams &

data

)

Copy function for IRegSettings.

Copy function for CFlatFileExportParams

Definition at line 97 of file flatfile_export_params.cpp.

References data, m_FileName, m_Mode, and m_SeqLoc.

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

GetFileName()

wxString CFlatFileExportParams::GetFileName ( void  ) const

inline

Definition at line 78 of file flatfile_export_params.hpp.

References m_FileName.

Referenced by CFlatFileExporter::GetTask(), CFlatFileExportJob::Run(), and CFlatFileExportPage::TransferDataFromWindow().

GetMode()

int CFlatFileExportParams::GetMode ( void  ) const

inline

Definition at line 81 of file flatfile_export_params.hpp.

References m_Mode.

Referenced by CFlatFileExportJob::Run().

GetSeqLoc()

SConstScopedObject CFlatFileExportParams::GetSeqLoc ( ) const

inline

Definition at line 75 of file flatfile_export_params.hpp.

References m_SeqLoc.

Referenced by CFlatFileExportJob::Run().

Init()

void CFlatFileExportParams::Init

(

void

)

Initialises member variables.

Member initialisation for CFlatFileExportParams

Definition at line 110 of file flatfile_export_params.cpp.

References m_Mode.

Referenced by CFlatFileExportParams().

LoadSettings()

void CFlatFileExportParams::LoadSettings ( )

virtual

Implements IRegSettings.

Definition at line 132 of file flatfile_export_params.cpp.

References FnToStdString(), FnToWxString(), CGuiRegistry::GetInstance(), CRegistryReadView::GetInt(), CGuiRegistry::GetReadView(), CRegistryReadView::GetString(), kFileName, kMode, m_FileName, m_Mode, and m_RegPath.

Referenced by CFlatFileExporter::LoadSettings().

operator=()

void CFlatFileExportParams::operator=

(

const CFlatFileExportParams &

data

)

Assignment operator for IRegSettings.

Assignment operator for CFlatFileExportParams

Definition at line 75 of file flatfile_export_params.cpp.

References Copy(), and data.

operator==()

bool CFlatFileExportParams::operator==

(

const CFlatFileExportParams &

data

)

const

Equality operator for IRegSettings.

Equality operator for CFlatFileExportParams

Definition at line 84 of file flatfile_export_params.cpp.

References data, m_FileName, and m_Mode.

SaveSettings()

void CFlatFileExportParams::SaveSettings ( ) const

virtual

IRegSettings.

Implements IRegSettings.

Definition at line 121 of file flatfile_export_params.cpp.

References FnToStdString(), CGuiRegistry::GetInstance(), CGuiRegistry::GetWriteView(), kFileName, kMode, m_FileName, m_Mode, m_RegPath, and CRegistryWriteView::Set().

Referenced by CFlatFileExporter::SaveSettings().

SetFileName()

void CFlatFileExportParams::SetFileName ( wxString  value )

inline

Definition at line 79 of file flatfile_export_params.hpp.

References m_FileName, and rapidjson::value.

SetMode()

void CFlatFileExportParams::SetMode ( int  value )

inline

Definition at line 82 of file flatfile_export_params.hpp.

References m_Mode, and rapidjson::value.

SetRegistryPath()

virtual void CFlatFileExportParams::SetRegistryPath ( const string &  path )

inlinevirtual

IRegSettings.

Implements IRegSettings.

Definition at line 71 of file flatfile_export_params.hpp.

References m_RegPath.

Referenced by CFlatFileExporter::SetRegistryPath().

Friends And Related Function Documentation

CFlatFileExportPage

friend class CFlatFileExportPage

friend

Definition at line 47 of file flatfile_export_params.hpp.

Member Data Documentation

m_FileName

wxString CFlatFileExportParams::m_FileName

private

Definition at line 88 of file flatfile_export_params.hpp.

Referenced by Copy(), GetFileName(), LoadSettings(), operator==(), SaveSettings(), and SetFileName().

m_Mode

int CFlatFileExportParams::m_Mode

private

Definition at line 89 of file flatfile_export_params.hpp.

Referenced by Copy(), GetMode(), Init(), LoadSettings(), operator==(), SaveSettings(), and SetMode().

m_RegPath

string CFlatFileExportParams::m_RegPath

private

Definition at line 93 of file flatfile_export_params.hpp.

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

m_SeqLoc

SConstScopedObject CFlatFileExportParams::m_SeqLoc

private

Definition at line 94 of file flatfile_export_params.hpp.

Referenced by Copy(), GetSeqLoc(), and CFlatFileExportPage::TransferDataFromWindow().

---

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

• include/gui/packages/pkg_sequence/flatfile_export_params.hpp
• src/gui/packages/pkg_sequence/flatfile_export_params.cpp