All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Notification CATSchRouteNotification
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATNotification
|
+---CATSchPlatformInterfaces.CATSchNotification
|
+---CATSchRouteNotification
Usage: you must use this class as is. You should never derive it.
public class CATSchRouteNotification
Schematic application routing notification.
Role: To assist the creation of a route.
Constructor and Destructor Index
- o
CATSchRouteNotification()
- Constructs an empty CATSchRouteNotification.
- o
~CATSchRouteNotification()
-
Method Index
- o
GetApplicationData(CATBaseUnknown**)
- Get the data to be sent along with the notification
Only the application needs to know the structure.
- o
GetFromToObjects(CATBaseUnknown**,CATBaseUnknown**,CATBoolean*)
- Get the From and To objects to be sent along with the notification.
- o
SetApplicationData(CATBaseUnknown*)
- Set the data to be sent along with the notification
Only the application needs to know the structure.
- o
SetFromToObjects(CATBaseUnknown*,CATBaseUnknown*,CATBoolean)
- Set the From and To objects to be sent along with the notification.
Constructor and Destructor
o CATSchRouteNotification
public CATSchRouteNotification( | ) |
-
Constructs an empty CATSchRouteNotification.
o ~CATSchRouteNotification
public virtual ~CATSchRouteNotification( | ) |
-
Methods
o GetApplicationData
-
Get the data to be sent along with the notification
Only the application needs to know the structure. The schematic platform
will have no need to try to interpret the data
- Parameters:
-
- oAppRouteData
- [out, CATBaseUnknown#Release] pointer to the information sent with the notification
calling routine needs to release the output pointer upon finish
using it. The caller must allocate memory for
the first level pointer (i.e. oAppData) and release the second level
pointer (i.e. *oAppData) after usage.
o GetFromToObjects
-
Get the From and To objects to be sent along with the notification.
The From and To objects will be used by the route command to
complete the route.
- Parameters:
-
- oFrom
- [out, CATBaseUnknown#Release] pointer to the object from which the route will start.
The calling routine must release the pointer when finished
using it.
- oTo
- [out, CATBaseUnknown#Release] pointer to the object to which the route will end.
The calling routine must release the pointer when finished
using it.
- oAutoRoute
- Specifies how the route command will perform the route.
If true, the route will be automatically performed. If false,
the route command will allow user interaction.
o SetApplicationData
-
Set the data to be sent along with the notification
Only the application needs to know the structure. The schematic platform
will have no need to try to interpret the data
- Parameters:
-
- iAppData
- pointer to the information to be sent with the notification
This method will add reference count to iAppData.
o SetFromToObjects
-
Set the From and To objects to be sent along with the notification.
The From and To objects will be used by the route command to
complete the route.
- Parameters:
-
- iFrom
- pointer to the object from which the route will start.
- iTo
- pointer to the object to which the route will end.
This method will add reference count to iFrom and iTo.
- iAutoRoute
- Specifies how the route command will perform the route.
If true, the route will be automatically performed. If false,
the route command will allow user interaction.
This object is included in the file: CATSchRouteNotification.h
If needed, your Imakefile.mk should include the module: CATSchItfCPP