CustomFields.h

Go to the documentation of this file.

#pragma once
 
#include "Namespace.h"
#include "gii/gen/InformationBase.h"
#include "gii/gen/Variable.h"
#include "misc/gen/Sustain.h"
 
namespace sf
{
 
class CustomFields : public VariableHandler
{
  public:
    // Constructor.
    CustomFields(TPartInspection* pi, const std::string& prefix, id_type id_offset, id_type id_range);
    // Destructor.
    ~CustomFields() override;
    // Sets the variables to be exported.
    bool SetExport(bool exported);
    // Returns true when variables are exported.
    bool IsExported() const;
    // Returns if during the last reading of values some are not filled in.
    // This is always the case with new inspection ore when a configuration has changed.
    bool IsComplete() const;
    // Set or resets the complete flag.
    void SetComplete(bool yn);
    // Returns the amount of entries
    int GetCount() const;
    // Swaps two entries.
    void Swap(int index1, int index2);
    // Adds an empty entry to the list.
    void Add();
    // Adds an entry to the list.
    void Add(const std::string& name, const std::string& setup);
    // Flushes the list.
    void Clear();
    // Returns the name of the field.
    std::string GetName(int index) const;
    // Returns the setup of the variable.
    std::string GetSetup(int index) const;
    // Functions to read the configuration from profile.
    void ReadWriteConfig(IniProfile* ini, bool rd);
    // Functions to read the configuration from the default module profile.
    void ReadWriteConfig(bool rd);
    // Write the custom values to the inspection file.
    bool ReadWriteValues(bool rd);
    // Returns the filed values to their default value.
    void SetDefaults();
    // Returns true when modified.
    bool IsDirty() const;
    // Sets or resets the dirty flag.
    void SetDirty(bool dirty);
    // Returns the configuration in strings.
    void GetStrings(KeyValues& list);
    // Sets the configuration from strings.
    void SetStrings(const KeyValues& list);
 
  protected:
    // Handler for variables
    void variableEventHandler(EEvent event, const Variable& caller, Variable& link, bool same_inst) override;
 
    // Function called be the sustain hook.
    bool Sustain(const timespec&);
 
  private:
    // Hook to the sustain interface.
    TSustain<CustomFields> FSustainEntry;
    // Holds the created variables.
    Variable::PtrVector FVars;
    // Holds the offset and range for this.
    id_type FIdOffset, FIdRange;
    // Holds the prefix name of the variables.
    std::string FNamePrefix;
    // Holds the dirty flag.
    bool FDirty;
    // Holds the export flag.
    bool FIsExported;
    // Holds the flag if there are any open not filled in fields during reading.
    bool FIsComplete;
    // Holds the flag on whether anything has changed.
    bool FChanged;
    // Holds the part inspection pointer.
    TPartInspection* FPartInspection;
};
 
inline bool CustomFields::IsDirty() const
{
  return FDirty;
}
 
inline void CustomFields::SetComplete(bool yn)
{
  FIsComplete = yn;
}
 
inline bool CustomFields::IsComplete() const
{
  return FIsComplete;
}
 
inline bool CustomFields::IsExported() const
{
  return FIsExported;
}
 
inline void CustomFields::SetDirty(bool dirty)
{
  FDirty = dirty;
}
 
inline int CustomFields::GetCount() const
{
  return FVars.count();
}
 
inline std::string CustomFields::GetName(int index) const
{
  return *(FVars[index]->getData<std::string*>());
}
 
inline std::string CustomFields::GetSetup(int index) const
{
  return FVars[index]->getSetupString();
}
 
}// namespace sf