Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
CmdData Class Reference
Inheritance diagram for CmdData:
Inheritance graph
[legend]
Collaboration diagram for CmdData:
Collaboration graph
[legend]

Public Member Functions

 CmdData (const CmdData &cmd)
 
void exec () const override
 Run the command with current parameter values.
 
- Public Member Functions inherited from CmdPolarBase
 CmdPolarBase (const std::string &name, const std::string &description, Graphic::GRAPHIC cg=GRID)
 
 CmdPolarBase (const CmdPolarBase &cmd)
 
drain::image::TreeSVG & getOverlay (drain::image::TreeSVG &overlayGroup, const std::string &label="") const
 
- Public Member Functions inherited from Graphic
 Graphic (GRAPHIC g=RAY)
 
 Graphic (const Graphic &g)
 
 Graphic (const drain::ClassXML &cls)
 
- Public Member Functions inherited from BasicCommand
 BasicCommand (const std::string &name, const std::string &description)
 
 BasicCommand (const BasicCommand &cmd)
 
- Public Member Functions inherited from BeanCommand< BeanLike >
 BeanCommand (const std::string &name, const std::string &description)
 
 BeanCommand (const BeanCommand &cmd)
 
 BeanCommand (BeanLike &b)
 
virtual const bean_tgetBean () const
 
virtual bean_tgetBean ()
 
const std::string & getName () const final
 Returns the class name of this command, like "CmdVerbose".
 
const std::string & getDescription () const final
 
virtual const drain::ReferenceMapgetParameters () const
 
- Public Member Functions inherited from Command
 Command (const Command &cmd)
 
virtual void setParameters (const std::string &args) final
 
template<class T >
void setParameters (const T &args)
 
template<class T >
void setParameter (const std::string &key, const T &value)
 Set a value to a single parameter.
 
bool hasParameters () const
 
virtual void run (const std::string &params="") final
 Description of result, comparable to a return type of a function. ?
 
virtual void update ()
 Optional method for preparing command to execution.
 
CommandaddSection (int i)
 
const std::string & getLastParameters () const
 
virtual void getRelatedCommands (std::ostream &ostr=std::cout) const
 
void linkRelated (const std::string &cmdKey) const
 Add related command(s), to appear in help after "See-also:" phrase.
 
virtual void parametersToStream (std::ostream &ostr, const std::string &indent=" ") const
 By default, the "true", technical parameters.
 
virtual void parameterKeysToStream (std::ostream &ostr) const
 
void parameterKeysToStream (std::ostream &ostr, const std::list< std::string > &list, char sep=',') const
 
- Public Member Functions inherited from Contextual
 Contextual ()
 Sets internal contextPtr to NULL.
 
 Contextual (const Contextual &src)
 Copies base context (even null) of the source. Notice that the actual instance may be of derived class.
 
 Contextual (Context &ctx)
 Copies internal contextPtr.
 
template<class C >
void setContext ()
 Sets internal contextPtr to the static source.
 
void setExternalContext (Context &ctx)
 Sets internal contextPtr to outside target.
 
bool contextIsSet () const
 True, if contextPtr has been set.
 
template<class T = Context>
T & getContext () const
 If context has been set, returns it through a cast to base class Context.
 

Protected Attributes

std::string filename
 
- Protected Attributes inherited from CmdPolarBase
drain::SteppedRange< double > radiusMetres = {0.0, 0.0, 0.0}
 
drain::SteppedRange< double > azimuthDegrees = {0.0, 0.0, 0.0}
 
bool MASK = false
 
- Protected Attributes inherited from Command
std::set< std::string > relatedCommands
 
std::string lastParameters
 
- Protected Attributes inherited from Contextual
ContextcontextPtr
 

Additional Inherited Members

- Public Types inherited from Graphic
enum  GRAPHIC {
  VECTOR_OVERLAY , HIGHLIGHT , GRID , DOT ,
  RAY , SECTOR , ANNULUS , CIRCLE ,
  RECTANGLE , SPOT , LABEL
}
 
- Public Types inherited from BeanCommand< BeanLike >
typedef BeanLike bean_t
 
- Public Types inherited from Command
typedef int cmd_section_type
 
- Static Public Member Functions inherited from CmdPolarBase
static drain::image::TreeSVG & getOverlayGroup (RackContext &ctx, RadarSVG &radarSVG)
 
static double ensureMetricRange (double maxRange, double range=1.0)
 
static void resolveDistance (const drain::SteppedRange< double > &ownDist, const drain::SteppedRange< double > &sharedDist, drain::SteppedRange< double > &dist, double maxDistance=0.0)
 Given a distance or a distance range, ensure metric (if relative) and also validate generally.
 
static void resolveAzimuthRange (const drain::SteppedRange< double > &ownAzm, const drain::SteppedRange< double > &sharedAzm, drain::SteppedRange< double > &azm)
 
static void addGeoData (const drain::image::Image &imageData, drain::image::NodeSVG &node)
 Add EPGS, bounding box, encoding, quantity.
 
- Static Public Member Functions inherited from Graphic
static drain::image::TreeSVG & getGraphicStyle (drain::image::TreeSVG &svgDoc)
 
- Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > & getCloner ()
 
- Public Attributes inherited from Graphic
const drain::ClassXML cls
 
- Public Attributes inherited from BeanCommand< BeanLike >
BeanLike bean
 
- Public Attributes inherited from Command
cmd_section_type section = 1
 
- Static Public Attributes inherited from CmdPolarBase
static const std::string DATA_ID = "data-latest"
 
- Static Public Attributes inherited from Command
static const SprinterLayout cmdArgLayout = {",", "?", "=", ""}
 
- Protected Member Functions inherited from BeanCommand< BeanLike >
virtual drain::ReferenceMapgetParameters () final
 

Member Function Documentation

◆ exec()

void exec ( ) const
overridevirtual

Run the command with current parameter values.

Ensure the script is available.

Add listeners upon document loading

Reimplemented from Command.


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