Table of Contents

include/AK/Tools/Common/AkKeyDef.h

Go to the documentation of this file.
00001 /*******************************************************************************
00002 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
00003 released in source code form as part of the SDK installer package.
00004 
00005 Commercial License Usage
00006 
00007 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
00008 may use this file in accordance with the end user license agreement provided 
00009 with the software or, alternatively, in accordance with the terms contained in a
00010 written agreement between you and Audiokinetic Inc.
00011 
00012 Apache License Usage
00013 
00014 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
00015 "Apache License"); you may not use this file except in compliance with the 
00016 Apache License. You may obtain a copy of the Apache License at 
00017 http://www.apache.org/licenses/LICENSE-2.0.
00018 
00019 Unless required by applicable law or agreed to in writing, software distributed
00020 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
00021 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
00022 the specific language governing permissions and limitations under the License.
00023 
00024   Version: <VERSION>  Build: <BUILDNUMBER>
00025   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
00026 *******************************************************************************/
00027 
00028 #ifndef _KEYDEF_H_
00029 #define _KEYDEF_H_
00030 
00031 #include <AK/Tools/Common/AkArray.h> //For ArrayPoolDefault
00032 
00033 template <class T_KEY, class T_ITEM> 
00034 struct MapStruct
00035 {
00036     T_KEY   key; 
00037     T_ITEM  item;
00038     bool operator ==(const MapStruct& in_Op) const
00039     {
00040         return ( (key == in_Op.key) /*&& (item == in_Op.item)*/ );
00041     }
00042 
00043     void Transfer(MapStruct<T_KEY, T_ITEM>& in_rSource)
00044     {
00045         key = in_rSource.key;
00046         item.Transfer(in_rSource.item); //transfer ownership of resources.
00047     }
00048 };
00049 
00050 
00051 // A helper struct that can be used as a T_ITEM in an CAkKeyArray, when you need to only preform a shallow copy
00052 //   on the data that you are referencing.  For example if you wanted to to use an AkArray type.
00053 // NOTE: AllocData() and FreeData() must be explicitly called, or else pData can be manually Alloc'd/Free'd.
00054 template < typename T_KEY, typename T_DATA, class T_ALLOC = ArrayPoolDefault >
00055 struct AkKeyDataPtrStruct: public T_ALLOC
00056 {
00057     AkKeyDataPtrStruct(): pData(NULL) {}
00058     AkKeyDataPtrStruct(T_KEY in_key): key(in_key), pData(NULL) {}
00059 
00060     T_KEY   key;
00061     T_DATA* pData;
00062     bool operator ==(const AkKeyDataPtrStruct<T_KEY,T_DATA>& in_Op) const
00063     {
00064         return ( key == in_Op.key );
00065     }
00066 
00067     bool AllocData()
00068     {
00069         AKASSERT( !pData );
00070         pData = (T_DATA*) T_ALLOC::Alloc( sizeof( T_DATA ));
00071         if (pData)
00072         {
00073             AkPlacementNew( pData ) T_DATA();
00074             return true;
00075         }
00076         return false;
00077     }
00078 
00079     void FreeData()
00080     {
00081         if( pData )
00082         {
00083             pData->~T_DATA();
00084             T_ALLOC::Free(pData);
00085             pData = NULL;
00086         }
00087     }
00088 
00089     static AkForceInline T_KEY& Get( AkKeyDataPtrStruct<T_KEY, T_DATA>& in_val ) { return in_val.key; }
00090 };
00091 
00092 #endif //_KEYDEF_H_