Audacity 3.2.0
Public Member Functions | Public Attributes | List of all members
CommandOutputTargets Class Reference

CommandOutputTargets a mix of three output classes to output progress indication, status messages and errors. More...

#include <CommandTargets.h>

Inheritance diagram for CommandOutputTargets:
[legend]
Collaboration diagram for CommandOutputTargets:
[legend]

Public Member Functions

 CommandOutputTargets (std::unique_ptr< CommandProgressTarget > &&pt=TargetFactory::ProgressDefault(), std::shared_ptr< CommandMessageTarget > &&st=TargetFactory::MessageDefault(), std::shared_ptr< CommandMessageTarget > &&et=TargetFactory::MessageDefault())
 
 ~CommandOutputTargets ()
 
void Progress (double completed)
 
void Status (const wxString &status, bool bFlush=false)
 
void Error (const wxString &message)
 
void StartArray ()
 
void EndArray ()
 
void StartStruct ()
 
void EndStruct ()
 
void StartField (const wxString &name)
 
void EndField ()
 
void AddItem (const wxString &value, const wxString &name={})
 
void AddBool (const bool value, const wxString &name={})
 
void AddItem (const double value, const wxString &name={})
 

Public Attributes

std::unique_ptr< CommandProgressTargetmProgressTarget
 
std::shared_ptr< CommandMessageTargetmStatusTarget
 
std::shared_ptr< CommandMessageTargetmErrorTarget
 

Detailed Description

CommandOutputTargets a mix of three output classes to output progress indication, status messages and errors.

Used to aggregate the various output targets a command may have. Assumes responsibility for pointers passed into it. mProgressTarget is a unique pointer, but mStatusTraget and mErrorTarget are shared ones, because they may both point to the same output

Definition at line 305 of file CommandTargets.h.

Constructor & Destructor Documentation

◆ CommandOutputTargets()

CommandOutputTargets::CommandOutputTargets ( std::unique_ptr< CommandProgressTarget > &&  pt = TargetFactory::ProgressDefault(),
std::shared_ptr< CommandMessageTarget > &&  st = TargetFactory::MessageDefault(),
std::shared_ptr< CommandMessageTarget > &&  et = TargetFactory::MessageDefault() 
)
inline

Definition at line 315 of file CommandTargets.h.

318 : mProgressTarget(std::move(pt)), mStatusTarget(st), mErrorTarget(et)
319 { }
std::shared_ptr< CommandMessageTarget > mStatusTarget
std::unique_ptr< CommandProgressTarget > mProgressTarget
std::shared_ptr< CommandMessageTarget > mErrorTarget

◆ ~CommandOutputTargets()

CommandOutputTargets::~CommandOutputTargets ( )
inline

Definition at line 320 of file CommandTargets.h.

321 {
322 }

Member Function Documentation

◆ AddBool()

void CommandOutputTargets::AddBool ( const bool  value,
const wxString &  name = {} 
)
inline

Definition at line 377 of file CommandTargets.h.

377 {} )
378 {
379 if (mStatusTarget)
380 mStatusTarget->AddItem( value, name );
381 }
const TranslatableString name
Definition: Distortion.cpp:76

◆ AddItem() [1/2]

void CommandOutputTargets::AddItem ( const double  value,
const wxString &  name = {} 
)
inline

Definition at line 382 of file CommandTargets.h.

382 {} )
383 {
384 if (mStatusTarget)
385 mStatusTarget->AddItem( value, name );
386 }

◆ AddItem() [2/2]

void CommandOutputTargets::AddItem ( const wxString &  value,
const wxString &  name = {} 
)
inline

Definition at line 372 of file CommandTargets.h.

372 {} )
373 {
374 if (mStatusTarget)
375 mStatusTarget->AddItem( value, name );
376 }

◆ EndArray()

void CommandOutputTargets::EndArray ( )
inline

Definition at line 347 of file CommandTargets.h.

348 {
349 if (mStatusTarget)
350 mStatusTarget->EndArray();
351 }

References mStatusTarget.

◆ EndField()

void CommandOutputTargets::EndField ( )
inline

Definition at line 367 of file CommandTargets.h.

368 {
369 if (mStatusTarget)
370 mStatusTarget->EndField();
371 }

References mStatusTarget.

◆ EndStruct()

void CommandOutputTargets::EndStruct ( )
inline

Definition at line 357 of file CommandTargets.h.

358 {
359 if (mStatusTarget)
360 mStatusTarget->EndStruct();
361 }

References mStatusTarget.

◆ Error()

void CommandOutputTargets::Error ( const wxString &  message)
inline

Definition at line 337 of file CommandTargets.h.

338 {
339 if (mErrorTarget)
340 mErrorTarget->Update(message);
341 }

References mErrorTarget.

◆ Progress()

void CommandOutputTargets::Progress ( double  completed)
inline

Definition at line 324 of file CommandTargets.h.

325 {
326 if (mProgressTarget)
327 mProgressTarget->Update(completed);
328 }

References mProgressTarget.

◆ StartArray()

void CommandOutputTargets::StartArray ( )
inline

Definition at line 342 of file CommandTargets.h.

343 {
344 if (mStatusTarget)
345 mStatusTarget->StartArray();
346 }

References mStatusTarget.

◆ StartField()

void CommandOutputTargets::StartField ( const wxString &  name)
inline

Definition at line 362 of file CommandTargets.h.

363 {
364 if (mStatusTarget)
365 mStatusTarget->StartField(name);
366 }

References mStatusTarget, and name.

◆ StartStruct()

void CommandOutputTargets::StartStruct ( )
inline

Definition at line 352 of file CommandTargets.h.

353 {
354 if (mStatusTarget)
355 mStatusTarget->StartStruct();
356 }

References mStatusTarget.

◆ Status()

void CommandOutputTargets::Status ( const wxString &  status,
bool  bFlush = false 
)
inline

Definition at line 329 of file CommandTargets.h.

330 {
331 if (mStatusTarget){
332 mStatusTarget->Update(status);
333 if( bFlush )
334 mStatusTarget->Flush();
335 }
336 }

References mStatusTarget.

Member Data Documentation

◆ mErrorTarget

std::shared_ptr<CommandMessageTarget> CommandOutputTargets::mErrorTarget

◆ mProgressTarget

std::unique_ptr<CommandProgressTarget> CommandOutputTargets::mProgressTarget

◆ mStatusTarget

std::shared_ptr<CommandMessageTarget> CommandOutputTargets::mStatusTarget

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