HIOConnector Class Reference

#include <HIOManager.h>

Public Member Functions
virtual void	AddConnection (HC_KEY key, void *pKernelEntity)
virtual void	AddConnection (HC_KEY key, void *pKernelEntity, HC_KEY modelKey)
virtual bool	GetHoopsEntities (void *pKernelEntity, vlist_s *ret_HoopsKeysList)
virtual bool	GetHoopsEntities (void *pKernelEntity, vlist_s *ret_HoopsKeysList, HC_KEY modelKey)
virtual HC_KEY	GetHoopsEntity (void *pKernelEntity)
virtual HC_KEY	GetHoopsEntity (void *pKernelEntity, HC_KEY modelKey)
virtual bool	GetKernelEntities (HC_KEY key, vlist_s *ret_KernelEntitiesList)
virtual bool	GetKernelEntities (HC_KEY key, vlist_s *ret_KernelEntitiesList, HC_KEY modelKey)
virtual void *	GetKernelEntity (HC_KEY key)
virtual void *	GetKernelEntity (HC_KEY key, HC_KEY modelKey)
virtual void	OptimizeTree (const char *segname, const char *option_string)

Protected Attributes
struct vhash_s *	mhash_Hoops2Kernel
	A hash map between HOOPS Keys and kernel entities.
struct vhash_s *	mhash_Kernel2Hoops
	A hash map between kernel entities and HOOPS Keys.

Detailed Description

HIOConnector manages the associativity between the HOOPS entity and the imported/exported entity. Each file import/export will result into on HIOConnector object if requested which can be used to query the mapping. In future, it is planned that this will replace the modeler bridges

Member Function Documentation

AddConnection()

virtual void HIOConnector::AddConnection ( HC_KEY  key, void *  pKernelEntity  )

virtual

This method adds an association between a HOOPS key and a kernel entity.

Parameters

key	The HC_KEY object to the HOOPS entity.
pKernalEntity	A void* to the associated kernel entity to be mapped to the the HOOPS key.

GetHoopsEntities()

virtual bool HIOConnector::GetHoopsEntities ( void *  pKernelEntity, vlist_s *  ret_HoopsKeysList  )

virtual

This method returns a list of all HOOPS entities (keys) associated with the given kernel entity.

Parameters

pKernelEntity	A void* to the kernel entity.
ret_HoopsKeysList	Returns a list of HOOPS HC_KEYS. Please pass a valid vlist pointer.

Returns

True if ret_HoopsKeysList could be populated.

GetHoopsEntity()

virtual HC_KEY HIOConnector::GetHoopsEntity ( void *  pKernelEntity )

virtual

This method gets the HOOPS entity or key associated with the given kernel entity. If there are multiple HOOPS entities associated the given kernel entity, this method will return the first one. In such case, it is recommended that you use GetHoopsEntities.

Parameters

pKernelEntity

A void* to the kernel entity.

Returns

The HC_KEY of the associated HOOPS entity.

GetKernelEntities()

virtual bool HIOConnector::GetKernelEntities ( HC_KEY  key, vlist_s *  ret_KernelEntitiesList  )

virtual

This method returns a list of all the kernel entities associated with the given HOOPS entity.

Parameters

key	The HC_KEY to the HOOPS entity.
ret_KernelEntitiesList	Returns a list of kernel entities as void*. Please pass a valid vlist pointer.

Returns

True if ret_KernelEntitiesList could be populated.

GetKernelEntity()

virtual void* HIOConnector::GetKernelEntity ( HC_KEY  key )

virtual

This method gets the kernel entity associated with the given HOOPS entity. If there are multiple kernel entities associated the given key, this method will return the first one. In such case, it is recommended that you use GetKernelEntities.

Parameters

key	The HC_KEY to the HOOPS entity associated with the kernel entity to search for.

Returns

A void* to the associated kernel entity.

OptimizeTree()

virtual void HIOConnector::OptimizeTree ( const char *  segname, const char *  option_string  )

virtual

This method calls #HC_Optimize_Segment_Tree on the given segment and updates the connections using #HC_Show_Optimized_Mapping.

Parameters

segname	The segment on which the optimization is to be performed.
option_string	A comma separated list of the desired settings as described in #HC_Optimize_Segment_Tree.

---

The documentation for this class was generated from the following file:

• HIOManager.h