GmiServer.h

Go to the documentation of this file.

#pragma once
#include <gii/gen/InformationServer.h>
#include <gii/gen/ResultData.h>
#include <gii/gen/Variable.h>
#include <gmi/iface/GmiInterface.h>
#include <gmi/iface/global.h>
#include <misc/gen/PropertySheetDialog.h>
 
namespace sf
{
class _GMI_CLASS TMotionServer
{
  public:
    explicit TMotionServer(gmi::Controller* controller, int device_nr = -1, const char* dev_name = nullptr);
    ~TMotionServer();
    void AddPropertyPages(PropertySheetDialog* sheet);
    const Variable& GetVariable(int pid);
    bool IsLocked() const
    {
      return FLock;
    }
    void SetLocked(bool flag);
 
  protected:
    unsigned GetAxisCount();
    std::string GetAxisName(int axis);
 
    void CreateInterface();
    void DestroyInterface();
 
    unsigned VarListFind(int id) const;
    bool CreateVariable(Variable*& var, gmi::ParamInfo& info, std::string setup);
    void DestroyVariable(Variable* var);
    std::string CreateSetupString(const gmi::ParamInfo& info, long vid);
    void EvaluateInterfaceParams();
    std::string GetNameOfs(const gmi::ParamInfo& info);
 
    unsigned ResListFind(int id) const;
 
    ResultData* CreateResultData(gmi::ResultInfo& info, std::string setup);
 
    void DestroyResultData(ResultData* var);
 
    std::string CreateSetupString(const gmi::ResultInfo& info, long vid);
 
    void EvaluateInterfaceResults();
 
    std::string GetNameOfs(const gmi::ResultInfo& info);
 
    struct ExtraInfo
    {
        unsigned Axis;
        int Id;
        std::string SetupString;
        int Flags;
    };
    ExtraInfo* Cast(Variable* var) const;
    ExtraInfo* Cast(ResultData* var) const;
    void ClearValidations();
    gmi::Controller* Controller;
    Variable VImplementation;
    // -------------------------------------------------
    // Callback hook for variable events.
    VariableLinkHandler<TMotionServer> SrvVarLink;
    // Event handler for variables.
    void ServerVarHandler(Variable::EEvent event, const Variable& caller, Variable& linker, bool sameinst);
    // Holds all created variables for the selected implementation.
    TVariable::TPtrVector VarList;
    // -------------------------------------------------
    // Callback hook for result events.
    TResultDataLinkHandler<TMotionServer> SrvResLink;
    // Event handler for results.
    void ServerResHandler(ResultData::EEvent event, const ResultData& caller, ResultData& link, const Range& rng, bool same_inst);
    // Holds all created results for this instance.
    TResultData::TPtrVector ResList;
 
    // -------------------------------------------------
    // Device number for this server.
    int DeviceNr;
    // Holds the count of this kind of interfaces.
    static unsigned ServerMap;
    // Holds the device name for creating the variable names.
    mstring DeviceName;
    // -------------------------------------------------
    // Variable indicating lock status.
    bool FLock;
    // ID of interface parameter being processed by the param hook.
    long FHandledParamId;
    // -------------------------------------------------
    // Holds the variable handler entry count.
    int VarHandlerEntryCount;
    // Holds the id for the position motion status.
    const TVariable* VMovePos;
    // Holds the id for the velocity motion status.
    const TVariable* VMoveVel;
    // -------------------------------------------------
 
    // Hook function indirectly called from the AQ implemntation.
    void ParamNotify(int id);
    void ResultNotify(int id);
    // Setst the variables to readonly based on the flags and lock status.
    void CheckReadOnly();
 
    // Hook function called directly by the implementation.
    static void ParamNotifyProc(void* data, int id);
    static void ResultNotifyProc(void* data, int id);
 
    friend class MotionVariablePropertyPage;
};
 
}// namespace sf