torc::common::DeviceFamilyHelper Class Reference

Helper class to initialize device map and list information. More...

Protected Types
typedef std::string	string
	Imported name. More...

Protected Member Functions
	DeviceFamilyHelper (DeviceNameMap &inDeviceMap, DeviceVector &inDeviceVector, DeviceVector &inCombinedDeviceVector)
	Protected constructor. More...
DeviceFamilyHelper &	operator<< (const string &rhs)
	Convenience operator to retain the last device name inserted. More...
DeviceFamilyHelper &	operator<< (enum EDevice rhs)
	Operator to propagate an enumeration and the previously inserted device name to the device map and lists. More...

Protected Attributes
DeviceNameMap &	mDeviceMap
	The map from device name to device enumeration. More...
DeviceVector &	mDeviceVector
	The list of devices for a particular family. More...
DeviceVector &	mCombinedDeviceVector
	The list of devices for all families. More...

Static Protected Attributes
static string	sDevice
	Convenience storage for the last inserted device name. More...

Friends
class	Devices
	Only the Devices class has access to our internals. More...

Detailed Description

Helper class to initialize device map and list information.

Definition at line 48 of file Devices.cpp.

Member Typedef Documentation

typedef std::string torc::common::DeviceFamilyHelper::string

protected

Imported name.

Definition at line 55 of file Devices.cpp.

Constructor & Destructor Documentation

torc::common::DeviceFamilyHelper::DeviceFamilyHelper ( DeviceNameMap &  inDeviceMap, DeviceVector &  inDeviceVector, DeviceVector &  inCombinedDeviceVector  )

inlineprotected

Protected constructor.

Definition at line 67 of file Devices.cpp.

                                                  : mDeviceMap(inDeviceMap), 
            mDeviceVector(inDeviceVector), mCombinedDeviceVector(inCombinedDeviceVector) {}

Member Function Documentation

DeviceFamilyHelper& torc::common::DeviceFamilyHelper::operator<< ( const string &  rhs )

inlineprotected

Convenience operator to retain the last device name inserted.

Definition at line 72 of file Devices.cpp.

{ sDevice = rhs; return *this; }

DeviceFamilyHelper& torc::common::DeviceFamilyHelper::operator<< ( enum EDevice  rhs )

inlineprotected

Operator to propagate an enumeration and the previously inserted device name to the device map and lists.

Definition at line 75 of file Devices.cpp.

                                                          {
            mDeviceMap[sDevice] = rhs;
            mDeviceVector.push_back(sDevice);
            mCombinedDeviceVector[rhs] = sDevice;
            return *this;
        }

Friends And Related Function Documentation

friend class Devices

friend

Only the Devices class has access to our internals.

Definition at line 52 of file Devices.cpp.

Field Documentation

DeviceVector& torc::common::DeviceFamilyHelper::mCombinedDeviceVector

protected

The list of devices for all families.

Definition at line 62 of file Devices.cpp.

DeviceNameMap& torc::common::DeviceFamilyHelper::mDeviceMap

protected

The map from device name to device enumeration.

Definition at line 58 of file Devices.cpp.

DeviceVector& torc::common::DeviceFamilyHelper::mDeviceVector

protected

The list of devices for a particular family.

Definition at line 60 of file Devices.cpp.

std::string torc::common::DeviceFamilyHelper::sDevice

staticprotected

Convenience storage for the last inserted device name.

Definition at line 64 of file Devices.cpp.

---

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

• Devices.cpp