This class is the head of each equipment. It is used to decouple the server and the RT package from the core package.
More...
#include <AbstractEquipment.h>
|
| static AbstractEquipment * | getInstance () |
| | Method to retrieve the singleton instance of the class This class has a particular implementation of the singleton design pattern: More...
|
| |
This class is the head of each equipment. It is used to decouple the server and the RT package from the core package.
| fesa::AbstractEquipment::AbstractEquipment |
( |
const std::string & |
equipmentName, |
|
|
ProcessType::ProcessType |
processType, |
|
|
bool |
multiProcess, |
|
|
const ProcessConfigurer & |
configurer, |
|
|
const boost::shared_ptr< Diagnostics > & |
diagnostics |
|
) |
| |
|
protected |
Constructor.
- Parameters
-
| equipmentName | name of the equipment to create |
| processType | whether this process is Server, RT, or Mixed |
| multiProcess | whether there is another FESA process for this equipment. |
| configurer | Representation of configuration infrastructure |
| diagnostics | Representation of diagnostic infrastructure |
- Exceptions
-
- Exceptions
-
| FesaException | if the process contains both server and real-time part. |
- Returns
- the current component equipment.
| std::string fesa::AbstractEquipment::getDeviceDataFileName |
( |
| ) |
const |
This method returns the path of instantiation document.
- Returns
- device instantiation file name
| const boost::shared_ptr< Diagnostics > & fesa::AbstractEquipment::getDiagnostics |
( |
| ) |
const |
Get diagnostics manager.
- Returns
- Diagnostic manager
| const std::string & fesa::AbstractEquipment::getEquipmentBuildDate |
( |
| ) |
const |
|
inline |
This method returns the deploy-unit build date.
- Returns
- a ref to the deploy-unit build date
| const std::string & fesa::AbstractEquipment::getEquipmentName |
( |
| ) |
const |
|
inline |
This method returns the equipment name of the equipment.
- Returns
- the equipment name
| const std::string & fesa::AbstractEquipment::getFesaVersion |
( |
| ) |
const |
|
inline |
This method returns the version number of the used fesa-framework.
- Returns
- a ref to the fesa-framework version
| const std::string & fesa::AbstractEquipment::getHostName |
( |
| ) |
const |
|
inline |
This method returns the host name.
- Returns
- a ref to the hostname string
Method to retrieve the singleton instance of the class This class has a particular implementation of the singleton design pattern:
- Equipment is instantiated as static object (getInstance does not provide this service)
- Dedicated shutDown to delete all the process resources properly.
- Returns
- the single instance of the Equipment
| const std::string fesa::AbstractEquipment::getNotificationFileName |
( |
| ) |
|
This method returns the path of the persistency document for a given device class.
- Parameters
-
| className | Name of the class for which I want to have the filename |
- Returns
- persistency file name
| const std::string fesa::AbstractEquipment::getPersistencyFileName |
( |
const std::string & |
className | ) |
|
This method returns the path of the persistency document for a given device class.
- Parameters
-
| className | Name of the class for which I want to have the filename |
- Returns
- persistency file name
| ProcessType::ProcessType fesa::AbstractEquipment::getProcessType |
( |
| ) |
const |
Returns the process type. Can be RT, Server, or Mixed depending on the deployment mode.
| std::string fesa::AbstractEquipment::getProcessTypeAsString |
( |
| ) |
const |
This method returns the process type of the protected equipment.
- Returns
- a ref to the process type
returns the RTComponentEquipment
- Returns
- the real time component of the equipment
returns the ServerComponentEquipment
- Returns
- the server component of the equipment
| const std::string & fesa::AbstractEquipment::getServerName |
( |
| ) |
const |
This method returns the server name.
- Returns
- server-name
| bool fesa::AbstractEquipment::getTimingSimulationMode |
( |
| ) |
const |
|
inline |
returns the enable state of the Timing Simulation
- Returns
- true, if the timing simulation is enabled
| const std::string & fesa::AbstractEquipment::getVersion |
( |
| ) |
const |
|
inline |
This method returns the version number of the equipment as string.
- Returns
- a ref to the Equipment version string
| bool fesa::AbstractEquipment::hasShutDownStarted |
( |
| ) |
const |
Returns true if the equipment is being shut down.
| bool fesa::AbstractEquipment::isClassOptional |
( |
const std::string & |
className | ) |
|
- Returns
- true if the class is optiona
| bool fesa::AbstractEquipment::isInitialized |
( |
| ) |
const |
|
inline |
- Returns
- true if the Equipment has finished the initialization phase
| bool fesa::AbstractEquipment::isMultiProcess |
( |
| ) |
const |
- Returns
- true if this equipment is comprised of multiple processes; false otherwise. Examples: -Server only: false -RealTime only: false -Server and RT, mixed: false -Server and RT, split: true
| bool fesa::AbstractEquipment::isRTRunning |
( |
| ) |
const |
- Returns
- true if the RT part of the equipment is running. Always returns true when running in mixed mode.
| void fesa::AbstractEquipment::postInit |
( |
| ) |
const |
|
protected |
Initializes all lazy-initialized members and performs various checks.
The documentation for this class was generated from the following files:
- AbstractEquipment.h
- AbstractEquipment.cpp
1.8.5