Inheritance diagram for Power:
Please read the documentation for Capabilities for other important functions. Data structures will be placed behind accessor functions in the future.
Definition at line 75 of file Power.H.
Public Member Functions | |
| Power (const std::string &streamname) | |
| Standard constructor. | |
| Power (const ConnectionStrategy &strategy, const std::string &gblName) | |
| Auto-wiring constructor. | |
| Power (const std::string &streamname, const std::string &gblName) | |
| Like the standard constructor, but explicitly sets the global name. | |
| ~Power () | |
| void | init (const std::string &streamname, const ConnectionStrategy &strategy, const std::string &gblName) |
| Initialization function, used by above. | |
| void | runUpdate () |
| Does all necessary work to update the data/info provided by the object. | |
| void | setManager (CommsManager *myManager_) |
| Gives the object a reference to the global CORBAHelper. | |
| void | setCOMObject (COMBase *object) |
| Returns the ID number of the instantiated interface. | |
| void | disconnect () |
| Does all necessary work to clean up the object's connection. | |
| void | activateSupplier () |
| Sets up the object as a supplier of data. | |
| void | activateConsumer () |
| Sets up the object as a consumer of data. | |
| std::string | getInterfaceName () |
| Returns the name of the interface. | |
| void | setStreamName (const std::string &name) |
| Sets the name of the stream we're using. | |
| void | setGlobalName (const std::string &name) |
| Sets the global name of this object. | |
| bool | newData () |
| True if there is new data. | |
| bool | newInfo () |
| True if there is new info/requests (depending on supplier/consumer mode). | |
| void | setAutoPing (const bool &val) |
| Sets the state of the auto-ping function. | |
| void | doPing () |
| Manually tells the object to do a ping. | |
| bool | getQueueMode () |
| True if events are being queued, otherwise false. | |
| void | setQueueMode (const bool &val) |
| Turn queue mode on or off. | |
| PowerDataStruct | getNextData () |
| Returns a struct containing the next event in the queue. | |
| PowerInfoStruct | getNextInfo () |
| Returns a struct containing the next event in the queue. | |
| PowerInfoStruct | getNextRequest () |
| Convenience function, calls getNextInfo(). | |
| void | publishData () |
| Informs the object to publish data on the next update. | |
| void | publishInfo () |
| Informs the object to publish info on the next update. | |
Public Attributes | |
| PowerDataStruct | data |
| The data structure. | |
| PowerInfoStruct | info |
| Information-- read if consumer, write if supplier. | |
| PowerInfoStruct | requests |
| Requests-- read if supplier, write if consumer. | |
Protected Attributes | |
| COMObject< PowerInfoStruct, PowerDataStruct > * | myCOMObject |
| bool | m_queue |
| bool | m_initialize |
| std::queue< PowerDataStruct > | m_dataVector |
| std::queue< PowerInfoStruct > | m_infoVector |
| std::queue< PowerInfoStruct > | m_requestVector |
| Power | ( | const std::string & | streamname | ) | [explicit] |
Standard constructor.
Automatically generates a (hopefully) unique global name. If two of the same (consumer) binaries are running, it *will* fail. This is the only constructor you should use for suppliers.
Definition at line 37 of file Power.cpp.
References Power::init(), Capability::m_haveGlobalname, and WURDE::STRAT_NORMAL.
| Power | ( | const ConnectionStrategy & | strategy, | |
| const std::string & | gblName | |||
| ) |
Auto-wiring constructor.
Submits a request to MCP for a stream to connect to, based on global name. ConnectionStrategy should be auto for now.
Definition at line 44 of file Power.cpp.
References Power::init(), Capability::m_haveGlobalname, Capability::m_haveStream, and WURDE::STRAT_NORMAL.
| Power | ( | const std::string & | streamname, | |
| const std::string & | gblName | |||
| ) |
Like the standard constructor, but explicitly sets the global name.
Use this when starting multiple instances of the same binary, so that each instance can be assigned a separate name.
Definition at line 58 of file Power.cpp.
References Power::init(), and WURDE::STRAT_NORMAL.
| ~Power | ( | ) |
| void init | ( | const std::string & | streamname, | |
| const ConnectionStrategy & | strategy, | |||
| const std::string & | gblName | |||
| ) |
Initialization function, used by above.
Definition at line 62 of file Power.cpp.
References Power::info, Capability::m_doAutoPing, Capability::m_doPublishData, Capability::m_doPublishInfo, Capability::m_doTag, Capability::m_doTimestamp, Capability::m_globalname, Capability::m_haveGlobalname, Capability::m_haveStream, Power::m_initialize, Power::m_queue, Capability::m_sourceModule, Capability::m_strategy, Capability::m_streamname, Capability::m_streamRequest, Capability::m_supplier, Power::myCOMObject, Time::now(), Power::requests, PowerInfoStruct::source, WURDE::STAT_NULL, PowerInfoStruct::target, and PowerInfoStruct::timestamp.
Referenced by Power::Power().
| void runUpdate | ( | ) | [virtual] |
Does all necessary work to update the data/info provided by the object.
Implements Capability.
Definition at line 203 of file Power.cpp.
References Capability::m_doPublishData, Capability::m_doPublishInfo, and Power::myCOMObject.
| void setManager | ( | CommsManager * | myManager_ | ) | [virtual] |
Gives the object a reference to the global CORBAHelper.
This will be changed soon to be less adaptor specific.
Implements Capability.
Definition at line 214 of file Power.cpp.
References Power::myCOMObject, and Capability::myManager.
| void setCOMObject | ( | COMBase * | object | ) | [inline, virtual] |
Returns the ID number of the instantiated interface.
Implements Capability.
Definition at line 127 of file Power.H.
References Power::myCOMObject.
| void disconnect | ( | ) | [inline, virtual] |
Does all necessary work to clean up the object's connection.
Implements Capability.
Definition at line 128 of file Power.H.
References Power::myCOMObject.
| void activateSupplier | ( | ) | [virtual] |
Sets up the object as a supplier of data.
Implements Capability.
Definition at line 111 of file Power.cpp.
References PowerDataStruct::ac_online, Power::data, WURDE::g_fatal(), Power::info, Power::m_dataVector, Capability::m_doAutoPing, Capability::m_globalname, Capability::m_haveGlobalname, Capability::m_haveStream, Power::m_infoVector, Power::m_initialize, Power::m_queue, Power::m_requestVector, Capability::m_streamname, Capability::m_supplier, PowerDataStruct::max_volts, PowerDataStruct::min_volts, Power::myCOMObject, Power::requests, PowerInfoStruct::source, PowerDataStruct::source, and PowerDataStruct::volts.
Referenced by Power::setStreamName().
| void activateConsumer | ( | ) | [virtual] |
Sets up the object as a consumer of data.
Implements Capability.
Definition at line 156 of file Power.cpp.
References PowerDataStruct::ac_online, Power::data, WURDE::g_fatal(), CommsManager::getName(), Power::info, Power::m_dataVector, Capability::m_doAutoPing, Capability::m_globalname, Capability::m_haveGlobalname, Capability::m_haveStream, Power::m_infoVector, Power::m_initialize, Power::m_queue, Power::m_requestVector, Capability::m_strategy, Capability::m_streamname, Capability::m_supplier, PowerDataStruct::max_volts, PowerDataStruct::min_volts, Power::myCOMObject, Capability::myManager, POWER, Power::requests, PowerDataStruct::source, PowerInfoStruct::source, WURDE::STRAT_NORMAL, and PowerDataStruct::volts.
Referenced by Power::setStreamName().
| std::string getInterfaceName | ( | ) | [inline, virtual] |
Returns the name of the interface.
We're identifying interfaces by strings, rather than an enum, as it saves us from having to autogenerate even more code
Implements Capability.
Definition at line 131 of file Power.H.
References POWER.
| void setStreamName | ( | const std::string & | name | ) | [virtual] |
Sets the name of the stream we're using.
Implements Capability.
Definition at line 437 of file Power.cpp.
References Power::activateConsumer(), Power::activateSupplier(), Capability::m_globalname, Capability::m_haveStream, Power::m_initialize, Capability::m_streamname, Capability::m_streamRequest, Capability::m_supplier, Power::myCOMObject, and WURDE::STAT_OKAY.
| void setGlobalName | ( | const std::string & | name | ) | [virtual] |
Sets the global name of this object.
Implements Capability.
Definition at line 465 of file Power.cpp.
References Capability::m_globalname, Capability::m_haveGlobalname, Capability::m_streamname, Capability::m_supplier, and Power::myCOMObject.
| bool newData | ( | ) | [virtual] |
True if there is new data.
Implements Capability.
Definition at line 246 of file Power.cpp.
References Power::m_dataVector, Power::m_queue, and Power::myCOMObject.
| bool newInfo | ( | ) | [virtual] |
True if there is new info/requests (depending on supplier/consumer mode).
Implements Capability.
Definition at line 258 of file Power.cpp.
References Power::m_infoVector, Power::m_queue, Power::m_requestVector, Capability::m_supplier, and Power::myCOMObject.
| void setAutoPing | ( | const bool & | val | ) | [virtual] |
Sets the state of the auto-ping function.
If true, consumers will automatically send out a blank MESSAGE_PING to the stream source, and suppliers will automatically filter out these requests and send a copy of the last published info and data.
Should consumers be set up to send out this request on a regular basis?
Implements Capability.
Definition at line 488 of file Power.cpp.
References Capability::m_doAutoPing, and Power::myCOMObject.
| void doPing | ( | ) | [virtual] |
Manually tells the object to do a ping.
If a consumer, sends a ping request to its supplier, if a supplier, sends out a copy of the last published info and data messages.
Implements Capability.
Definition at line 482 of file Power.cpp.
References Power::myCOMObject.
| bool getQueueMode | ( | ) | [inline] |
True if events are being queued, otherwise false.
Definition at line 143 of file Power.H.
References Power::m_queue.
| void setQueueMode | ( | const bool & | val | ) |
Turn queue mode on or off.
Definition at line 222 of file Power.cpp.
References Power::m_dataVector, Power::m_infoVector, Power::m_queue, Power::m_requestVector, and Power::myCOMObject.
| PowerDataStruct getNextData | ( | ) |
Returns a struct containing the next event in the queue.
Also copies the contents of that event into the data struct.
Definition at line 360 of file Power.cpp.
References PowerDataStruct::ac_online, Power::data, Power::m_dataVector, Power::m_queue, PowerDataStruct::max_volts, PowerDataStruct::min_volts, Power::myCOMObject, PowerDataStruct::source, PowerDataStruct::timestamp, and PowerDataStruct::volts.
| PowerInfoStruct getNextInfo | ( | ) |
Returns a struct containing the next event in the queue.
Also copies the contents of that event into the info/requests struct.
Definition at line 390 of file Power.cpp.
References Power::info, Power::m_infoVector, Power::m_queue, Power::m_requestVector, Capability::m_supplier, PowerInfoStruct::mType, Power::myCOMObject, Power::requests, PowerInfoStruct::source, PowerInfoStruct::target, and PowerInfoStruct::timestamp.
Referenced by Power::getNextRequest().
| PowerInfoStruct getNextRequest | ( | ) | [inline] |
Convenience function, calls getNextInfo().
Definition at line 165 of file Power.H.
References Power::getNextInfo().
| void publishData | ( | ) | [virtual] |
Informs the object to publish data on the next update.
Implements Capability.
Definition at line 275 of file Power.cpp.
References PowerDataStruct::ac_online, Power::data, Power::m_dataVector, Capability::m_doPublishData, Capability::m_doTag, Capability::m_doTimestamp, Capability::m_globalname, Power::m_queue, Capability::m_supplier, PowerDataStruct::max_volts, PowerDataStruct::min_volts, Time::now(), PowerDataStruct::source, PowerDataStruct::timestamp, and PowerDataStruct::volts.
| void publishInfo | ( | ) | [virtual] |
Informs the object to publish info on the next update.
Implements Capability.
Definition at line 303 of file Power.cpp.
References Power::info, Capability::m_doPublishInfo, Capability::m_doTag, Capability::m_doTimestamp, Capability::m_globalname, Power::m_infoVector, Power::m_queue, Power::m_requestVector, Capability::m_streamname, Capability::m_supplier, WURDE::MESSAGE_INFO, WURDE::MESSAGE_REQUEST, PowerInfoStruct::mType, Time::now(), Power::requests, PowerInfoStruct::source, PowerInfoStruct::target, and PowerInfoStruct::timestamp.
The data structure.
Read from this if you're a consumer, write to it if you're a supplier.
Definition at line 112 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::getNextData(), and Power::publishData().
Information-- read if consumer, write if supplier.
Definition at line 117 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::getNextInfo(), Power::init(), and Power::publishInfo().
Requests-- read if supplier, write if consumer.
Definition at line 122 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::getNextInfo(), Power::init(), and Power::publishInfo().
COMObject<PowerInfoStruct, PowerDataStruct>* myCOMObject [protected] |
Definition at line 172 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::disconnect(), Power::doPing(), Power::getNextData(), Power::getNextInfo(), Power::init(), Power::newData(), Power::newInfo(), Power::runUpdate(), Power::setAutoPing(), Power::setCOMObject(), Power::setGlobalName(), Power::setManager(), Power::setQueueMode(), Power::setStreamName(), and Power::~Power().
bool m_queue [protected] |
Definition at line 174 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::getNextData(), Power::getNextInfo(), Power::getQueueMode(), Power::init(), Power::newData(), Power::newInfo(), Power::publishData(), Power::publishInfo(), and Power::setQueueMode().
bool m_initialize [protected] |
Definition at line 177 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::init(), and Power::setStreamName().
std::queue<PowerDataStruct> m_dataVector [protected] |
Definition at line 178 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::getNextData(), Power::newData(), Power::publishData(), and Power::setQueueMode().
std::queue<PowerInfoStruct> m_infoVector [protected] |
Definition at line 179 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::getNextInfo(), Power::newInfo(), Power::publishInfo(), and Power::setQueueMode().
std::queue<PowerInfoStruct> m_requestVector [protected] |
Definition at line 180 of file Power.H.
Referenced by Power::activateConsumer(), Power::activateSupplier(), Power::getNextInfo(), Power::newInfo(), Power::publishInfo(), and Power::setQueueMode().
1.5.1