File size: 2,506 Bytes
68ce2fc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab:

inline-header {
#include <cisstMultiTask/mtsGenericObject.h>
// Always include last
#include <cisstParameterTypes/prmExport.h>
}

class {
    name prmOperatingState;
    attribute CISST_EXPORT;

    base-class {
        type mtsGenericObject;
        is-data true;
    }

    enum {
        name StateType;
        enum-value {
            name UNDEFINED;
            description undefined;
        }
        enum-value {
            name DISABLED;
            description disabled;
        }
        enum-value {
            name ENABLED;
            description enabled;
        }
        enum-value {
            name PAUSED;
            description paused;
        }
        enum-value {
            name FAULT;
            description fault;
        }
    }

    enum {
        name CommandType;
        enum-value {
            name enable;
        }
        enum-value {
            name disable;
        }
        enum-value {
            name pause;
        }
        enum-value {
            name resume;
        }
        enum-value {
            name home;
        }
        enum-value {
            name unhome;
        }
    }

    member {
        name State;
        type prmOperatingState::StateType;
        default prmOperatingState::UNDEFINED;
        description Operating state, standard states include DISABLED, ENABLED, PAUSED and FAULT;
    }

    member {
        name SubState;
        type std::string;
        description Sub state, application dependent;
    }

    member {
        name IsHomed;
        type bool;
    }

    member {
        name IsBusy;
        type bool;
    }

    inline-header {
    private:
        CMN_DECLARE_SERVICES(CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);
    public:
        inline bool IsEnabledHomedAndNotBusy(void) const {
            return ((State() == prmOperatingState::ENABLED)
                    && IsHomed() && !IsBusy());
        }
        inline bool IsEnabledAndHomed(void) const {
            return ((State() == prmOperatingState::ENABLED)
                    && IsHomed());
        }
        virtual bool ValidCommand(const CommandType & command,
                                  StateType & newOperatingState,
                                  std::string & humanReadableMessage);
    }
}

inline-header {
CMN_DECLARE_SERVICES_INSTANTIATION(prmOperatingState);
}