HIOConnector

Detailed Description

class HIOConnector

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

Public Functions

HIOConnector()
virtual ~HIOConnector()
virtual HC_KEY GetHoopsEntity(void *pKernelEntity)

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.
virtual HC_KEY GetHoopsEntity(void *pKernelEntity, HC_KEY modelKey)
virtual void *GetKernelEntity(HC_KEY key)

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.
virtual void *GetKernelEntity(HC_KEY key, HC_KEY modelKey)
virtual bool GetHoopsEntities(void *pKernelEntity, vlist_s *ret_HoopsKeysList)

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.

virtual bool GetHoopsEntities(void *pKernelEntity, vlist_s *ret_HoopsKeysList, HC_KEY modelKey)
virtual bool GetKernelEntities(HC_KEY key, vlist_s *ret_KernelEntitiesList)

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.

virtual bool GetKernelEntities(HC_KEY key, vlist_s *ret_KernelEntitiesList, HC_KEY modelKey)
virtual void AddConnection(HC_KEY key, void *pKernelEntity)

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.
virtual void AddConnection(HC_KEY key, void *pKernelEntity, HC_KEY modelKey)
virtual void OptimizeTree(char const *segname, char const *option_string)

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.