Starting cleanup, style, etc. in preparation of big API update before release

include/VAAttributable.h

-/*
- *  --------------------------------------------------------------------------------------------
- *
- *    VVV        VVV A           Virtual Acoustics (VA) | http://www.virtualacoustics.org
- *     VVV      VVV AAA          Licensed under the Apache License, Version 2.0
- *      VVV    VVV   AAA
- *       VVV  VVV     AAA        Copyright 2015-2017
- *        VVVVVV       AAA       Institute of Technical Acoustics (ITA)
- *         VVVV         AAA      RWTH Aachen University
- *
- *  --------------------------------------------------------------------------------------------
- */
-
-#ifndef IW_VABASE_ATTRIBUTABLE
-#define IW_VABASE_ATTRIBUTABLE
-
-#include <VABaseDefinitions.h>
-#include <map>
-
-//! Attribute base class
-/**
-  * This is the base class for attributes.
-  * Currently it only defines the destructor.
-  */
-class VABASE_API IVAAttribute
-{
-public:
-	virtual ~IVAAttribute();
-};
-
-//! Attributation interface
-/**
-  * This aspect allows attaching/detaching attributes by means of a pointer
-  * to some instance of a class. The attributes are associated with their owner,
-  * the instance, which added/removed them. Thereby 1 instance can be associated
-  * with N attributes. The interface is used, so that other class can extend
-  * previously created instances of some base class with their own runtime data.
-  * Example: An HRIR dataset can be attach with some frequency-domain HRTF representation.
-  */
-
-class VABASE_API IVAAttributable
-{
-public:
-	virtual ~IVAAttributable();
-
-	virtual void AttachAttribute( void* pOwner, IVAAttribute* pAttr ) = 0;
-	virtual void DetachAttribute( void* pOwner ) = 0;
-	virtual IVAAttribute* GetAttribute( void* pOwner ) = 0;
-};
-
-//! Attributation interface default implementation
-/**
-  * Implements the IVAAttributable interface using std::map.
-  * @note not thread-safe
-  */
-class VABASE_API CVAAttributableImpl : public IVAAttributable
-{
-public:
-	virtual ~CVAAttributableImpl();
-	virtual void AttachAttribute( void* pOwner, IVAAttribute* pAttr );
-	virtual void DetachAttribute( void* pOwner );
-	virtual IVAAttribute* GetAttribute( void* pOwner );
-
-private:
-	typedef std::map<void*, IVAAttribute*> AttrMap;
-	typedef AttrMap::iterator AttrMapIt;
-
-	AttrMap m_mAttr;
-};
-
-#endif // IW_VABASE_ATTRIBUTABLE

include/VAAudioSignalSource.h

@@ -15,6 +15,7 @@
 #define IW_VABASE_AUDIO_SIGNAL_SOURCE
 
 #include <VABaseDefinitions.h>
+#include <VABase.h>
 #include <VAStruct.h>
 
 #include <string>
@@ -49,20 +50,20 @@ public:
 		VA_SS_ENGINE,		//!< Sound source is an engine
 		VA_SS_MACHINE,		//!< Sound source is a machine
 		VA_SS_TEXT_TO_SPEECH,
-	} SoundSourceTypes;
+	};
 
 	//! Destructor.
 	inline virtual ~IVAAudioSignalSource() {};
 
 	//! Type ID getter
 	/**
-	  * \return Returns the ID (one out of #SoundSourceTypes)
+	  * @return Returns the ID (one out of #SoundSourceTypes)
 	  */
 	virtual int GetType() const = 0;
 
 	//! Type getter (human readable string)
 	/**
-	  * \return Returns the type (one out of #SoundSourceTypes as a human readable string)
+	  * @return Returns the type (one out of #SoundSourceTypes as a human readable string)
 	  */
 	virtual std::string GetTypeString() const = 0;
 
@@ -71,7 +72,7 @@ public:
 	  * The description formulates a human readable string that describes the
 	  * sound source, i.e. 'Network stream on port 2344'
 	  *
-	  * \return Returns a human readable sound source description
+	  * @return Returns a human readable sound source description
 	  */
 	virtual std::string GetDesc() const = 0;
 
@@ -80,7 +81,7 @@ public:
 	  * The sound state is for example the percentage of progess
 	  * in an audio file sound source, i.e. 'Playback (10%)'
 	  *
-	  * \return Returns a human readable status of the sound source
+	  * @return Returns a human readable status of the sound source
 	  */
 	virtual std::string GetStateString() const = 0;
 
@@ -92,7 +93,7 @@ public:
 	  * This method is used by the core to assuure that the sound source
 	  * object has not been associated to another core (not allowed).
 	  *
-	  * \return Pointer to the associated #IVACore, NULL if non present
+	  * @return Pointer to the associated #IVACore, NULL if non present
 	  */
 	virtual IVACore* GetAssociatedCore() const = 0;
 

include/VACore.h

@@ -15,6 +15,7 @@
 #define IW_VABASE_CORE
 
 #include <VABaseDefinitions.h>
+#include <VABase.h>
 
 #include <string>
 

include/VACoreVersion.h

@@ -20,7 +20,8 @@
 /**
  * Diese Datenklasse beschreibt Versionsinformationen ber den VA-Kern
  */
-class VABASE_API CVACoreVersionInfo {
+class VABASE_API CVACoreVersionInfo
+{
 public:
 	std::string sVersion;				// Version als Zeichenkette (z.B. "1.02")
 	std::string sDate;					// Datum der Erstellung bzw. Verffentlichung

include/VAException.h

@@ -24,10 +24,12 @@
  * Exceptions are defined by an error code and an error message.
  */
 
-class VABASE_API CVAException {
+class VABASE_API CVAException
+{
 public:
 	//! Error codes
-	enum {
+	enum ErrorCode 
+	{
 		UNSPECIFIED = 0,		//!< An error that is not specified in detail
 		INVALID_PARAMETER = 1,	//!< A parameter provided is invalid
 		INVALID_ID = 2,			//!< An identifier (ID) provided is invalid
@@ -43,7 +45,7 @@ public:
 	CVAException();
 
 	//! Initialization constructor
-	CVAException(int iErrorCode, const std::string& sErrorMessage="");
+	CVAException( int iErrorCode, const std::string& sErrorMessage = "" );
 
 	//! Destructor
 	virtual ~CVAException();
@@ -69,6 +71,6 @@ protected:
 #define VA_EXCEPT_NOT_IMPLEMENTED { throw CVAException( (CVAException::NOT_IMPLEMENTED) , "Not implemented" ); }
 
 //! STL stream output operator
-VABASE_API std::ostream& operator<<(std::ostream& os, const CVAException& ex);
+VABASE_API std::ostream& operator<<( std::ostream& os, const CVAException& ex );
 
 #endif // IW_VABASE_EXCEPTION

include/VAObject.h

@@ -15,6 +15,7 @@
 #define IW_VABASE_OBJECT
 
 #include <VABaseDefinitions.h>
+#include <VABase.h>
 #include <VAStruct.h>
 
 //! Base class for objects with identity and message interface
@@ -50,7 +51,7 @@ public:
 	 *         0, if the object did not return an answer message
 	 *         -1, if the message could not be handled
 	 */
-	// TODO: Int als Rckgabe?
+	// TODO: Int als Rckgabe? @todo jst: remove return value, unnecessary. But check consequence.
 	virtual int CallObject( const CVAStruct& oArgs, CVAStruct& oReturn );
 
 protected:

include/VAObjectRegistry.h

@@ -15,7 +15,7 @@
 #define IW_VABASE_OBJECT_REGISTRY
 
 #include <VABaseDefinitions.h>
-//#include <VAObject.h>
+#include <VABase.h>
 #include <VAStruct.h>
 
 #include <map>
@@ -26,10 +26,10 @@ class CVAObject;
 
 //! Registry class for objects
 /**
- * 
+ *
  */
-
-class VABASE_API CVAObjectRegistry {
+class VABASE_API CVAObjectRegistry
+{
 public:
 	//! Default constructor
 	CVAObjectRegistry();
@@ -41,59 +41,59 @@ public:
 	void Clear();
 
 	//! Registers an object with the registry and returns its ID
-	int RegisterObject(CVAObject* pObject);
+	int RegisterObject( CVAObject* pObject );
 
 	//! Deregisters an object from the registry
-	void UnregisterObject(CVAObject* pObject);
+	void UnregisterObject( CVAObject* pObject );
 
 	//! Query the IDs of all objects
-	void GetObjectIDs(std::vector<int>& viIDs) const;
+	void GetObjectIDs( std::vector<int>& viIDs ) const;
 
 	//! Query information on all objects
-	void GetObjectInfos(std::vector<CVAObjectInfo>& viInfos) const;
+	void GetObjectInfos( std::vector< CVAObjectInfo >& viInfos ) const;
 
 	//! Finds an object by its ID
 	/**
 	 * \return Pointer to the object, NULL if not found
 	 */
-	CVAObject* FindObjectByID(int iID) const;
+	CVAObject* FindObjectByID( int iID ) const;
 
 	//! Finds the object with the given name
 	/**
-     * \return Pointer to the object, NULL if not found
+	 * \return Pointer to the object, NULL if not found
 	 * \note Object names are case-sensitive
 	 */
-	CVAObject* FindObjectByName(const std::string& sName) const;
+	CVAObject* FindObjectByName( const std::string& sName ) const;
 
 	//! Returns an object by its ID
 	/**
 	 * \return Pointer to the object
 	 * \note Throws an exception "invalid object ID" in case the object does not exist
 	 */
-	CVAObject* GetObjectByID(int iID) const;
+	CVAObject* GetObjectByID( int iID ) const;
 
 	//! Returns the object with the given name
 	/**
-     * \return Pointer to the object, if existing,
+	 * \return Pointer to the object, if existing,
 	 * \note Throws an exception "unknown object" in case the object does not exist
 	 * \note Object names are case-sensitive
 	 */
-	CVAObject* GetObjectByName(const std::string& sName) const;
+	CVAObject* GetObjectByName( const std::string& sName ) const;
 
 	//! Calls an object determined by its ID
 	/**
 	 * \returns Throws an "invalid object ID" exception, if the object does not exist
 	 */
-	void CallObjectByID(int iID, const CVAStruct& oArgs, CVAStruct& oReturn) const;
+	void CallObjectByID( int iID, const CVAStruct& oArgs, CVAStruct& oReturn ) const;
 
 	//! Calls an object determined by its name
 	/**
 	 * \returns Throws an "unknown object" exception, if the object does not exist
-	 */	
-	void CallObjectByName(const std::string& sName, const CVAStruct& oArgs, CVAStruct& oReturn) const;
+	 */
+	void CallObjectByName( const std::string& sName, const CVAStruct& oArgs, CVAStruct& oReturn ) const;
 
 private:
-	std::vector<CVAObject*> m_vpObjects;				// Object table (O(1) lookups!)
+	std::vector< CVAObject* > m_vpObjects;				// Object table (O(1) lookups!)
 	std::map< std::string, CVAObject* > m_mpObjects;	// Fast name search structure (O(log N) queries!)
 	size_t m_nObjects;									// Number of registered objects
 	int m_iIDLast;										// ID counter

include/VASamples.h

@@ -50,7 +50,6 @@ public:
 
 	std::vector< float > vfSamples; //!< Vector of audio samples, 32-bit floating point precision
 
-
 	CVASampleBuffer& operator=( const CVASampleBuffer& );
 };
 

include/VAStruct.h

@@ -33,11 +33,11 @@ class VABASE_API CVAStructValue;
 class VABASE_API compareStringCaseInsensitive
 {
 public:
-	inline bool operator()(const std::string& a, const std::string& b) const
+	inline bool operator()( const std::string& a, const std::string& b ) const
 	{
-		std::string la(a), lb(b);
-		std::transform(la.begin(), la.end(), la.begin(), ::tolower);
-		std::transform(lb.begin(), lb.end(), lb.begin(), ::tolower);
+		std::string la( a ), lb( b );
+		std::transform( la.begin(), la.end(), la.begin(), ::tolower );
+		std::transform( lb.begin(), lb.end(), lb.begin(), ::tolower );
 		return la < lb;
 	}
 };
@@ -48,13 +48,12 @@ public:
  * string keys to values. A variety of key values is supported,
  * for instance primitive types (bool, int, double, string).
  * Nesting is also supported by assigning keys another
- * associative array. Keys names are case-insensitive. 
- * The class features simple and effective use by defining 
+ * associative array. Keys names are case-insensitive.
+ * The class features simple and effective use by defining
  * data access and cast operators.
  * It can be efficiently serialized/deserialized,
  * making it a suitable container for message mechanisms.
  */
-
 class VABASE_API CVAStruct
 {
 public:
@@ -69,7 +68,7 @@ public:
 	CVAStruct();
 
 	//! Copy constructor
-	CVAStruct(const CVAStruct&);
+	CVAStruct( const CVAStruct& );
 
 	//! Destructor
 	virtual ~CVAStruct();
@@ -81,26 +80,26 @@ public:
 	bool IsEmpty() const;
 
 	//! Returns if the given key exists
-	bool HasKey(const std::string& sKey) const;
+	bool HasKey( const std::string& sKey ) const;
 
 	//! Deletes all keys
 	void Clear();
 
 	//! Removes a key and its value (supports paths)
-	bool RemoveKey(const std::string& sKey);
+	bool RemoveKey( const std::string& sKey );
 
 	//! Return the pointer to a key  (read-only)
 	/**
 	 * The key can be specified either by a name or a path.
 	 * In the latter case the method traverses through the structure.
 	 *
-	 * \note This functions never creates a non-existent key	 
+	 * \note This functions never creates a non-existent key
 	 * \note This functions is more complex than GetKey(const std::string&)
 	 *
 	 * \return Valid pointer, if the given key exists,
 	 *         nullptr, otherwise
 	 */
-	const CVAStructValue* GetValue(const std::string& sPath, char cPathSeparator=DEFAULT_PATH_SEPARATOR) const;
+	const CVAStructValue* GetValue( const std::string& sPath, char cPathSeparator = DEFAULT_PATH_SEPARATOR ) const;
 
 	//! Return the pointer to a key (read-write)
 	/**
@@ -113,18 +112,18 @@ public:
 	 * \return Valid pointer, if the given key exists,
 	 *         nullptr, otherwise
 	 */
-	CVAStructValue* GetValue(const std::string& sPath, char cPathSeparator=DEFAULT_PATH_SEPARATOR);
+	CVAStructValue* GetValue( const std::string& sPath, char cPathSeparator = DEFAULT_PATH_SEPARATOR );
 
 	//! Read-only data access
-	const CVAStructValue& operator[](const char* pcKey) const;
-	inline const CVAStructValue& operator[](const std::string& sKey) const { return (*this)[sKey.c_str()]; };
+	const CVAStructValue& operator[]( const char* pcKey ) const;
+	inline const CVAStructValue& operator[]( const std::string& sKey ) const { return ( *this )[ sKey.c_str() ]; };
 
 	//! Read/write data access
-	CVAStructValue& operator[](const char* pcKey);
-	inline CVAStructValue& operator[](const std::string& sKey) { return (*this)[sKey.c_str()]; };
+	CVAStructValue& operator[]( const char* pcKey );
+	inline CVAStructValue& operator[]( const std::string& sKey ) { return ( *this )[ sKey.c_str() ]; };
 
 	//! Assignment
-	CVAStruct& operator=(const CVAStruct& rhs);
+	CVAStruct& operator=( const CVAStruct& rhs );
 
 	//! Iterator pattern
 	CVAStruct::iterator Begin();
@@ -133,10 +132,10 @@ public:
 	CVAStruct::const_iterator End() const;
 
 	//! Merge struct with another one
-	void Merge(const CVAStruct& rhs, bool bUnique=true);
+	void Merge( const CVAStruct& rhs, bool bUnique = true );
 
 	//! Return a string representation of the container
-	std::string ToString(int iIndent=0) const;
+	std::string ToString( int iIndent = 0 ) const;
 private:
 	typedef std::map<std::string, CVAStructValue, compareStringCaseInsensitive> Map;
 	typedef Map::const_iterator MapCit;
@@ -144,8 +143,8 @@ private:
 	Map m_mData;
 
 	// Traversal methods
-	const CVAStructValue* Traverse(const std::string& sPath, size_t iPathCursor=0, char cPathSeparator=DEFAULT_PATH_SEPARATOR) const;
-	CVAStructValue* Traverse(const std::string& sPath, size_t iPathCursor=0, char cPathSeparator=DEFAULT_PATH_SEPARATOR);
+	const CVAStructValue* Traverse( const std::string& sPath, size_t iPathCursor = 0, char cPathSeparator = DEFAULT_PATH_SEPARATOR ) const;
+	CVAStructValue* Traverse( const std::string& sPath, size_t iPathCursor = 0, char cPathSeparator = DEFAULT_PATH_SEPARATOR );
 };
 
 //! Associative array value class
@@ -157,9 +156,10 @@ class VABASE_API CVAStructValue
 {
 public:
 	//! Key types
-	enum {
-		UNASSIGNED=-1,	//!< Uninitialized key without a type
-		BOOL=0,			//!< Boolean key
+	enum KeyType
+	{
+		UNASSIGNED = -1,	//!< Uninitialized key without a type
+		BOOL = 0,			//!< Boolean key
 		INT,			//!< Integer key
 		DOUBLE,			//!< Double-precision floating-point key
 		STRING,			//!< String key
@@ -172,17 +172,17 @@ public:
 	CVAStructValue();
 
 	//! Initialization constructors
-	CVAStructValue(bool value);
-	CVAStructValue(int value);
-	CVAStructValue(double value);
-	CVAStructValue(const char* value);
-	CVAStructValue(const std::string& value);
-	CVAStructValue(const CVAStruct& value);
-	CVAStructValue(void* pData, int iBytes);
+	CVAStructValue( bool value );
+	CVAStructValue( int value );
+	CVAStructValue( double value );
+	CVAStructValue( const char* value );
+	CVAStructValue( const std::string& value );
+	CVAStructValue( const CVAStruct& value );
+	CVAStructValue( void* pData, int iBytes );
 	CVAStructValue( const CVASampleBuffer& );
 
 	//! Copy constructor
-	CVAStructValue(const CVAStructValue&);
+	CVAStructValue( const CVAStructValue& );
 
 	//! Destructor
 	virtual ~CVAStructValue();
@@ -198,7 +198,7 @@ public:
 	void* GetData();
 
 	//! Sets the data (only for datatype DATA)
-	void SetData(void* pData, int iBytes);
+	void SetData( void* pData, int iBytes );
 
 	//! Returns a pointer to the struct value (only for datatype STRUCT)
 	const CVAStruct& GetStruct() const;
@@ -216,22 +216,22 @@ public:
 	bool IsSampleBuffer() const;
 
 	//! Assignment operators
-	CVAStructValue& operator=(const CVAStructValue&);
-	CVAStructValue& operator=(bool);
-	CVAStructValue& operator=(int);
-	CVAStructValue& operator=(double);
-	CVAStructValue& operator=(const char*);
-	CVAStructValue& operator=(const std::string&);
+	CVAStructValue& operator=( const CVAStructValue& );
+	CVAStructValue& operator=( bool );
+	CVAStructValue& operator=( int );
+	CVAStructValue& operator=( double );
+	CVAStructValue& operator=( const char* );
+	CVAStructValue& operator=( const std::string& );
 	CVAStructValue& operator=( const CVASampleBuffer& );
 
 	//! Read-only data access
 	// Note: Is applicable only for struct keys
-	const CVAStructValue& operator[](const char* pcKey) const;
+	const CVAStructValue& operator[]( const char* pcKey ) const;
 
 	//! Read/write data access
 	// Note: Is applicable only for struct keys
-	CVAStructValue& operator[](const char* pcKey);
-	inline CVAStructValue& operator[](const std::string& sKey) { return (*this)[sKey.c_str()]; };
+	CVAStructValue& operator[]( const char* pcKey );
+	inline CVAStructValue& operator[]( const std::string& sKey ) { return ( *this )[ sKey.c_str() ]; };
 
 	//! Cast to bool operator (required for assignments of the form 'bool = CVAStructKey')
 	operator bool() const;
@@ -244,19 +244,19 @@ public:
 
 	//! Cast to std::string operator (required for assignments of the form 'std::string = CVAStructKey')
 	operator std::string() const;
-	
+
 	//! Cast to void pointer (required for assignments of the form 'void* = CVAStructKey')
-	operator void*() const;
+	operator void*( ) const;
 
 	//! Cast to sample buffer
-	operator const CVASampleBuffer&() const;
+	operator const CVASampleBuffer&( ) const;
 
 	//! Cast to sample buffer
-	operator CVASampleBuffer&();
+	operator CVASampleBuffer&( );
 
 	//! Cast to CVAStruct (required for assignments of the form 'CVAStruct = CVAStructKey')
-	operator const CVAStruct&() const;
-	operator CVAStruct&();
+	operator const CVAStruct&( ) const;
+	operator CVAStruct&( );
 
 	//! Return a string representation of the key
 	std::string ToString() const;
@@ -273,14 +273,14 @@ private:
 	void* pData;
 	int iDataSize;
 	CVASampleBuffer sbValue;
-	
+
 	friend class CVAStruct;
 };
 
 //! STL stream output operator
-VABASE_API std::ostream& operator<<(std::ostream& os, const CVAStruct& s);
+VABASE_API std::ostream& operator<<( std::ostream& os, const CVAStruct& s );
 
 //! STL stream output operator
-VABASE_API std::ostream& operator<<(std::ostream& os, const CVAStructValue& key);
+VABASE_API std::ostream& operator<<( std::ostream& os, const CVAStructValue& key );
 
 #endif // IW_VABASE_STRUCT

include/_SourceFiles.cmake

@@ -4,8 +4,8 @@ set( RelativeDir "include" )
 set( RelativeSourceGroup "include" )
 
 set( DirFiles
-	VAAttributable.h
 	VAAudioSignalSource.h
+	VABase.h
 	VABaseDefinitions.h
 	VACore.h
 	VACoreEvent.h

src/VAAttributable.cpp

-/*
- *  --------------------------------------------------------------------------------------------
- *
- *    VVV        VVV A           Virtual Acoustics (VA) | http://www.virtualacoustics.org
- *     VVV      VVV AAA          Licensed under the Apache License, Version 2.0
- *      VVV    VVV   AAA
- *       VVV  VVV     AAA        Copyright 2015-2017
- *        VVVVVV       AAA       Institute of Technical Acoustics (ITA)
- *         VVVV         AAA      RWTH Aachen University
- *
- *  --------------------------------------------------------------------------------------------
- */
-
-#include <VAAttributable.h>
-
-#include <cassert>
-
-IVAAttribute::~IVAAttribute()
-{
-};
-
-IVAAttributable::~IVAAttributable()
-{
-};
-
-CVAAttributableImpl::~CVAAttributableImpl()
-{
-	// Free all remaining attributes
-	for( AttrMapIt it = m_mAttr.begin(); it != m_mAttr.end(); ++it )
-		delete it->second;
-}
-
-void CVAAttributableImpl::AttachAttribute( void* pOwner, IVAAttribute* pAttr )
-{
-	assert( pOwner && pAttr );
-	if( !pOwner || !pAttr )
-		return;
-	m_mAttr[ pOwner ] = pAttr;
-}
-
-void CVAAttributableImpl::DetachAttribute( void* pOwner )
-{
-	AttrMapIt it = m_mAttr.find( pOwner );
-	assert( it != m_mAttr.end() ); // Owner not found
-	if( it == m_mAttr.end() ) return;
-	m_mAttr.erase( it );
-}
-
-IVAAttribute* CVAAttributableImpl::GetAttribute( void* pOwner )
-{
-	AttrMapIt it = m_mAttr.find( pOwner );
-	assert( it != m_mAttr.end() ); // Owner not found
-	return ( it != m_mAttr.end() ? it->second : NULL );
-}

src/VABaseDefinitions.cpp → src/VABase.cpp

@@ -11,19 +11,19 @@
  *  --------------------------------------------------------------------------------------------
  */
 
-#include <VABaseDefinitions.h>
+#include <VABase.h>
 
 #include <iostream>
 #include <iomanip>
 
-std::ostream& operator<<(std::ostream& os, const VAVec3& oVec)
+std::ostream& operator<<( std::ostream& os, const VAVec3& oVec )
 {
-	return os << std::fixed << std::setprecision(3)
+	return os << std::fixed << std::setprecision( 3 )
 		<< "< " << oVec.x << ", " << oVec.y << ", " << oVec.z << " >";
 }
 
-std::ostream& operator<<(std::ostream& os, const VAOrientYPR& oOrient)
+std::ostream& operator<<( std::ostream& os, const VAOrientYPR& oOrient )
 {