DSIMessageManager Class Reference

This class manages the DSIXmlMessageReader*s that DSIMessageSource uses. More...

List of all members.

Public Member Functions

 DSIMessageManager (bool in_isConcatVendorString)
 Constructor.
void GetErrorMessage (const simba_string &in_locale, const simba_wstring &in_messageID, simba_int32 in_sourceComponentID, simba_wstring &out_message, simba_int32 &out_nativeErrCode)
 Retrieves the specified message with its associated error code.
void InvalidateCache ()
 Throw away all loaded messages, and reload them on further requests. Used when ERRORMESSAGESPATH changes.
void RegisterMessages (const simba_wstring &in_fileName, const std::vector< simba_int32 > &in_componentIDs)
 Registers the given error message file, along with its map of component ids to package names for management by this object.
void SetComponentName (simba_int32 in_componentID, const simba_wstring &in_componentName)
 Override the name used for a component.
void SetVendorName (const simba_wstring &in_vendorName)
 Sets the vendor name that will be prefixed to the beginning of all messages using the format [Vendor Name][Component Name]Message. If not set, the value will default to "Simba".
void SetVendorStringPrefixed (bool in_isConcatVendorString)
 Sets whether the MessageManager prefixes message strings with the vendor name.

Detailed Description

This class manages the DSIXmlMessageReader*s that DSIMessageSource uses.

It allows the DSIMessageSource to retrieve a message from a given locale.


Constructor & Destructor Documentation

DSIMessageManager ( bool  in_isConcatVendorString  )  [explicit]

Constructor.

Parameters:
in_isConcatVendorString Indicates whether the vendor string should be pre-pended to the message string. True if it should; false otherwise.

Member Function Documentation

void GetErrorMessage ( const simba_string &  in_locale,
const simba_wstring in_messageID,
simba_int32  in_sourceComponentID,
simba_wstring out_message,
simba_int32 &  out_nativeErrCode 
)

Retrieves the specified message with its associated error code.

Parameters:
in_locale The locale.
in_messageID Unique message identifier.
in_sourceComponentID Source component identifier.
out_message The message for the given message and component ID.
out_nativeErrCode The error code for the given message and component ID.
void InvalidateCache (  ) 

Throw away all loaded messages, and reload them on further requests. Used when ERRORMESSAGESPATH changes.

void RegisterMessages ( const simba_wstring in_fileName,
const std::vector< simba_int32 > &  in_componentIDs 
)

Registers the given error message file, along with its map of component ids to package names for management by this object.

Parameters:
in_fileName The filename of the error messages file.
in_componentIDs A list of component ids contained in the given file.
void SetComponentName ( simba_int32  in_componentID,
const simba_wstring in_componentName 
)

Override the name used for a component.

Parameters:
in_componentID The component ID for the component who's name to override.
in_componentName The new name for the component.
void SetVendorName ( const simba_wstring in_vendorName  ) 

Sets the vendor name that will be prefixed to the beginning of all messages using the format [Vendor Name][Component Name]Message. If not set, the value will default to "Simba".

Parameters:
in_vendorName Vendor name to use as a prefix.
void SetVendorStringPrefixed ( bool  in_isConcatVendorString  ) 

Sets whether the MessageManager prefixes message strings with the vendor name.

Parameters:
in_isConcatVendorString Whether to use the vendor name.

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

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba