FREE::CtrlProfile::ProfileMediaMap Class Reference
[Controller profile]

Class providing the possibility to store and retrieve io definitions of a profile. More...

#include <freProfileMediaMap.h>

Inheritance diagram for FREE::CtrlProfile::ProfileMediaMap:

[legend]

Collaboration diagram for FREE::CtrlProfile::ProfileMediaMap:

[legend]

List of all members.

Public Types
typedef XMLKeyedCollectionBase < std::string, Media, MediaIdentifierBase > ::ElementsCountType	ElementsCountType
Public Member Functions
Media *	AddMedia (const std::string &sName, const std::string &sType, const DataAccessType access=DAAny, const Media::DimensionType &dim=Media::DT_AllDimensions, const unsigned int &iGroupID=1, const bool &bInternal=false)
	ProfileMediaMap ()
	ProfileMediaMap (const ProfileMediaMap &rMediaMap)
virtual	~ProfileMediaMap ()
Protected Member Functions
virtual void	SubElementLoadProcessing (const std::string &rsXMLSubTag, const std::string &rsXMLSubElement, const std::string &rsXMLSubData)

---

Detailed Description

Class providing the possibility to store and retrieve io definitions of a profile.

Definition at line 44 of file freProfileMediaMap.h.

---

Member Typedef Documentation

typedef XMLKeyedCollectionBase<std::string,Media,MediaIdentifierBase>::ElementsCountType FREE::CtrlProfile::ProfileMediaMap::ElementsCountType

Reimplemented from FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >.

Definition at line 47 of file freProfileMediaMap.h.

---

Constructor & Destructor Documentation

FREE::CtrlProfile::ProfileMediaMap::ProfileMediaMap

(

)

Definition at line 58 of file freProfileMediaMap.cxx.

References FREE::cXML_CP_MediaMap, FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::Reset(), and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileMediaMap::ProfileMediaMap

(

const ProfileMediaMap &

rMediaMap

)

Copy constructor

Definition at line 65 of file freProfileMediaMap.cxx.

References FREE::cXML_CP_MediaMap, and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileMediaMap::~ProfileMediaMap

(

)

[virtual]

Definition at line 72 of file freProfileMediaMap.cxx.

References FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::Reset().

Here is the call graph for this function:

---

Member Function Documentation

Media * FREE::CtrlProfile::ProfileMediaMap::AddMedia	(	const std::string &	sName,
		const std::string &	sType,
		const DataAccessType	access = DAAny,
		const Media::DimensionType &	dim = Media::DT_AllDimensions,
		const unsigned int &	iGroupID = 1,
		const bool &	bInternal = false
	)

Function adds a new media to the profil. If the media already exists, it will be replaced.

Parameters:

[in]	sName	ID of the media.
[in]	sType	Data type of the media (ControllerID).
[in]	access	Access type.
[in]	iGroupID	ID of the semantic group. 0: this media is optional; 1: normal required media; others are special semantic groups.
[in]	bInternal	Indicates if the media is internal (true) or not (false).

Implementation of FREE::CtrlProfile::ProfileMediaMap /////////////////

Definition at line 36 of file freProfileMediaMap.cxx.

References FREE::SmartCollectionBase< TXMLElement >::AddElement(), FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::GetElement(), and FREE::CtrlProfile::Media::New().

Here is the call graph for this function:

void FREE::CtrlProfile::ProfileMediaMap::SubElementLoadProcessing	(	const std::string &	rsXMLSubTag,
		const std::string &	rsXMLSubElement,
		const std::string &	rsXMLSubData
	)			[protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 79 of file freProfileMediaMap.cxx.

References FREE::SmartCollectionBase< TXMLElement >::AddElement(), catchAllNPassMacro, FREE::cXML_CP_Media, FREE::XMLStreamObject::cXML_Text, FREE::CtrlProfile::Media::New(), and throwExceptionMacro.

Here is the call graph for this function:

---

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

• freProfileMediaMap.h
• freProfileMediaMap.cxx

---