* updated license headers

* updated documentation

1 files changed, 350 insertions, 57 deletions

diff --git a/include/audiomanagertypes.h b/include/audiomanagertypes.h
index afc5519..b16b637 100644
--- a/include/audiomanagertypes.h
+++ b/include/audiomanagertypes.h
@@ -1,10 +1,9 @@
 /** Copyright (c) 2012 GENIVI Alliance

  *  Copyright (c) 2012 BMW

  *

- *  @author Christian Mueller, BMW

+ *  \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012

  *

- *  @copyright

- *  {

+ *  \copyright

  *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction,

  *  including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,

  *  subject to the following conditions:

@@ -12,13 +11,14 @@
  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

  *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR

  *  THE USE OR OTHER DEALINGS IN THE SOFTWARE.

- *  }

+ 

+ *  For further information see http://www.genivi.org/.

  *

  * 

  * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN

  */

-#if !defined(EA_1F9A0AD1_FF28_4de6_A5C7_2F570F618734__INCLUDED_)

-#define EA_1F9A0AD1_FF28_4de6_A5C7_2F570F618734__INCLUDED_

+#if !defined(EA_FF16184D_524E_4747_8AC7_DD40DA868A0E__INCLUDED_)

+#define EA_FF16184D_524E_4747_8AC7_DD40DA868A0E__INCLUDED_

 

 #include <stdint.h>

 #include "projecttypes.h"

@@ -31,63 +31,63 @@ namespace am {
 	/**
 	 * a domain ID
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_domainID_t;
 
 	/**
 	 * a source ID
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_sourceID_t;
 
 	/**
 	 * a sink ID 
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_sinkID_t;
 
 	/**
 	 * a gateway ID
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_gatewayID_t;
 
 	/**
 	 * a crossfader ID
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_crossfaderID_t;
 
 	/**
 	 * a connection ID 
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_connectionID_t;
 
 	/**
 	 * a mainConnection ID
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_mainConnectionID_t;
 
 	/**
 	 * speed
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_speed_t;
 
 	/**
 	 * The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE). The minimum and maximum can be limited by actual project.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef int16_t am_volume_t;
 
@@ -95,40 +95,40 @@ namespace am {
 	 * This is the volume presented on the command interface. It is in the duty of the Controller to change the volumes given here into meaningful values on the routing interface.

 	 * The range of this type is customer specific.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef int16_t am_mainVolume_t;
 
 	/**
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_sourceClass_t;
 
 	/**
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_sinkClass_t;
 
 	/**
 	 * time in ms!
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef uint16_t am_time_t;
 
 	/**
 	 * offset time that is introduced in milli seconds.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	typedef int16_t am_timeSync_t;
 
 	/**
 	 * with the help of this enum, sinks and sources can report their availability state
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_Availablility_e
 	{
@@ -150,7 +150,7 @@ namespace am {
 	/**
 	 * represents the connection state
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_ConnectionState_e
 	{
@@ -180,7 +180,7 @@ namespace am {
 
 	/**
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_DomainState_e
 	{
@@ -206,7 +206,7 @@ namespace am {
 	/**
 	 * This enum characterizes the data of the EarlyData_t
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_EarlyDataType_e
 	{
@@ -236,7 +236,7 @@ namespace am {
 	/**
 	 * the errors of the audiomanager. All possible errors are in here. This enum is used widely as return parameter.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_Error_e
 	{
@@ -289,7 +289,7 @@ namespace am {
 
 	/**
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_MuteState_e
 	{
@@ -311,7 +311,7 @@ namespace am {
 	/**
 	 * The source state reflects the state of the source
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_SourceState_e
 	{
@@ -334,7 +334,7 @@ namespace am {
 	/**
 	 * This enumeration is used to define the type of the action that is correlated to a handle.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_Handle_e
 	{
@@ -354,7 +354,7 @@ namespace am {
 
 	/**
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_InterruptState_e
 	{
@@ -376,7 +376,7 @@ namespace am {
 	/**
 	 * describes the active sink of a crossfader.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:36 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	enum am_HotSink_e
 	{
@@ -402,7 +402,7 @@ namespace am {
 	/**
 	 * this describes the availability of a sink or a source together with the latest change
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	struct am_Availability_s
 	{
@@ -420,51 +420,109 @@ namespace am {
 	};
 
 	/**
+	 * describes class properties
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	struct am_ClassProperty_s
 	{
 
 	public:
+		/**
+		 * the property as enum
+		 */
 		am_ClassProperty_e classProperty;
+		/**
+		 * the value of the property
+		 */
 		int16_t value;
 
 	};
 
 	/**
+	 * This struct describes the attribiutes of a crossfader.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	struct am_Crossfader_s
 	{
 
 	public:
+		/**
+		 * This is the ID of the crossfader, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManager daemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
+		 */
 		am_crossfaderID_t crossfaderID;
+		/**
+		 * The name of the crossfader. Must be unique in the whole system. 
+		 */
 		std::string name;
+		/**
+		 * The sinkID of the SinkA. Sinks shall be registered before registering the crossfader.
+		 */
 		am_sinkID_t sinkID_A;
+		/**
+		 * The sinkID of the SinkB. Sinks shall be registered before registering the crossfader.
+		 */
 		am_sinkID_t sinkID_B;
+		/**
+		 * The sourceID of the crossfader source. The source shall be registered before the crossfader.
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * This enum can have 3 states:

+		 * 

+		 *     HS_SINKA sinkA is the current hot one, sinkB is not audible

+		 *     HS_SINKB sinkB is the current hot one, sinkB is not audible

+		 *     HS_INTERMEDIATE the fader is stuck in between a cross-fading action. This could be due to an abort or an error. Before using the crossfader, it must be set to either HS_SINKA or HS_SINKB.
+		 */
 		am_HotSink_e hotSink;
 
 	};
 
 	/**
+	 * This struct describes the attributes of a gateway.
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:04 PM
 	 */
 	struct am_Gateway_s
 	{
 
 	public:
+		/**
+		 * This is the ID of the gateway, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
+		 */
 		am_gatewayID_t gatewayID;
+		/**
+		 * The name of the gateway. Must be unique in the whole system.
+		 */
 		std::string name;
+		/**
+		 * The sinkID of the gateway sink-end. The sink is a full blown sink with connectionFormats, sinkClassIDs etc... It makes sense to register the sinks of a gateway as non-visible. Care needs to be taken that the connectionsFormats match with the ones in the conversionMatrix. If the sink is located in the controllingDomain, the ID needs to be retrieved by registering the sink before registering the gateway. In case the sink is in a different domain, the ID needs to be retrieved via peeking.
+		 */
 		am_sinkID_t sinkID;
+		/**
+		 * The sourceID of the gateway sink-end. The sink is a full blown source with connectionFormats, sinkClassIDs etc... It makes sense to register the sources of a gateway as non-visible. Care needs to be taken that the connectionsFormats match with the ones in the conversionMatrix. If the source is located in the controllingDomain, the ID needs to be retrieved by registering the source before registering the gateway. In case the source is in a different domain, the ID needs to be retrieved via peeking.
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * The ID of the sink. If the domain is the same like the controlling domain, the ID is known due to registration. If the domain is different, the ID needs to be retrieved via peeking.
+		 */
 		am_domainID_t domainSinkID;
+		/**
+		 * The ID of the source. If the domain is the same like the controlling domain, the ID is known due to registration. If the domain is different, the ID needs to be retrieved via peeking.
+		 */
 		am_domainID_t domainSourceID;
+		/**
+		 * This is the ID of the domain that registers the gateway.
+		 */
 		am_domainID_t controlDomainID;
+		/**
+		 * This is the list of available formats on the source side of the gateway. It is not defined during the gateway registration but copied from the source registration.
+		 */
 		std::vector<am_ConnectionFormat_e> listSourceFormats;
+		/**
+		 * This is the list of available formats on the sink side of the gateway. It is not defined during the gateway registration but copied from the sink registration.
+		 */
 		std::vector<am_ConnectionFormat_e> listSinkFormats;
 		/**
 		 * This is matrix holding information about the conversion capability of the gateway, it's length is defined by the length(listSinkFormats) x length(listSourceFormats).

@@ -491,49 +549,79 @@ namespace am {
 	/**
 	 * This represents one "hopp" in a route
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_RoutingElement_s
 	{
 
 	public:
+		/**
+		 * the source ID
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * the sinkID
+		 */
 		am_sinkID_t sinkID;
+		/**
+		 * the domainID the routeElement is in
+		 */
 		am_domainID_t domainID;
+		/**
+		 * the connectionformat that is used for the route
+		 */
 		am_ConnectionFormat_e connectionFormat;
 
 	};
 
 	/**
+	 * a list of routing elements that lead from source to sink
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_Route_s
 	{
 
 	public:
+		/**
+		 * the sourceID where the route starts
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * the sinkID where the route ends
+		 */
 		am_sinkID_t sinkID;
+		/**
+		 * the actual route as list of routing elements
+		 */
 		std::vector<am_RoutingElement_s> route;
 
 	};
 
 	/**
+	 * struct describing the sound property
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_SoundProperty_s
 	{
 
 	public:
+		/**
+		 * the type of the property - a project specific enum
+		 */
 		am_SoundPropertyType_e type;
+		/**
+		 * the actual value of the property
+		 */
 		int16_t value;
 
 	};
 
 	/**
+	 * struct describing system properties
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:37 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_SystemProperty_s
 	{
@@ -551,22 +639,33 @@ namespace am {
 	};
 
 	/**
+	 * struct describing sinkclasses
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:38 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_SinkClass_s
 	{
 
 	public:
+		/**
+		 * the ID of the sinkClass
+		 */
 		am_sinkClass_t sinkClassID;
+		/**
+		 * the name of the sinkClass - must be unique in the system
+		 */
 		std::string name;
+		/**
+		 * the list of the class properties. These are pairs of  a project specific enum describing the type of the value and an integer holding the real value.
+		 */
 		std::vector<am_ClassProperty_s> listClassProperties;
 
 	};
 
 	/**
+	 * struct describing source classes
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:38 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_SourceClass_s
 	{
@@ -576,7 +675,13 @@ namespace am {
 		 * the source ID
 		 */
 		am_sourceClass_t sourceClassID;
+		/**
+		 * the name of the sourceClass - must be unique in the system
+		 */
 		std::string name;
+		/**
+		 * the list of the class properties. These are pairs of  a project specific enum describing the type of the value and an integer holding the real value.
+		 */
 		std::vector<am_ClassProperty_s> listClassProperties;
 
 	};
@@ -584,15 +689,27 @@ namespace am {
 	/**
 	 * this type holds all information of sources relevant to the HMI
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:38 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_SourceType_s
 	{
 
 	public:
+		/**
+		 * This is the ID of the source, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * The name of the source. Must be unique in the whole system.
+		 */
 		std::string name;
+		/**
+		 * the availability of the source
+		 */
 		am_Availability_s availability;
+		/**
+		 * the sourceClassID, indicates the class the source is in. This information can be used by the Controller to implement different behaviour for different classes.
+		 */
 		am_sourceClass_t sourceClassID;
 
 	};
@@ -600,43 +717,75 @@ namespace am {
 	/**
 	 * this type holds all information of sinks relevant to the HMI
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:38 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_SinkType_s
 	{
 
 	public:
+		/**
+		 * This is the ID of the sink, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
+		 */
 		am_sinkID_t sinkID;
+		/**
+		 * The name of the sink. Must be unique in the whole system. 
+		 */
 		std::string name;
+		/**
+		 * This attribute reflects the availability of the sink. There are several reasons why a sink could be not available for the moment: for example the shutdown of a sink because of overtemperature or over- & undervoltage. The availability consists of two pieces of information:

+		 * 

+		 *     Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN

+		 *     AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
+		 */
 		am_Availability_s availability;
+		/**
+		 * This is the representation of the Volume for the commandInterface. It is used by the HMI to set the volume of a sink, the AudioManagerController has to transform this into real source and sink volumes.
+		 */
 		am_mainVolume_t volume;
 		am_MuteState_e muteState;
+		/**
+		 * The sinkClassID references to a sinkClass. With the help of classification, rules can be setup to define the system behaviour.
+		 */
 		am_sinkClass_t sinkClassID;
 
 	};
 
 	/**
+	 * a handle is used for asynchronous operations and is uniquely assigned for each of this operations 
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:38 PM
+	 * @created 05-Mar-2012 9:02:05 PM
 	 */
 	struct am_Handle_s
 	{
 
 	public:
+		/**
+		 * the handletype
+		 */
 		am_Handle_e handleType:4;
+		/**
+		 * the handle as value
+		 */
 		uint16_t handle:12;
 
 	};
 
 	/**
+	 * struct describung mainsound property
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:38 PM
+	 * @created 05-Mar-2012 9:02:06 PM
 	 */
 	struct am_MainSoundProperty_s
 	{
 
 	public:
+		/**
+		 * the type of the property 
+		 */
 		am_MainSoundPropertyType_e type;
+		/**
+		 * the actual value
+		 */
 		int16_t value;
 
 	};
@@ -644,29 +793,51 @@ namespace am {
 	/**
 	 * this type holds all information of connections relevant to the HMI
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:38 PM
+	 * @created 05-Mar-2012 9:02:06 PM
 	 */
 	struct am_MainConnectionType_s
 	{
 
 	public:
+		/**
+		 * the ID of the mainconnection
+		 */
 		am_mainConnectionID_t mainConnectionID;
+		/**
+		 * the sourceID where the connection starts
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * the sinkID where the connection ends
+		 */
 		am_sinkID_t sinkID;
+		/**
+		 * the delay of the mainconnection
+		 */
 		am_timeSync_t delay;
+		/**
+		 * the current connection state
+		 */
 		am_ConnectionState_e connectionState;
 
 	};
 
 	/**
+	 * struct that holds attribiutes of a mainconnection
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:39 PM
+	 * @created 05-Mar-2012 9:02:06 PM
 	 */
 	struct am_MainConnection_s
 	{
 
 	public:
+		/**
+		 * the assigned ID
+		 */
 		am_mainConnectionID_t mainConnectionID;
+		/**
+		 * the current connection state
+		 */
 		am_ConnectionState_e connectionState;
 		/**
 		 * the sinkID
@@ -676,96 +847,218 @@ namespace am {
 		 * the sourceID
 		 */
 		am_sourceID_t sourceID;
+		/**
+		 * the delay of the connection
+		 */
 		am_timeSync_t delay;
+		/**
+		 * the list of sub connection IDs the mainconnection consists of 
+		 */
 		std::vector<am_connectionID_t> listConnectionID;
 
 	};
 
 	/**
+	 * This struct describes the attribiutes of a sink
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:39 PM
+	 * @created 05-Mar-2012 9:02:06 PM
 	 */
 	struct am_Sink_s
 	{
 
 	public:
+		/**
+		 * This is the ID of the sink, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
+		 */
 		am_sinkID_t sinkID;
+		/**
+		 * The name of the sink. Must be unique in the whole system. 
+		 */
 		std::string name;
+		/**
+		 * The domainID is the domain the sink belongs to. A sink can only be in one domain.
+		 */
 		am_domainID_t domainID;
+		/**
+		 * The sinkClassID references to a sinkClass. With the help of classification, rules can be setup to define the system behaviour.
+		 */
 		am_sinkClass_t sinkClassID;
+		/**
+		 * This is the volume of the sink. It is set by the AudioManagerController. 
+		 */
 		am_volume_t volume;
+		/**
+		 * This Boolean flag indicates whether a sink is visible to the commandInterface or not. If the User must have the possibility to choose the source in the HMI, it must be visible. But there are also good reasons for invisible sinks, for example if the sink is part of a crossfader or gateway. HMI relevant changes in visible sinks will be automatically reported by the daemon to the commandInterface.
+		 */
 		bool visible;
+		/**
+		 * This attribute reflects the availability of the sink. There are several reasons why a sink could be not available for the moment: for example the shutdown of a sink because of overtemperature or over- & undervoltage. The availability consists of two pieces of information:

+		 * 

+		 *     Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN

+		 *     AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
+		 */
 		am_Availability_s available;
+		/**
+		 * This attribute reflects the muteState of the sink. The information is not the "real" state of the sink, but the HMI representation for he commandInterface controlled by the AudioManagerController.
+		 */
 		am_MuteState_e muteState;
+		/**
+		 * This is the representation of the Volume for the commandInterface. It is used by the HMI to set the volume of a sink, the AudioManagerController has to transform this into real source and sink volumes.
+		 */
 		am_mainVolume_t mainVolume;
+		/**
+		 * This is the list of soundProperties, that the sink is capable of. The soundProperties itself are project specific. For sinks, a possible soundProperty could be for example settings.
+		 */
 		std::vector<am_SoundProperty_s> listSoundProperties;
+		/**
+		 * This list holds information about the formats that the Source is capable of supporting when delivering audio.
+		 */
 		std::vector<am_ConnectionFormat_e> listConnectionFormats;
+		/**
+		 * This is the list of the available mainSoundProperties. The principle is the same than with soundProperties, but they are only visible to the CommandInterface.
+		 */
 		std::vector<am_MainSoundProperty_s> listMainSoundProperties;
 
 	};
 
 	/**
+	 * This struct describes the attribiutes of a source
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:39 PM
+	 * @created 05-Mar-2012 9:02:06 PM
 	 */
 	struct am_Source_s
 	{
 
 	public:
+		/**
+		 * This is the ID of the source, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * The domainID is the domain the source belongs to. A source can only be in one domain.
+		 */
 		am_domainID_t domainID;
+		/**
+		 * The name of the source. Must be unique in the whole system.
+		 */
 		std::string name;
+		/**
+		 * the sourceClassID, indicates the class the source is in. This information can be used by the Controller to implement different behaviour for different classes.
+		 */
 		am_sourceClass_t sourceClassID;
+		/**
+		 * The source state is an indication towards the source if it is actively heard or not. The source can use this information to implement features like automatic spin down of CD's in case the CD is not the active source or AF following of a tuner that is not actively heard. The source state is set by the AudioManagerController.There are 3 possible states:

+		 * 

+		 *     SS_ON: the source is active

+		 *     SS_OFF: the source is off

+		 *     SS_PAUSED: the source is paused and not active.
+		 */
 		am_SourceState_e sourceState;
+		/**
+		 * This is the volume of the source. It is set by the AudioManagerController. It is used to adopt different audiolevels in a system and mixing of sources (e.g. navigation hints & music). 
+		 */
 		am_volume_t volume;
+		/**
+		 * This Boolean flag indicates whether a source is visible to the commandInterface or not. If the User must have the possibility to choose the source in the HMI, it must be visible. But there are also good reasons for invisible sources, for example if the source is part of a crossfader or gateway. HMI relevant changes in visible sources will be automatically reported by the daemon to the commandInterface.
+		 */
 		bool visible;
+		/**
+		 * This attribute reflects the availability of the source. There are several reasons why a source could be not available for the moment. For example a CD player which has no CD entered in the slot can be unavailable, or a USB player with no or unreadable stick attached. Other scenarios involve the shutdown of a source because of overtemperature or over- & undervoltage. The availability consists of two informations:

+		 * 

+		 *     Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN

+		 *     AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
+		 */
 		am_Availability_s available;
+		/**
+		 * Some special sources can have special behaviors, the are so called "Low Level Interrupts". Here the current status is documented. The information can be used by the AudioManagerController to react to the changes by for example lowering the volume of the mainSources. The two states are

+		 * 

+		 *     IS_OFF: the interrupt is not active at the moment

+		 *     IS_INTERRUPTED: the interrupt is playing at the moment.
+		 */
 		am_InterruptState_e interruptState;
 		/**
-		 * This list holds all soundProperties of the source
+		 * This is the list of soundProperties, that the source is capable of. The soundProperties itself are project specific. For sources, a possible soundProperty could be navigation volume offset, for example. 
 		 */
 		std::vector<am_SoundProperty_s> listSoundProperties;
 		/**
-		 * list of the supported ConnectionFormats
+		 * This list holds information about the formats that the Source is capable of supporting when delivering audio.
 		 */
 		std::vector<am_ConnectionFormat_e> listConnectionFormats;
 		/**
-		 * This list holds all MainSoundProperties of the source (all the ones that can be set via the HMI)
+		 * This is the list of the available mainSoundProperties. The principle is the same than with soundProperties, but they are only visible to the CommandInterface.
 		 */
 		std::vector<am_MainSoundProperty_s> listMainSoundProperties;
 
 	};
 
 	/**
+	 * This struct describes the attribiutes of a domain
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:39 PM
+	 * @created 05-Mar-2012 9:02:06 PM
 	 */
 	struct am_Domain_s
 	{
 
 	public:
+		/**
+		 * the domain ID
+		 */
 		am_domainID_t domainID;
+		/**
+		 * the name of the domain
+		 */
 		std::string name;
+		/**
+		 * the busname. This is equal to a plugin name and is used to dispatch messages to the elements of a plugin
+		 */
 		std::string busname;
+		/**
+		 * the name of the node
+		 */
 		std::string nodename;
+		/**
+		 * indicated if the domain is independent at startup or not
+		 */
 		bool early;
+		/**
+		 * indicates if the domain registration is complete or not
+		 */
 		bool complete;
+		/**
+		 * the current domain state
+		 */
 		am_DomainState_e state;
 
 	};
 
 	/**
+	 * a connection
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:39 PM
+	 * @created 05-Mar-2012 9:02:06 PM
 	 */
 	struct am_Connection_s
 	{
 
 	public:
+		/**
+		 * the assigned ID
+		 */
 		am_connectionID_t connectionID;
+		/**
+		 * the source the audio flows from
+		 */
 		am_sourceID_t sourceID;
+		/**
+		 * the sink the audio flows to
+		 */
 		am_sinkID_t sinkID;
+		/**
+		 * the delay of the conneciton
+		 */
 		am_timeSync_t delay;
+		/**
+		 * the used connectionformat
+		 */
 		am_ConnectionFormat_e connectionFormat;
 
 	};
@@ -775,7 +1068,7 @@ namespace am {
 	 * volume_t in case of ED_SOURCE_VOLUME, ED_SINK_VOLUME 

 	 * soundProperty_t in case of ED_SOURCE_PROPERTY, ED_SINK_PROPERTY 
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:39 PM
+	 * @created 05-Mar-2012 9:02:07 PM
 	 */
 	union am_EarlyData_u
 	{
@@ -791,7 +1084,7 @@ namespace am {
 	 * sourceID in case of ED_SOURCE_VOLUME, ED_SOURCE_PROPERTY

 	 * sinkID in case of ED_SINK_VOLUME, ED_SINK_PROPERTY 
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:39 PM
+	 * @created 05-Mar-2012 9:02:07 PM
 	 */
 	union am_DataType_u
 	{
@@ -804,7 +1097,7 @@ namespace am {
 
 	/**
 	 * @author Christian Mueller
-	 * @created 29-Feb-2012 6:16:40 PM
+	 * @created 05-Mar-2012 9:02:07 PM
 	 */
 	struct am_EarlyData_s
 	{
@@ -816,4 +1109,4 @@ namespace am {
 
 	};
 }
-#endif // !defined(EA_1F9A0AD1_FF28_4de6_A5C7_2F570F618734__INCLUDED_)
+#endif // !defined(EA_FF16184D_524E_4747_8AC7_DD40DA868A0E__INCLUDED_)