PluginClassDefPLCB1 Class Reference

Search for all occurrences

#include <mxsPlugin.h>

Inheritance diagram for PluginClassDefPLCB1:

Public Member Functions
bool	isRegistered (ILoad *iload)
void	Register (ILoad *iload)
void	Unregister (ILoad *iload)
	PluginClassDefPLCB1 ()
int	Priority ()
void	proc (ILoad *iload)
Public Attributes
Tab< ILoad * >	registeredILoads

---

Constructor & Destructor Documentation

PluginClassDefPLCB1

(

)

[inline]

{ }

---

Member Function Documentation

bool isRegistered

(

ILoad *

iload

)

[inline]

Search for all occurrences

        {       int count = registeredILoads.Count();
                for (int i = 0; i< count; i++)
                        if (registeredILoads[i] == iload)
                                return true;
                return false;
        }

void Register

(

ILoad *

iload

)

[inline]

Search for all occurrences

        {       registeredILoads.Append(1,&iload);
        }

void Unregister

(

ILoad *

iload

)

[inline]

Search for all occurrences

        {       int count = registeredILoads.Count();
                for (int i = 0; i< count; i++)
                        if (registeredILoads[i] == iload)
                        {
                                registeredILoads.Delete(i,1);
                                return;
                        }
        }

int Priority

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method determines the order that the various registered callbacks execute. Lower priorities are run first-- allowable values {0..10}: 0 is reserved for ParamBlock2PLCB & ParamBlockPLCB. This method is overridden, for example, by the ParmBlock2 PostLoadCallbacks to return 1 so it can execute before the others.

Returns:

The allowable return values are 0 to 10, with 5 being the default. 0 is reserved for ParamBlock2PLCB and ParamBlockPLCB..

Default Implementation:

{ return 5; }

Note:

Custom Attributes are added to their owner objects in a Priority 6 PostLoadCall. Object Custom Attributes and object MetaData should be expected only in PostLoadCalls with a Priority of 7 or lower. Custom Attributes added in PostLoadCalls with a higher Priority may be replaced by the Priority 6 PostLoadCall. PostLoadCalls with a priority less than 0 will be treated as 0, greater than 10 will be treated as 10.

Reimplemented from PostLoadCallback.

{ return 5; }

void proc

(

ILoad *

iload

)

[inline, virtual]

Search for all occurrences

Remarks:

This method will be called when loading is complete.

Parameters:

iload

This class provides methods to load data from disk.

Implements PostLoadCallback.

        {
#ifdef _DEBUG
                if (dump_load_postload_callback_order) 
                        DebugPrint(_M("MXS: PostLoadCallback1 run: thePluginClassDefPLCB1\n"));
#endif
                MSPluginClass::post_load(iload,0);
                Unregister(iload);
        }

---

Member Data Documentation

Tab<ILoad*> registeredILoads

Search for all occurrences