Alphabetical Class Index   Compound Members   File List  

HMySelectionSet Class Reference

The MyHSelectionSet class manages a list of selected items. More...

#include <HMySelectionSet.h>

Public Member Functions

 HMySelectionSet (HBaseView *view, CDataLoader *dataloader)
 
virtual void Select (HC_KEY key, int num_include_keys, HC_KEY *include_keys, bool emit_message=true)
 
virtual void SelectDirect (HC_KEY key, int num_include_keys, HC_KEY *include_keys, bool emit_message=true)
 
void SetModelStructureFilter (char *filter)
 

Detailed Description

The MyHSelectionSet class manages a list of selected items.

HMySelectionSet is derived from HSelectionSet to handle key based selection with persistent identifiers

Constructor & Destructor Documentation

HMySelectionSet::HMySelectionSet ( HBaseView view,
CDataLoader dataloader 
)

Constructor

Parameters
viewPointer to HBaseView object
dataloaderPointer to dataloader object

Member Function Documentation

virtual void HMySelectionSet::Select ( HC_KEY  key,
int  num_include_keys,
HC_KEY include_keys,
bool  emit_message = true 
)
virtual

Selects an item by first trying to map the key to a persistent identifier

Parameters
keyThe key of the item to add.
num_include_keysThe number of include keys in the path upto the driver key
include_keysAn array of include keys
emit_messageIndicates that a message should be sent to the emit_message_function, which (if implemented) would typically use the HOOPS/Net 'Send' function to dispatch the message to clients
virtual void HMySelectionSet::SelectDirect ( HC_KEY  key,
int  num_include_keys,
HC_KEY include_keys,
bool  emit_message = true 
)
virtual

Calls the base class Select method

Parameters
keyThe key of the item to add.
num_include_keysThe number of include keys in the path upto the driver key
include_keysAn array of include keys
emit_messageIndicates that a message should be sent to the emit_message_function, which (if implemented) would typically use the HOOPS/Net 'Send' function to dispatch the message to clients
void HMySelectionSet::SetModelStructureFilter ( char *  filter)
inline

Sets the model structure filter used to filter selections

Parameters
filterModel Structure Filter to use for selections

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