Inheritance diagram for MCPControl:
Please read the documentation for Capabilities for other important functions. Data structures will be placed behind accessor functions in the future.
Definition at line 73 of file MCPControl.H.
Public Member Functions | |
| MCPControl (const std::string &streamname) | |
| Standard constructor. | |
| MCPControl (const ConnectionStrategy &strategy, const std::string &gblName) | |
| Auto-wiring constructor. | |
| MCPControl (const std::string &streamname, const std::string &gblName) | |
| Like the standard constructor, but explicitly sets the global name. | |
| ~MCPControl () | |
| 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. | |
| MCPControlDataStruct | getNextData () |
| Returns a struct containing the next event in the queue. | |
| MCPControlInfoStruct | getNextInfo () |
| Returns a struct containing the next event in the queue. | |
| MCPControlInfoStruct | 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 | |
| MCPControlDataStruct | data |
| The data structure. | |
| MCPControlInfoStruct | info |
| Information-- read if consumer, write if supplier. | |
| MCPControlInfoStruct | requests |
| Requests-- read if supplier, write if consumer. | |
Protected Attributes | |
| COMObject< MCPControlInfoStruct, MCPControlDataStruct > * | myCOMObject |
| bool | m_queue |
| bool | m_initialize |
| std::queue< MCPControlDataStruct > | m_dataVector |
| std::queue< MCPControlInfoStruct > | m_infoVector |
| std::queue< MCPControlInfoStruct > | m_requestVector |
| MCPControl | ( | 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 MCPControl.cpp.
References MCPControl::init(), Capability::m_haveGlobalname, and WURDE::STRAT_NORMAL.
| MCPControl | ( | 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 MCPControl.cpp.
References MCPControl::init(), Capability::m_haveGlobalname, Capability::m_haveStream, and WURDE::STRAT_NORMAL.
| MCPControl | ( | 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 MCPControl.cpp.
References MCPControl::init(), and WURDE::STRAT_NORMAL.
| ~MCPControl | ( | ) |
Definition at line 102 of file MCPControl.cpp.
References MCPControl::myCOMObject, and Capability::myManager.
| void init | ( | const std::string & | streamname, | |
| const ConnectionStrategy & | strategy, | |||
| const std::string & | gblName | |||
| ) |
Initialization function, used by above.
Definition at line 62 of file MCPControl.cpp.
References MCPControl::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, MCPControl::m_initialize, MCPControl::m_queue, Capability::m_sourceModule, Capability::m_strategy, Capability::m_streamname, Capability::m_streamRequest, Capability::m_supplier, MCPControl::myCOMObject, Time::now(), MCPControl::requests, MCPControlInfoStruct::source, WURDE::STAT_NULL, MCPControlInfoStruct::target, and MCPControlInfoStruct::timestamp.
Referenced by MCPControl::MCPControl().
| void runUpdate | ( | ) | [virtual] |
Does all necessary work to update the data/info provided by the object.
Implements Capability.
Definition at line 195 of file MCPControl.cpp.
References Capability::m_doPublishData, Capability::m_doPublishInfo, and MCPControl::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 206 of file MCPControl.cpp.
References MCPControl::myCOMObject, and Capability::myManager.
| void setCOMObject | ( | COMBase * | object | ) | [inline, virtual] |
Returns the ID number of the instantiated interface.
Implements Capability.
Definition at line 125 of file MCPControl.H.
References MCPControl::myCOMObject.
| void disconnect | ( | ) | [inline, virtual] |
Does all necessary work to clean up the object's connection.
Implements Capability.
Definition at line 126 of file MCPControl.H.
References MCPControl::myCOMObject.
| void activateSupplier | ( | ) | [virtual] |
Sets up the object as a supplier of data.
Implements Capability.
Definition at line 111 of file MCPControl.cpp.
References MCPControl::data, WURDE::g_fatal(), MCPControl::info, MCPControl::m_dataVector, Capability::m_doAutoPing, Capability::m_globalname, Capability::m_haveGlobalname, Capability::m_haveStream, MCPControl::m_infoVector, MCPControl::m_initialize, MCPControl::m_queue, MCPControl::m_requestVector, Capability::m_streamname, Capability::m_supplier, MCPControl::myCOMObject, MCPControl::requests, MCPControlInfoStruct::source, and MCPControlDataStruct::source.
Referenced by MCPControl::setStreamName().
| void activateConsumer | ( | ) | [virtual] |
Sets up the object as a consumer of data.
Implements Capability.
Definition at line 152 of file MCPControl.cpp.
References MCPControl::data, WURDE::g_fatal(), CommsManager::getName(), MCPControl::info, MCPControl::m_dataVector, Capability::m_doAutoPing, Capability::m_globalname, Capability::m_haveGlobalname, Capability::m_haveStream, MCPControl::m_infoVector, MCPControl::m_initialize, MCPControl::m_queue, MCPControl::m_requestVector, Capability::m_strategy, Capability::m_streamname, Capability::m_supplier, MCPCONTROL, MCPControl::myCOMObject, Capability::myManager, MCPControl::requests, MCPControlDataStruct::source, MCPControlInfoStruct::source, and WURDE::STRAT_NORMAL.
Referenced by MCPControl::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 129 of file MCPControl.H.
References MCPCONTROL.
| void setStreamName | ( | const std::string & | name | ) | [virtual] |
Sets the name of the stream we're using.
Implements Capability.
Definition at line 417 of file MCPControl.cpp.
References MCPControl::activateConsumer(), MCPControl::activateSupplier(), Capability::m_globalname, Capability::m_haveStream, MCPControl::m_initialize, Capability::m_streamname, Capability::m_streamRequest, Capability::m_supplier, MCPControl::myCOMObject, and WURDE::STAT_OKAY.
| void setGlobalName | ( | const std::string & | name | ) | [virtual] |
Sets the global name of this object.
Implements Capability.
Definition at line 445 of file MCPControl.cpp.
References Capability::m_globalname, Capability::m_haveGlobalname, Capability::m_streamname, Capability::m_supplier, and MCPControl::myCOMObject.
| bool newData | ( | ) | [virtual] |
True if there is new data.
Implements Capability.
Definition at line 238 of file MCPControl.cpp.
References MCPControl::m_dataVector, MCPControl::m_queue, and MCPControl::myCOMObject.
Referenced by main().
| bool newInfo | ( | ) | [virtual] |
True if there is new info/requests (depending on supplier/consumer mode).
Implements Capability.
Definition at line 250 of file MCPControl.cpp.
References MCPControl::m_infoVector, MCPControl::m_queue, MCPControl::m_requestVector, Capability::m_supplier, and MCPControl::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 468 of file MCPControl.cpp.
References Capability::m_doAutoPing, and MCPControl::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 462 of file MCPControl.cpp.
References MCPControl::myCOMObject.
| bool getQueueMode | ( | ) | [inline] |
True if events are being queued, otherwise false.
Definition at line 141 of file MCPControl.H.
References MCPControl::m_queue.
| void setQueueMode | ( | const bool & | val | ) |
Turn queue mode on or off.
Definition at line 214 of file MCPControl.cpp.
References MCPControl::m_dataVector, MCPControl::m_infoVector, MCPControl::m_queue, MCPControl::m_requestVector, and MCPControl::myCOMObject.
| MCPControlDataStruct 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 346 of file MCPControl.cpp.
References MCPControl::data, MCPControl::m_dataVector, MCPControl::m_queue, MCPControl::myCOMObject, MCPControlDataStruct::source, MCPControlDataStruct::state, MCPControlDataStruct::target, and MCPControlDataStruct::timestamp.
| MCPControlInfoStruct 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 370 of file MCPControl.cpp.
References MCPControl::info, MCPControl::m_infoVector, MCPControl::m_queue, MCPControl::m_requestVector, Capability::m_supplier, MCPControlInfoStruct::mType, MCPControl::myCOMObject, MCPControl::requests, MCPControlInfoStruct::source, MCPControlInfoStruct::target, and MCPControlInfoStruct::timestamp.
Referenced by MCPControl::getNextRequest().
| MCPControlInfoStruct getNextRequest | ( | ) | [inline] |
Convenience function, calls getNextInfo().
Definition at line 163 of file MCPControl.H.
References MCPControl::getNextInfo().
| void publishData | ( | ) | [virtual] |
Informs the object to publish data on the next update.
Implements Capability.
Definition at line 267 of file MCPControl.cpp.
References MCPControl::data, MCPControl::m_dataVector, Capability::m_doPublishData, Capability::m_doTag, Capability::m_doTimestamp, Capability::m_globalname, MCPControl::m_queue, Capability::m_supplier, Time::now(), MCPControlDataStruct::source, MCPControlDataStruct::state, MCPControlDataStruct::target, and MCPControlDataStruct::timestamp.
Referenced by main().
| void publishInfo | ( | ) | [virtual] |
Informs the object to publish info on the next update.
Implements Capability.
Definition at line 289 of file MCPControl.cpp.
References MCPControl::info, Capability::m_doPublishInfo, Capability::m_doTag, Capability::m_doTimestamp, Capability::m_globalname, MCPControl::m_infoVector, MCPControl::m_queue, MCPControl::m_requestVector, Capability::m_streamname, Capability::m_supplier, WURDE::MESSAGE_INFO, WURDE::MESSAGE_REQUEST, MCPControlInfoStruct::mType, Time::now(), MCPControl::requests, MCPControlInfoStruct::source, MCPControlInfoStruct::target, and MCPControlInfoStruct::timestamp.
The data structure.
Read from this if you're a consumer, write to it if you're a supplier.
Definition at line 110 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::getNextData(), main(), and MCPControl::publishData().
Information-- read if consumer, write if supplier.
Definition at line 115 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::getNextInfo(), MCPControl::init(), and MCPControl::publishInfo().
Requests-- read if supplier, write if consumer.
Definition at line 120 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::getNextInfo(), MCPControl::init(), and MCPControl::publishInfo().
COMObject<MCPControlInfoStruct, MCPControlDataStruct>* myCOMObject [protected] |
Definition at line 170 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::disconnect(), MCPControl::doPing(), MCPControl::getNextData(), MCPControl::getNextInfo(), MCPControl::init(), MCPControl::newData(), MCPControl::newInfo(), MCPControl::runUpdate(), MCPControl::setAutoPing(), MCPControl::setCOMObject(), MCPControl::setGlobalName(), MCPControl::setManager(), MCPControl::setQueueMode(), MCPControl::setStreamName(), and MCPControl::~MCPControl().
bool m_queue [protected] |
Definition at line 172 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::getNextData(), MCPControl::getNextInfo(), MCPControl::getQueueMode(), MCPControl::init(), MCPControl::newData(), MCPControl::newInfo(), MCPControl::publishData(), MCPControl::publishInfo(), and MCPControl::setQueueMode().
bool m_initialize [protected] |
Definition at line 175 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::init(), and MCPControl::setStreamName().
std::queue<MCPControlDataStruct> m_dataVector [protected] |
Definition at line 176 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::getNextData(), MCPControl::newData(), MCPControl::publishData(), and MCPControl::setQueueMode().
std::queue<MCPControlInfoStruct> m_infoVector [protected] |
Definition at line 177 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::getNextInfo(), MCPControl::newInfo(), MCPControl::publishInfo(), and MCPControl::setQueueMode().
std::queue<MCPControlInfoStruct> m_requestVector [protected] |
Definition at line 178 of file MCPControl.H.
Referenced by MCPControl::activateConsumer(), MCPControl::activateSupplier(), MCPControl::getNextInfo(), MCPControl::newInfo(), MCPControl::publishInfo(), and MCPControl::setQueueMode().
1.5.1