class MAGES::DataContainerModule¶

Overview¶

The data container module base class. More…

class DataContainerModule: public MAGES::HubModule
{
public:
    // methods

    void SetSchema(string keyPattern, Type schemaType);
    void StoreData(string key, object value);
    object GetData(string key);
    Dictionary GetSchemaData(string keyPattern);
    void DeleteData(string key);
    void DeleteSchema(string keyPattern);
    List> GetSpecificSchemaData(string keyPattern);
    void DeleteSpecificSchemaData(string keyPattern);
    void ClearAllData();
};

// direct descendants

class MAGESDataContainer;
class StubDataContainer;

Inherited Members¶

public:
    // properties

    int Version;

    // methods

    void Startup();
    void Shutdown();
    virtual void UpdateModule(UpdatePhase updatePhase);

Detailed Documentation¶

The data container module base class.

Methods¶

void SetSchema(string keyPattern, Type schemaType)

Sets the schema for the data container.

Parameters:

keyPattern	The convention/pattern the Schema is created under, i.e mages.actions.* .
schemaType	The type of the Schema.

void StoreData(string key, object value)

Stores value in the data container under the given key.

Parameters:

key	The key of the data container.
value	The value to be stored.

object GetData(string key)

Get the data from the data container under the given key.

Parameters:

key	The given key.

Returns:

The value under the given key.

Dictionary GetSchemaData(string keyPattern)

Returns the schema data for the given key pattern.

Parameters:

keyPattern	The convention/pattern.

Returns:

A dictionary with the data of the whole Schema under the given convention/pattern.

void DeleteData(string key)

Deletes the data under the given key.

Parameters:

key	The key to be deleted.

void DeleteSchema(string keyPattern)

Deletes the schema under the given key pattern.

Parameters:

keyPattern	The convention/pattern of the schema to be deleted.

List> GetSpecificSchemaData(string keyPattern)

Returns the data of the schema under the given key pattern.

Parameters:

keyPattern	The key pattern of the data under the Schema.

Returns:

Returns a dictionary of the data that are stored under the given keyPattern.

void DeleteSpecificSchemaData(string keyPattern)

Deletes the data of the schema under the given key pattern.

Parameters:

keyPattern	The key pattern of the data under the Schema.

void ClearAllData()

Clears all data and all schemas.