EQCurveWriter Class Reference

Serializer of curves into XML files. More...

#include <EqualizationCurves.h>

Collaboration diagram for EQCurveWriter:

Public Member Functions
	EQCurveWriter (const EQCurveArray &curves)
void	SaveCurves (const wxString &fileName={})

Private Member Functions
void	WriteXML (XMLWriter &xmlFile) const

Private Attributes
const EQCurveArray &	mCurves

Detailed Description

Serializer of curves into XML files.

Definition at line 55 of file EqualizationCurves.h.

Constructor & Destructor Documentation

EQCurveWriter()

EQCurveWriter::EQCurveWriter ( const EQCurveArray &  curves )

inlineexplicit

Definition at line 57 of file EqualizationCurves.h.

: mCurves{ curves } {}

Member Function Documentation

SaveCurves()

void EQCurveWriter::SaveCurves

(

const wxString &

fileName = {}

)

Definition at line 282 of file EqualizationCurves.cpp.

{
   wxFileName fn;
   if( fileName.empty() )
   {
      // Construct default curve filename
      //
      // LLL:  Wouldn't you know that as of WX 2.6.2, there is a conflict
      //       between wxStandardPaths and wxConfig under Linux.  The latter
      //       creates a normal file as "$HOME/.audacity", while the former
      //       expects the ".audacity" portion to be a directory.
      fn = wxFileName( FileNames::DataDir(), wxT("EQCurves.xml") );
 
      // If the directory doesn't exist...
      if( !fn.DirExists() )
      {
         // Attempt to create it
         if( !fn.Mkdir( fn.GetPath(), 511, wxPATH_MKDIR_FULL ) )
         {
            // MkDir() will emit message
            return;
         }
      }
   }
   else
      fn = fileName;
 
   GuardedCall( [&] {
      // Create/Open the file
      const wxString fullPath{ fn.GetFullPath() };
      XMLFileWriter eqFile{ fullPath, XO("Error Saving Equalization Curves") };
 
      // Write the curves
      WriteXML( eqFile );
 
      eqFile.Commit();
   } );
}

References FileNames::DataDir(), fn, GuardedCall(), WriteXML(), wxT(), and XO().

Referenced by EqualizationCurvesDialog::OnExport(), and EqualizationUI::ValidateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteXML()

void EQCurveWriter::WriteXML ( XMLWriter &  xmlFile ) const

private

Definition at line 442 of file EqualizationCurves.cpp.

{
   // Start our hierarchy
   xmlFile.StartTag( wxT( "equalizationeffect" ) );
 
   // Write all curves
   int numCurves = mCurves.size();
   int curve;
   for( curve = 0; curve < numCurves; curve++ )
   {
      // Start a NEW curve
      xmlFile.StartTag( wxT( "curve" ) );
      xmlFile.WriteAttr( wxT( "name" ), mCurves[ curve ].Name );
 
      // Write all points
      int numPoints = mCurves[ curve ].points.size();
      int point;
      for( point = 0; point < numPoints; point++ )
      {
         // Write NEW point
         xmlFile.StartTag( wxT( "point" ) );
         xmlFile.WriteAttr( wxT( "f" ), mCurves[ curve ].points[ point ].Freq, 12 );
         xmlFile.WriteAttr( wxT( "d" ), mCurves[ curve ].points[ point ].dB, 12 );
         xmlFile.EndTag( wxT( "point" ) );
      }
 
      // Terminate curve
      xmlFile.EndTag( wxT( "curve" ) );
   }
 
   // Terminate our hierarchy
   xmlFile.EndTag( wxT( "equalizationeffect" ) );
}

References wxT().

Referenced by SaveCurves().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCurves

const EQCurveArray& EQCurveWriter::mCurves

private

Definition at line 62 of file EqualizationCurves.h.

---

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

• EqualizationCurves.h
• EqualizationCurves.cpp