fesa-core  5.0.1
fesa::DeviceInstantiationData Class Reference

This class facades the class "DeviceElement" in order to provide a simple API for class-developers and to hide methods which were made for internal usage. More...

#include <DeviceInstantiationData.h>

Public Member Functions

std::vector< std::string > getConcreteEventNames (const std::string &logicalEventName) const
 returns a vector of all the concrete event-names which are linked to the given logical event More...
 
std::string getEventConfigurationName (const std::string &logicalEventName) const
 returns the event-configuration-name which is linked to the given logical event More...
 
std::map< LogicalEventName,
std::vector< ConcreteEventName > > 
getAllConcreteEventNames () const
 returns the complete event-mapping of the Device More...
 
std::map< LogicalEventName,
EventConfigurationName > 
getAllEventConfigurationNames () const
 returns all event-configurations of all logical events of the Device More...
 
std::string getDeviceName ()
 returns the name of this device, given in the instantiation-file More...
 
std::string getMainMuxCriterion ()
 returns the name of the mainMuxCriterion used by this device, given in the instantiation-file More...
 
std::string getTimingDomain ()
 returns the name of the timing domain used by this device, given in the instantiation-file More...
 
std::string getAccelerator ()
 returns the name of the accelerator used by this device, given in the instantiation-file More...
 
std::string getAcceleratorZone ()
 Get the name of the accelerator zone used by this device.
 
std::string getDescription ()
 returns the description of this device, given in the instantiation-file More...
 
std::string getSubset ()
 returns the name of the subset of this device, given in the instantiation-file More...
 

Detailed Description

This class facades the class "DeviceElement" in order to provide a simple API for class-developers and to hide methods which were made for internal usage.

Member Function Documentation

std::string fesa::DeviceInstantiationData::getAccelerator ( )

returns the name of the accelerator used by this device, given in the instantiation-file

Returns
the accelerator
std::map< DeviceInstantiationData::LogicalEventName, std::vector< DeviceInstantiationData::ConcreteEventName > > fesa::DeviceInstantiationData::getAllConcreteEventNames ( ) const

returns the complete event-mapping of the Device

Returns
a map which consists of the requested event-mapping information
std::map< DeviceInstantiationData::LogicalEventName, DeviceInstantiationData::EventConfigurationName > fesa::DeviceInstantiationData::getAllEventConfigurationNames ( ) const

returns all event-configurations of all logical events of the Device

Returns
a map which consists of the requested event-mapping information
std::vector< std::string > fesa::DeviceInstantiationData::getConcreteEventNames ( const std::string &  logicalEventName) const

returns a vector of all the concrete event-names which are linked to the given logical event

Parameters
logicalEventNamethe logical event for which the information is requested
Returns
vector of concrete event-names
std::string fesa::DeviceInstantiationData::getDescription ( )

returns the description of this device, given in the instantiation-file

Returns
the description
std::string fesa::DeviceInstantiationData::getDeviceName ( )

returns the name of this device, given in the instantiation-file

Returns
the device name
std::string fesa::DeviceInstantiationData::getEventConfigurationName ( const std::string &  logicalEventName) const

returns the event-configuration-name which is linked to the given logical event

Parameters
logicalEventNamethe logical event for which the information is requested
Returns
the name of the event configuration
std::string fesa::DeviceInstantiationData::getMainMuxCriterion ( )

returns the name of the mainMuxCriterion used by this device, given in the instantiation-file

Returns
the mainMuxCriterion
std::string fesa::DeviceInstantiationData::getSubset ( )

returns the name of the subset of this device, given in the instantiation-file

Returns
the name of the subset
std::string fesa::DeviceInstantiationData::getTimingDomain ( )

returns the name of the timing domain used by this device, given in the instantiation-file

Returns
the timing domain

The documentation for this class was generated from the following files: