All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Visualization Class CATVRManager

CATVRManager
 

Usage: you must use this class as is. You should never derive it.


public class CATVRManager

Class to provide global information on the devices management architecture.
Role : This class is the application interface for the management of devices.


Constructor and Destructor Index


o CATVRManager()
Construct a CATVRManager.
o ~CATVRManager()

Method Index


o FindEvent(CATUnicodeString,CATUnicodeString,int,CATBoolean&)
Finds a specific event matching given information.
o GetDeviceDriverList()
Return a list of ID number referring to each running device driver plugged onto the system.
o GetDeviceDriverName(int)
Return the name of the device driver referred to by the specified ID number.
o GetEventList(CATString&)
Return a list of all the events with the specified name the running device drivers plugged onto the system can generate.
o GetEventList(int)
Return a list of event the device driver can generate.

Constructor and Destructor


o CATVRManager
public CATVRManager()
Construct a CATVRManager. You may delete this object as soon as you made your calls.
o ~CATVRManager
public virtual ~CATVRManager()

Methods


o FindEvent
public CATVRDeviceEvent FindEvent(CATUnicodeString iDaemonName,
CATUnicodeString iEvent,
int iNumber,
CATBoolean& oOK)
Finds a specific event matching given information.
Parameters:
iDaemonName
The device driver name
iEvent
The event name
iNumber
The event number
oOK
set to TRUE if the event was found
Returns:
The corresponding CATVRDeviceEvent Return CATVRDeviceEvent(NULL) if no event was found
o GetDeviceDriverList
public CATListOfInt GetDeviceDriverList()
Return a list of ID number referring to each running device driver plugged onto the system.
o GetDeviceDriverName
public CATString GetDeviceDriverName( const int iDriverID)
Return the name of the device driver referred to by the specified ID number.
Parameters:
iDriverID
The device driver ID number.
Returns:
The name of the device driver. Return "" if no device driver has this ID number.
o GetEventList
public CATListOfCATVRDeviceEvent GetEventList( const CATString& iEventName)
Return a list of all the events with the specified name the running device drivers plugged onto the system can generate.
Parameters:
iEventName
The name of the events to retrieve.
Returns:
The list of all the available events with the specified name. Notice that this list is a list of VALUE.
o GetEventList
public CATListOfCATVRDeviceEvent GetEventList( const int iDriverID)
Return a list of event the device driver can generate.
Parameters:
iDriverID
The device driver ID.
See also:
CATVRManager.GetDeviceDriverList, CATVRDeviceEvent.GetDeviceDriverID
Returns:
The list of event the device driver can generate. Notice that it is a list of value.

This object is included in the file: CATVRManager.h
If needed, your Imakefile.mk should include the module: CATVisVR

Copyright © 2003, Dassault Systèmes. All rights reserved.