This class gives access to HopsanCore for model and externalLib loading as well as component creation and simulation. More...

#include <HopsanEssentials.h>

Public Member Functions
	HopsanEssentials ()
	HopsanEssentials Constructor.

	~HopsanEssentials ()
	HopsanEssentials Destructor.

const char *	getCoreVersion () const
	Returns the HopsanCore version as a string.

const char *	getCoreBuildTime () const
	Returns the HopsanCore build date and time.

const char *	getCoreCompiler () const
	Get compiler info from core.

bool	isCore64Bit () const
	Check if core is compiled 64-bit.

bool	isCoreDebugCompiled () const

Component *	createComponent (const HString &rTypeName)
	Creates a component with the specified key-value and returns a pointer to this component.

ComponentSystem *	createComponentSystem ()
	Creates a ComponentSystem.

ConditionalComponentSystem *	createConditionalComponentSystem ()
	Creates a ConditionalComponentSystem.

void	removeComponent (Component *pComponent)

void	removeNode (Node *pNode)

bool	hasComponent (const HString &rType) const
	Check if a component with given typename exist in the ComponentFactory.

bool	reserveComponentTypeName (const HString &rTypeName)
	Reserves a component TypeName in the component factory map.

const std::vector< HString >	getRegisteredComponentTypes () const
	Returns a vector containing all registered component types.

Node *	createNode (const HString &rNodeType)
	Creates a Node of given node type.

const std::vector< HString >	getRegisteredNodeTypes () const
	Returns a vector containing all registered node types.

bool	haveQuantity (const HString &rQuantity) const
	Check if a quantity name is registered.

HopsanCoreMessageHandler *	getCoreMessageHandler ()
	Returns a pointer to the core message handler, do NOT use this function to get messages.

void	getMessage (HString &rMessage, HString &rType, HString &rTag)
	Get the message waiting on the message queue.

size_t	checkMessage ()
	Check if there are any messages waiting in the queue.

size_t	getNumInfoMessages () const
	Returns the number of waiting info messages on the message queue.

size_t	getNumWarningMessages () const
	Returns the number of waiting warning messages on the message queue.

size_t	getNumErrorMessages () const
	Returns the number of waiting error messages on the message queue.

size_t	getNumFatalMessages () const
	Returns the number of waiting fatal messages on the message queue.

size_t	getNumDebugMessages () const
	Returns the number of waiting debug messages on the message queue.

bool	openCoreLogFile (const char *absoluteFilePath)
	Opens the HopsanCore runtime log file, if not already opened.

bool	loadExternalComponentLib (const char *path)
	Loads an external component library.

bool	unLoadExternalComponentLib (const char *path)
	Unloads an external component library.

void	getExternalComponentLibNames (std::vector< HString > &rLibNames)
	Get the libNames of the currently loaded libs (the names compiled into libs)

void	getExternalLibraryContents (const char *libPath, std::vector< HString > &rComponents, std::vector< HString > &rNodes)
	Get the contents (components and nodes) registered by an external library.

void	getLibPathForComponentType (const HString &rTypeName, HString &rLibPath)
	Returns the path to the library file from where specified component is loaded.

ComponentSystem *	loadHMFModelFile (const char *filePath, double &rStartTime, double &rStopTime)
	This function is used to load a HMF file.

ComponentSystem *	loadHMFModel (const std::vector< unsigned char > xmlVector)

ComponentSystem *	loadHMFModel (const char *xmlString, double &rStartTime, double &rStopTime)
	This function is used to load a HMF model from a string.

SimulationHandler *	getSimulationHandler ()

Detailed Description

This class gives access to HopsanCore for model and externalLib loading as well as component creation and simulation.

Constructor & Destructor Documentation

◆ ~HopsanEssentials()

~HopsanEssentials ( )

HopsanEssentials Destructor.

Member Function Documentation

◆ checkMessage()

size_t checkMessage ( )

Check if there are any messages waiting in the queue.

Returns: The number of waiting messages

◆ createComponent()

Component * createComponent ( const HString & rTypeName )

Creates a component with the specified key-value and returns a pointer to this component.

Parameters

[in] rTypeName The unique type identifier of the component to create

<

◆ createComponentSystem()

ComponentSystem * createComponentSystem ( )

Creates a ComponentSystem.

Returns: A pointer to the ComponentSystem created

◆ createConditionalComponentSystem()

ConditionalComponentSystem * createConditionalComponentSystem ( )

Creates a ConditionalComponentSystem.

Returns: A pointer to the ComponentSystem created

◆ createNode()

Node * createNode ( const HString & rNodeType )

Creates a Node of given node type.

Parameters

[in] rNodeType The type of node to create

Returns: A pointer to the created node

◆ getExternalComponentLibNames()

void getExternalComponentLibNames ( std::vector< HString > & rLibNames )

Get the libNames of the currently loaded libs (the names compiled into libs)

Parameters

[out] rLibNames A reference to the vector that will contain the lib names

◆ getExternalLibraryContents()

void getExternalLibraryContents	(	const char *	libPath,
		std::vector< HString > &	rComponents,
		std::vector< HString > &	rNodes )

Get the contents (components and nodes) registered by an external library.

Parameters

[in]	libPath	Path to the external library
[out]	rComponents	A reference to the vector that will contain the component names
[out]	rNodes	A reference to the vector that will contain the node names

◆ getLibPathForComponentType()

void getLibPathForComponentType	(	const HString &	rTypeName,
		HString &	rLibPath )

Returns the path to the library file from where specified component is loaded.

Parameters

rTypeName	Type name of component
rLibPath	Reference string where path is stored

◆ getMessage()

void getMessage	(	HString &	rMessage,
		HString &	rType,
		HString &	rTag )

Get the message waiting on the message queue.

Parameters

[out]	rMessage	A reference to the message string
[out]	rType	A reference to the message type string
[out]	rTag	A reference to the message type Tag

◆ hasComponent()

bool hasComponent ( const HString & rType ) const

Check if a component with given typename exist in the ComponentFactory.

Parameters

[in] rType The typename to check

Returns: True or False depending on if type exist

◆ haveQuantity()

bool haveQuantity ( const HString & rQuantity ) const

Check if a quantity name is registered.

Parameters

[in] rQuantity The name of the quantity

Returns: true if the quantity is registered, else false

◆ isCore64Bit()

bool isCore64Bit ( ) const

Check if core is compiled 64-bit.

Returns: Returns true if core is compiled as 64-bit else returns false

◆ loadExternalComponentLib()

bool loadExternalComponentLib ( const char * path )

Loads an external component library.

Parameters

[in] path The path to the library DLL or SO file

Returns: True if loaded successfully, otherwise false

◆ loadHMFModel()

ComponentSystem * loadHMFModel	(	const char *	xmlString,
		double &	rStartTime,
		double &	rStopTime )

This function is used to load a HMF model from a string.

Parameters

[in]	xmlString	The model xml string
[out]	rStartTime	A reference to the starttime variable
[out]	rStopTime	A reference to the stoptime variable

Returns: A pointer to the root system of the loaded model

◆ loadHMFModelFile()

ComponentSystem * loadHMFModelFile	(	const char *	filePath,
		double &	rStartTime,
		double &	rStopTime )

This function is used to load a HMF file.

Parameters

[in]	filePath	The name (path) of the HMF file
[out]	rStartTime	A reference to the starttime variable
[out]	rStopTime	A reference to the stoptime variable

Returns: A pointer to the root system of the loaded model

◆ openCoreLogFile()

bool openCoreLogFile ( const char * absoluteFilePath )

Opens the HopsanCore runtime log file, if not already opened.

Parameters

[in] absoluteFilePath The file path of the log file

Returns: True if the file could be opened, else false

◆ removeComponent()

void removeComponent ( Component * pComponent )

◆ reserveComponentTypeName()

bool reserveComponentTypeName ( const HString & rTypeName )

Reserves a component TypeName in the component factory map.

Parameters

[in] rTypeName The TypeName to reserve

◆ unLoadExternalComponentLib()

bool unLoadExternalComponentLib ( const char * path )

Unloads an external component library.

Parameters

[in] path The path to the library DLL or SO file to unload

Returns: True if unloaded successfully, otherwise false

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~HopsanEssentials()

Member Function Documentation

◆ checkMessage()

◆ createComponent()

◆ createComponentSystem()

◆ createConditionalComponentSystem()

◆ createNode()

◆ getExternalComponentLibNames()

◆ getExternalLibraryContents()

◆ getLibPathForComponentType()

◆ getMessage()

◆ hasComponent()

◆ haveQuantity()

◆ isCore64Bit()

◆ loadExternalComponentLib()

◆ loadHMFModel()

◆ loadHMFModelFile()

◆ openCoreLogFile()

◆ removeComponent()

◆ reserveComponentTypeName()

◆ unLoadExternalComponentLib()