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:

Collaboration diagram for CommandOutputTargets:

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< CommandProgressTarget >	mProgressTarget
std::shared_ptr< CommandMessageTarget >	mStatusTarget
std::shared_ptr< CommandMessageTarget >	mErrorTarget

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.

      : mProgressTarget(std::move(pt)), mStatusTarget(st), mErrorTarget(et)
   { }

~CommandOutputTargets()

CommandOutputTargets::~CommandOutputTargets ( )

inline

Definition at line 320 of file CommandTargets.h.

   {
   }

Member Function Documentation

AddBool()

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

inline

Definition at line 377 of file CommandTargets.h.

                                                               {} )
   {
      if (mStatusTarget)
         mStatusTarget->AddItem( value, name );
   }

AddItem() [1/2]

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

inline

Definition at line 382 of file CommandTargets.h.

                                                               {} )
   {
      if (mStatusTarget)
         mStatusTarget->AddItem( value, name );
   }

AddItem() [2/2]

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

inline

Definition at line 372 of file CommandTargets.h.

                                                               {} )
   {
      if (mStatusTarget)
         mStatusTarget->AddItem( value, name );
   }

EndArray()

void CommandOutputTargets::EndArray ( )

inline

Definition at line 347 of file CommandTargets.h.

   {
      if (mStatusTarget)
         mStatusTarget->EndArray();
   }

References mStatusTarget.

EndField()

void CommandOutputTargets::EndField ( )

inline

Definition at line 367 of file CommandTargets.h.

   {
      if (mStatusTarget)
         mStatusTarget->EndField();
   }

References mStatusTarget.

EndStruct()

void CommandOutputTargets::EndStruct ( )

inline

Definition at line 357 of file CommandTargets.h.

   {
      if (mStatusTarget)
         mStatusTarget->EndStruct();
   }

References mStatusTarget.

Error()

void CommandOutputTargets::Error ( const wxString &  message )

inline

Definition at line 337 of file CommandTargets.h.

   {
      if (mErrorTarget)
         mErrorTarget->Update(message);
   }

References mErrorTarget.

Progress()

void CommandOutputTargets::Progress ( double  completed )

inline

Definition at line 324 of file CommandTargets.h.

   {
      if (mProgressTarget)
         mProgressTarget->Update(completed);
   }

References mProgressTarget.

StartArray()

void CommandOutputTargets::StartArray ( )

inline

Definition at line 342 of file CommandTargets.h.

   {
      if (mStatusTarget)
         mStatusTarget->StartArray();
   }

References mStatusTarget.

StartField()

void CommandOutputTargets::StartField ( const wxString &  name )

inline

Definition at line 362 of file CommandTargets.h.

   {
      if (mStatusTarget)
         mStatusTarget->StartField(name);
   }

References mStatusTarget, and name.

StartStruct()

void CommandOutputTargets::StartStruct ( )

inline

Definition at line 352 of file CommandTargets.h.

   {
      if (mStatusTarget)
         mStatusTarget->StartStruct();
   }

References mStatusTarget.

Status()

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

inline

Definition at line 329 of file CommandTargets.h.

   {
      if (mStatusTarget){
         mStatusTarget->Update(status);
         if( bFlush )
            mStatusTarget->Flush();
      }
   }

References mStatusTarget.

Member Data Documentation

mErrorTarget

std::shared_ptr<CommandMessageTarget> CommandOutputTargets::mErrorTarget

Definition at line 310 of file CommandTargets.h.

Referenced by BriefCommandOutputTargets::BriefCommandOutputTargets(), Error(), LispifiedCommandOutputTargets::LispifiedCommandOutputTargets(), BriefCommandOutputTargets::~BriefCommandOutputTargets(), and LispifiedCommandOutputTargets::~LispifiedCommandOutputTargets().

mProgressTarget

std::unique_ptr<CommandProgressTarget> CommandOutputTargets::mProgressTarget

Definition at line 308 of file CommandTargets.h.

Referenced by BriefCommandOutputTargets::BriefCommandOutputTargets(), LispifiedCommandOutputTargets::LispifiedCommandOutputTargets(), Progress(), BriefCommandOutputTargets::~BriefCommandOutputTargets(), and LispifiedCommandOutputTargets::~LispifiedCommandOutputTargets().

mStatusTarget

std::shared_ptr<CommandMessageTarget> CommandOutputTargets::mStatusTarget

Definition at line 309 of file CommandTargets.h.

Referenced by BriefCommandOutputTargets::BriefCommandOutputTargets(), EndArray(), EndField(), EndStruct(), LispifiedCommandOutputTargets::LispifiedCommandOutputTargets(), StartArray(), StartField(), StartStruct(), and Status().

---

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

• CommandTargets.h