Component The Component class represents a generic component. #include <Component.h> Inheritance diagram for Component: void clearFlag (byte flag) Clears a specific flag for the component. Component () Default constructor for the Component class. Component (String _name) Constructor for the Component class with a specified name. Component (String _name, short _id) Constructor for the Component class with a specified name and ID. Component (String _name, short _id, int _flags) Constructor for the Component class with a specified name, ID, and flags. Component (String _name, short _id, int _flags, Component *_owner) Constructor for the Component class with a specified name, ID, flags, and owner. virtual short debug () Virtual function to debug the component. virtual short debug (short val0, short val1) Virtual function to debug the component. virtual short destroy () Virtual function to destroy the component. void disable () Disables the component. void enable () Enables the component. bool enabled () Checks if the component is enabled. bool hasFlag (byte flag) Checks if the component has a specific flag. virtual short info () Virtual function to display information about the component. virtual short info (short val0, short val1) Virtual function to display information about the component. virtual short loop () Virtual function to run the component in a loop. virtual short onError (short id, short error) virtual short onMessage (int id, E_CALLS verb, E_MessageFlags flags, const void *user, Component *src) Handles incoming messages. virtual short onRawResponse (short size, uint8_t rxBuffer[]) virtual short onRegisterMethods (Bridge *bridge) virtual short onResponse (short error) void setFlag (byte flag) Sets a specific flag for the component. virtual short setup () Virtual function to set up the component. ~Component () Destructor for the Component class. Public Member Functions inherited from ModbusGateway short getAddress () MB_FC getFunctionCode () short getNumberAddresses () virtual String getRegisterDescription (short flags=0) const char * getRegisterMode () ModbusGateway () ModbusGateway (short _addr) ModbusGateway (short _addr, short _fc) void setAddress (short _addr) void setFunctionCode (MB_FC fc) void setGateway (Mudbus *mudbus) void setNumberAddresses (short _nbAddr) void setRegisterMode (MB_REGISTER_MODE mode) int flags The run flags for the component. const short id The ID of the component. millis_t last The last tick time in milliseconds. String name The name of the component. int nFlags The network capabilities of the component. millis_t now The current time in milliseconds. Component * owner The owner of the component. Public Attributes inherited from ModbusGateway short addr MB_FC fn uchar lastMQSlot Mudbus * mudbus short nbAddr short registerMode static const int COMPONENT_DEFAULT = 1 << OBJECT_RUN_FLAGS::E_OF_LOOP | 1 << OBJECT_RUN_FLAGS::E_OF_SETUP The default run flags for a component. static const int COMPONENT_NO_ID = 0 The default ID for a component.

The Component class represents a generic component. Definition at line 20 of file Component.h.

ComponentComponent ComponentComponent Component::Component ( )[inline] Default constructor for the Component class. Definition at line 36 of file Component.h. 00036 : name("NO_NAME"), id(0), 00037 flags(OBJECT_RUN_FLAGS::E_OF_NONE), 00038 nFlags(OBJECT_NET_CAPS::E_NCAPS_NONE) {}

ComponentComponent ComponentComponent Component::Component (String _name)[inline] Constructor for the Component class with a specified name. _name The name of the component. Definition at line 44 of file Component.h. 00044 : name(_name), id(COMPONENT_NO_ID), 00045 flags(OBJECT_RUN_FLAGS::E_OF_NONE), 00046 nFlags(OBJECT_NET_CAPS::E_NCAPS_NONE) {}

ComponentComponent ComponentComponent Component::Component (String _name, short _id)[inline] Constructor for the Component class with a specified name and ID. _name The name of the component. _id The ID of the component. Definition at line 53 of file Component.h. 00053 : name(_name), 00054 id(_id), 00055 flags(OBJECT_RUN_FLAGS::E_OF_NONE), 00056 nFlags(OBJECT_NET_CAPS::E_NCAPS_NONE) {}

ComponentComponent ComponentComponent Component::Component (String _name, short _id, int _flags)[inline] Constructor for the Component class with a specified name, ID, and flags. _name The name of the component. _id The ID of the component. _flags The run flags for the component. Definition at line 64 of file Component.h. 00064 : name(_name), 00065 id(_id), 00066 flags(_flags), 00067 nFlags(OBJECT_NET_CAPS::E_NCAPS_NONE)␍ 00068 { 00069 }

ComponentComponent ComponentComponent Component::Component (String _name, short _id, int _flags, Component * _owner)[inline] Constructor for the Component class with a specified name, ID, flags, and owner. _name The name of the component. _id The ID of the component. _flags The run flags for the component. _owner The owner of the component. Definition at line 78 of file Component.h. 00078 : name(_name), 00079 id(_id), 00080 flags(_flags), 00081 owner(_owner), 00082 nFlags(OBJECT_NET_CAPS::E_NCAPS_NONE) {}

~ComponentComponent Component~Component Component::~Component ( )[inline] Destructor for the Component class. Definition at line 87 of file Component.h. 00087 {}

clearFlagComponent ComponentclearFlag void Component::clearFlag (byte flag)[inline] Clears a specific flag for the component. flag The flag to clear. Definition at line 158 of file Component.h. 00159 { 00160 CBI(flags, flag); 00161 }

debugComponent Componentdebug virtual short Component::debug ( )[inline], [virtual] Virtual function to debug the component. stream The stream to output the debug information to. The error code indicating the success or failure of the operation. Reimplemented in Pos3Analog, MotorLoad, POT, Relay, StatusLight, StepperController, ModbusBridge, OmronPID, OmronVFD, H7TC, PID, App, Bridge, and SerialMessage. Definition at line 100 of file Component.h. 00100 { return E_OK; }

debugComponent Componentdebug virtual short Component::debug (short val0, short val1)[inline], [virtual] Virtual function to debug the component. stream The stream to output the debug information to. The error code indicating the success or failure of the operation. Definition at line 107 of file Component.h. 00107 { return E_OK; }

destroyComponent Componentdestroy virtual short Component::destroy ( )[inline], [virtual] Virtual function to destroy the component. The error code indicating the success or failure of the operation. Definition at line 93 of file Component.h. 00093 { return E_OK; }

disableComponent Componentdisable void Component::disable ( )[inline] Disables the component. Definition at line 174 of file Component.h. 00175 { 00176 setFlag(OBJECT_RUN_FLAGS::E_OF_DISABLED); 00177 }

enableComponent Componentenable void Component::enable ( )[inline] Enables the component. Definition at line 166 of file Component.h. 00167 { 00168 clearFlag(OBJECT_RUN_FLAGS::E_OF_DISABLED); 00169 }

enabledComponent Componentenabled bool Component::enabled ( )[inline] Checks if the component is enabled. True if the component is enabled, false otherwise. Definition at line 183 of file Component.h. 00184 { 00185 return !hasFlag(OBJECT_RUN_FLAGS::E_OF_DISABLED); 00186 }

hasFlagComponent ComponenthasFlag bool Component::hasFlag (byte flag)[inline] Checks if the component has a specific flag. flag The flag to check. True if the component has the flag, false otherwise. Definition at line 140 of file Component.h. 00141 { 00142 return TEST(flags, flag); 00143 }

infoComponent Componentinfo virtual short Component::info ( )[inline], [virtual] Virtual function to display information about the component. stream The stream to output the information to. The error code indicating the success or failure of the operation. Reimplemented in MotorLoad, StatusLight, StepperController, ModbusBridge, OmronPID, OmronVFD, H7TC, and App. Definition at line 114 of file Component.h. 00114 { return E_OK; }

infoComponent Componentinfo virtual short Component::info (short val0, short val1)[inline], [virtual] Virtual function to display information about the component. stream The stream to output the information to. The error code indicating the success or failure of the operation. Reimplemented in Pos3Analog, POT, and Relay. Definition at line 121 of file Component.h. 00121 { return E_OK; }

loopComponent Componentloop virtual short Component::loop ( )[inline], [virtual] Virtual function to run the component in a loop. The error code indicating the success or failure of the operation. Reimplemented in Pos3Analog, MotorLoad, POT, Relay, StatusLight, StepperController, ModbusBridge, OmronPID, OmronVFD, PHApp, H7TC, TC, App, and SerialMessage. Definition at line 133 of file Component.h. 00133 { return E_OK; }

onErrorComponent ComponentonError virtual short Component::onError (short id, short error)[inline], [virtual] Reimplemented in PHApp. Definition at line 246 of file Component.h. 00246 { return E_OK; }

onMessageComponent ComponentonMessage virtual short Component::onMessage (int id, E_CALLS verb, E_MessageFlags flags, const void * user, Component * src)[inline], [virtual] Handles incoming messages. This function is called when a message is received by the component. It processes the message and returns a short value indicating the status of the operation. id The ID of the message. verb The type of operation to be performed. flags The flags associated with the message. user A pointer to user-defined data. src The source component that sent the message. A short value indicating the status of the operation. Reimplemented in Bridge. Definition at line 241 of file Component.h. 00242 { 00243 return E_OK; 00244 }

onRawResponseComponent ComponentonRawResponse virtual short Component::onRawResponse (short size, uint8_t rxBuffer[])[inline], [virtual] Reimplemented in OmronPID, and OmronVFD. Definition at line 248 of file Component.h. 00248 { return E_OK; }

onRegisterMethodsComponent ComponentonRegisterMethods short Component::onRegisterMethods (Bridge * bridge)[virtual] Registers methods for the component with the specified bridge. This method should be overridden by derived classes to provide custom method registration logic. bridge The bridge to register methods with. The status code indicating the success or failure of the method registration. Reimplemented in Pos3Analog, POT, Relay, StatusLight, StepperController, OmronPID, OmronVFD, and PHApp. Definition at line 4 of file Component.cpp. 00005 { 00006 return E_OK; 00007 }

onResponseComponent ComponentonResponse virtual short Component::onResponse (short error)[inline], [virtual] Reimplemented in OmronPID, and OmronVFD. Definition at line 247 of file Component.h. 00247 { return E_OK; }

setFlagComponent ComponentsetFlag void Component::setFlag (byte flag)[inline] Sets a specific flag for the component. flag The flag to set. Definition at line 149 of file Component.h. 00150 { 00151 SBI(flags, flag); 00152 }

setupComponent Componentsetup virtual short Component::setup ( )[inline], [virtual] Virtual function to set up the component. The error code indicating the success or failure of the operation. Reimplemented in Pos3Analog, MotorLoad, POT, Relay, StatusLight, StepperController, ModbusBridge, OmronPID, OmronVFD, PHApp, H7TC, TC, App, Bridge, and SerialMessage. Definition at line 127 of file Component.h. 00127 { return E_OK; }

COMPONENT_DEFAULTComponent ComponentCOMPONENT_DEFAULT const int Component::COMPONENT_DEFAULT = 1 << OBJECT_RUN_FLAGS::E_OF_LOOP | 1 << OBJECT_RUN_FLAGS::E_OF_SETUP[static] The default run flags for a component. Definition at line 26 of file Component.h.

COMPONENT_NO_IDComponent ComponentCOMPONENT_NO_ID const int Component::COMPONENT_NO_ID = 0[static] The default ID for a component. Definition at line 31 of file Component.h.

flagsComponent Componentflags int Component::flags The run flags for the component. Definition at line 201 of file Component.h.

idComponent Componentid const short Component::id The ID of the component. Definition at line 196 of file Component.h.

lastComponent Componentlast millis_t Component::last The last tick time in milliseconds. Definition at line 221 of file Component.h.

nameComponent Componentname String Component::name The name of the component. Definition at line 191 of file Component.h.

nFlagsComponent ComponentnFlags int Component::nFlags The network capabilities of the component. Definition at line 206 of file Component.h.

nowComponent Componentnow millis_t Component::now The current time in milliseconds. Definition at line 216 of file Component.h.

ownerComponent Componentowner Component* Component::owner The owner of the component. Definition at line 211 of file Component.h.

The documentation for this class was generated from the following files: Component.hComponent.cpp