export.include.IPCSlave.h Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of libfmipp Show documentation
This package provides the native dependencies for the FMI++ Java bindings (e.g., Windows DLLs)
The newest version!
// -------------------------------------------------------------------
// Copyright (c) 2013-2017, AIT Austrian Institute of Technology GmbH.
// All rights reserved. See file FMIPP_LICENSE for details.
// -------------------------------------------------------------------

#ifndef _FMIPP_IPCSLAVE_H
#define _FMIPP_IPCSLAVE_H

#include 
#include 

#include "export/include/IPCLogger.h"

template class ScalarVariable;

/**
 * \file IPCSlave.h
 * \class IPCSlave IPCSlave.h
 * Abstract interface class for handling the inter-process communication for FMIComponentBackEnd.
 */


class IPCSlave
{

public:

	/// Constructor.
	IPCSlave( IPCLogger* logger ) : logger_( logger ) {}

	/// Destructor.
	virtual ~IPCSlave() {}

	///
	/// Re-initialize the slave.
	///
	virtual void reinitialize() = 0;

	///
	/// Check if data exchange/syncing is working.
	///
	virtual bool isOperational() = 0;

	///
	/// Retrieve pointer to a double data object.
	///
	virtual bool retrieveVariable( const std::string& id,
				       double*& var ) const = 0;

	///
	/// Retrieve pointer to an integer data object.
	///
	virtual bool retrieveVariable( const std::string& id,
				       int*& var ) const = 0;

	///
	/// Retrieve pointer to a boolean data object.
	///
	virtual bool retrieveVariable( const std::string& id,
				       bool*& var ) const = 0;

	///
	/// Retrieve vector of pointers to double scalar variables.
	///
	virtual bool retrieveScalars( const std::string& id,
				      std::vector*>& vars ) const = 0;

	///
	/// Retrieve vector of pointers to integer scalar variables.
	///
	virtual bool retrieveScalars( const std::string& id,
				      std::vector*>& vars ) const = 0;

	///
	/// Retrieve vector of pointers to char (fmiBoolean) scalar variables.
	///
	virtual bool retrieveScalars( const std::string& id,
				      std::vector*>& vars ) const = 0;

	///
	/// Retrieve vector of pointers to string scalar variables.
	///
	virtual bool retrieveScalars( const std::string& id,
				      std::vector*>& vars ) const = 0;

	///
	/// Wait for signal from master to resume execution.
	/// Blocks until signal from slave is received.
	///
	virtual void waitForMaster() = 0;

	///
	/// Send signal to master to proceed with execution.
	/// Do not alter shared data until waitForMaster() unblocks.
	///
	virtual void signalToMaster() = 0;

	///
	/// Stop execution for ms milliseconds.
	///
	virtual void sleep( unsigned int ms ) const = 0;


	///
	/// Call logger.
	///
	inline void logger( fmi2Status status, const std::string& category, const std::string& msg ) {
		logger_->logger( status, category, msg );
	}


private:

	/// Default constructor is private to prevent usage.
	IPCSlave() : logger_( 0 ) {}

	/// Logger instance.
	IPCLogger* logger_;


};


/// This namespace contains functions that help to create instances of classes derived from IPCSlave.
namespace IPCSlaveFactory {

#ifndef _MSC_VER
	///
	/// Helper function to create arbitrary instances of IPC slaves.
	///
	template
	IPCSlave* createIPCSlave( Params... params ) { return new Type( params... ); }

#else // Unfortunatelly, MSVC does not not support variadic templates ...

	///
	/// Helper function to create an instance of IPC slave (no arguments).
	///
	template
	IPCSlave* createIPCSlave() { return new Type(); }

	///
	/// Helper function to create an instance of IPC slave (1 argument).
	///
	template
	IPCSlave* createIPCSlave( Param1 p1 ) { return new Type( p1 ); }

	///
	/// Helper function to create an instance of IPC slave (2 arguments).
	///
	template
	IPCSlave* createIPCSlave( Param1 p1, Param2 p2 ) { return new Type( p1, p2 ); }

	///
	/// Helper function to create an instance of IPC slave (3 arguments).
	///
	template
	IPCSlave* createIPCSlave( Param1 p1, Param2 p2, Param3 p3 ) { return new Type( p1, p2, p3 ); }

#endif


}


#endif // _FMIPP_IPCSLAVE_H