Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | List of all members
CmdInputFile Class Reference

Input HDF5, PNG or text file. More...

#include <fileio-read.h>

Inheritance diagram for CmdInputFile:
Inheritance graph
[legend]
Collaboration diagram for CmdInputFile:
Collaboration graph
[legend]

Public Member Functions

void exec () const
 Run the command with current parameter values.
 
void readFile (const std::string &fileName) const
 
- Public Member Functions inherited from SimpleCommand< std::string >
 SimpleCommand (const std::string &name, const std::string &description, const std::string &key="value", const std::string &initValue=std::string(), const std::string &unit="")
 Constructor.
 
 SimpleCommand (const std::string &name, const std::string &description, const std::string &key, std::initializer_list< S > l, const std::string &unit="")
 Constuctor designer for SimpleCommand<Unituple<> > .
 
 SimpleCommand (const SimpleCommand &cmd)
 Copy constructor.
 
- Public Member Functions inherited from BasicCommand
 BasicCommand (const std::string &name, const std::string &description)
 Constructor.
 
 BasicCommand (const BasicCommand &cmd)
 Copy constructor.
 
- Public Member Functions inherited from BeanCommand< BeanLike >
 BeanCommand (const std::string &name, const std::string &description)
 Constructor.
 
 BeanCommand (const BeanCommand &cmd)
 Copy constructor.
 
 BeanCommand (BeanLike &b)
 Constructor wrapping an existing bean.
 
virtual const bean_t & getBean () const
 Returns the wrapped bean.
 
virtual bean_t & getBean ()
 Returns the wrapped bean.
 
const std::string & getName () const final
 Returns the command name.
 
const std::string & getDescription () const final
 Returns the command description.
 
virtual const drain::ReferenceMap & getParameters () const
 Returns the command parameters.
 
- Public Member Functions inherited from Command
 Command (const Command &cmd)
 Copy constructor.
 
virtual void setParameters (const std::string &args) final
 
template<class T >
void setParameters (const T &args)
 Sets parameters from argument.
 
template<class T >
void setParameter (const std::string &key, const T &value)
 Set a value to a single parameter.
 
bool hasParameters () const
 Returns true if this command has parameters.
 
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.
 
Command & addSection (int i)
 Marks this command as belonging to section i.
 
const std::string & getLastParameters () const
 Returns the parameters from the last execution.
 
virtual void getRelatedCommands (std::ostream &ostr=std::cout) const
 Writes related command names to stream.
 
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
 Writes parameter keys to stream.
 
void parameterKeysToStream (std::ostream &ostr, const std::list< std::string > &list, char sep=',') const
 Writes parameter keys to stream.
 
- 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 Types

typedef std::map< std::string, ODIMPathElem > quantity_map
 

Protected Member Functions

void readFileH5 (const std::string &fullFilename, int maxTimeDiffMinutes=0) const
 Read cartesian or polar data (sweep, volume).
 
void readListFile (const drain::FilePath &path) const
 
void readTextFile (const std::string &fullFilename) const
 
void readImageFile (const std::string &fullFilename) const
 
void appendCartesianH5 (Hi5Tree &tmpSrc, Hi5Tree &dst) const
 
void attachCartesianH5 (Hi5Tree &srcRoot, Hi5Tree &dstRoot) const
 
void appendPolarH5 (Hi5Tree &tmpSrc, Hi5Tree &dst) const
 Add DATASET groups of srcRoot to dstRoot.
 
void updateData (Hi5Tree &srcData, const std::string &srcKey, Hi5Tree &dstDataSet, const quantity_map &dstQuantityElems) const
 
void updateQuality (Hi5Tree &srcData, Hi5Tree &dstData) const
 
template<class OD >
void deriveImageODIM (const drain::image::Image &srcImage, OD &odim) const
 
- Protected Member Functions inherited from BeanCommand< BeanLike >
virtual drain::ReferenceMap & getParameters () final
 

Additional Inherited Members

- Public Types inherited from BeanCommand< BeanLike >
typedef BeanLike bean_t
 The bean type.
 
- Public Types inherited from Command
typedef int cmd_section_type
 
- Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > & getCloner ()
 Returns the object cloner.
 
- Public Attributes inherited from SimpleCommand< std::string >
std::string value
 
- Public Attributes inherited from BeanCommand< BeanLike >
BeanLike bean
 The wrapped bean instance.
 
- Public Attributes inherited from Command
cmd_section_type section = 1
 Section bitmask; zero means hidden from help.
 
- Static Public Attributes inherited from Command
static const SprinterLayout cmdArgLayout = {",", "?", "=", ""}
 Layout flag for command argument handling.
 
- Protected Attributes inherited from Command
std::set< std::string > relatedCommands
 Set of related command keys shown in help.
 
std::string lastParameters
 String record of the last argument(s) passed.
 
- Protected Attributes inherited from Contextual
Context * contextPtr
 Pointer to the current context; nullptr if not set.
 

Detailed Description

Input HDF5, PNG or text file.

In Rack, this command is also the default option, hence plain argument will be treated as files to read.

See also
rack::CmdInputPrefix
rack::CmdInputSelect

Member Function Documentation

◆ appendPolarH5()

void appendPolarH5 ( Hi5Tree &  srcRoot,
Hi5Tree &  dstRoot 
) const
protected

Add DATASET groups of srcRoot to dstRoot.

Specialized to polar measurement data: time stamps identify the dataset groups. Note: also DataSelector applied.

◆ attachCartesianH5()

void attachCartesianH5 ( Hi5Tree &  srcRoot,
Hi5Tree &  dstRoot 
) const
protected

TODO: New-iter

◆ exec()

void exec ( ) const
virtual

Run the command with current parameter values.

Reimplemented from Command.

◆ readFileH5()

void readFileH5 ( const std::string &  fullFilename,
int  maxTimeDiffMinutes = 0 
) const
protected

Read cartesian or polar data (sweep, volume).

Reads hdf5 file and appends it to H5 structure. Works only with sweeps (SCAN), volume (PVOL) or Cartesian data (COMP) (having elevations).

Parameters
fullFilename- file path

◆ readImageFile()

void readImageFile ( const std::string &  fullFilename) const
protected

Search last dataset

Search new data[n] in the dataset found


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