WSF
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Static Protected Attributes | List of all members
WsfL16::Messages::Factory Class Reference

The JMessageFactory is a static class for creating JMessages. More...

#include <MessagesFactory.hpp>

Classes

struct  MessageInfo

Public Types

typedef std::map< int, MessageInfo > MessageMap

Public Member Functions

 Factory ()
 ~Factory ()

Static Public Member Functions

static void Initialize (UtScriptTypes *aScriptTypes)
static void ResetState ()
static std::vector< InitialBase * > ReadMessage (const unsigned char *aData)
 Read a JMessage from a short *.
static std::vector< InitialBase * > ReadMessage (MessageBitInput &aInput, int aNumJ_Words=-1)
 Read a JMessage from a MessageBitInput.
static InitialBase * CreateInitialWord (int aLabel, int aSublabel)
 Create a new JMessageI with the specified label and sub-label.
static InitialBase * CreateFullMessage (int aLabel, int aSublabel)
 Create a new Initial message with all implemented sub-words.
static ContinuationBase * CreateContinuationWord (InitialBase *aParent, int continuationLabel)
 Create a new continuation word, and put it in the initial word aParent.
static ExtensionBase * CreateExtensionWord (InitialBase *aParent, int extensionWordIndex)
 Create a new extension word, and put it in the initial word aParent.
static MessageScriptClass * GetMessageScriptClass (int aLabel, int aSubLabel)
static const MessageMap & GetMessages ()

Static Protected Member Functions

static void InitializeAccessors ()
static void LoadMessageAccessors (Messages::InitialBase *aMessage)
static void LoadWordAccessors (Messages::Base *aWord)
static InitialBase * NewMessage (int aLabel, int aSubLabel)
static void RegisterScriptClasses (UtScriptTypes &aTypes)
static void AddMessage (Messages::InitialBase *aMessage)

Static Protected Attributes

static MessageMap mMessages
static std::set< int > mUnhandledJMessages

Detailed Description

The JMessageFactory is a static class for creating JMessages.

Member Typedef Documentation

◆ MessageMap

typedef std::map<int, MessageInfo> WsfL16::Messages::Factory::MessageMap

Constructor & Destructor Documentation

◆ Factory()

WsfL16::Messages::Factory::Factory ( )

◆ ~Factory()

WsfL16::Messages::Factory::~Factory ( )

References CreateContinuationWord(), CreateExtensionWord(), CreateFullMessage(), CreateInitialWord(), GetMessageScriptClass(), Initialize(), ReadMessage(), and ResetState().

Member Function Documentation

◆ AddMessage()

void WsfL16::Messages::Factory::AddMessage ( Messages::InitialBase * aMessage)
staticprotected

References WsfL16::Messages::Factory::MessageInfo::mMessagePtr, mMessages, and WsfL16::Messages::Factory::MessageInfo::mScriptClass.

Referenced by Initialize().

◆ CreateContinuationWord()

ContinuationBase * WsfL16::Messages::Factory::CreateContinuationWord ( InitialBase * aParent,
int continuationLabel )
static

Create a new continuation word, and put it in the initial word aParent.

References WsfL16::Messages::InitialBase::AddContinuationWord().

Referenced by ~Factory().

◆ CreateExtensionWord()

ExtensionBase * WsfL16::Messages::Factory::CreateExtensionWord ( InitialBase * aParent,
int extensionWordIndex )
static

Create a new extension word, and put it in the initial word aParent.

References WsfL16::Messages::InitialBase::AddExtensionWord().

Referenced by ~Factory().

◆ CreateFullMessage()

InitialBase * WsfL16::Messages::Factory::CreateFullMessage ( int aLabel,
int aSublabel )
static

Create a new Initial message with all implemented sub-words.

References WsfL16::Messages::InitialBase::AddContinuationWord(), WsfL16::Messages::InitialBase::AddExtensionWord(), and NewMessage().

Referenced by InitializeAccessors(), and ~Factory().

◆ CreateInitialWord()

InitialBase * WsfL16::Messages::Factory::CreateInitialWord ( int aLabel,
int aSublabel )
static

Create a new JMessageI with the specified label and sub-label.

References NewMessage().

Referenced by ~Factory().

◆ GetMessages()

const MessageMap & WsfL16::Messages::Factory::GetMessages ( )
inlinestatic

References mMessages.

Referenced by InitializeAccessors().

◆ GetMessageScriptClass()

MessageScriptClass * WsfL16::Messages::Factory::GetMessageScriptClass ( int aLabel,
int aSubLabel )
static

References mMessages.

Referenced by ~Factory().

◆ Initialize()

void WsfL16::Messages::Factory::Initialize ( UtScriptTypes * aScriptTypes)
static

References AddMessage(), InitializeAccessors(), and RegisterScriptClasses().

Referenced by ~Factory().

◆ InitializeAccessors()

void WsfL16::Messages::Factory::InitializeAccessors ( )
staticprotected

References CreateFullMessage(), GetMessages(), and LoadMessageAccessors().

Referenced by Initialize().

◆ LoadMessageAccessors()

void WsfL16::Messages::Factory::LoadMessageAccessors ( Messages::InitialBase * aMessage)
staticprotected

References LoadWordAccessors().

Referenced by InitializeAccessors().

◆ LoadWordAccessors()

void WsfL16::Messages::Factory::LoadWordAccessors ( Messages::Base * aWord)
staticprotected

References WsfL16::Messages::MessageAccessorFiller::ProcessMessage().

Referenced by LoadMessageAccessors().

◆ NewMessage()

InitialBase * WsfL16::Messages::Factory::NewMessage ( int aLabel,
int aSubLabel )
staticprotected

References mMessages.

Referenced by CreateFullMessage(), CreateInitialWord(), and ReadMessage().

◆ ReadMessage() [1/2]

std::vector< InitialBase * > WsfL16::Messages::Factory::ReadMessage ( const unsigned char * aData)
static

Read a JMessage from a short *.

References ReadMessage().

Referenced by ReadMessage(), and ~Factory().

◆ ReadMessage() [2/2]

std::vector< InitialBase * > WsfL16::Messages::Factory::ReadMessage ( MessageBitInput & aInput,
int aNumJ_Words = -1 )
static

Read a JMessage from a MessageBitInput.

References WsfL16::Messages::InitialBase::AddContinuationWord(), WsfL16::Messages::InitialBase::AddExtensionWord(), WsfL16::Messages::Base::cCONTINUATION, WsfL16::Messages::Base::cEXTENSION, WsfL16::Messages::Base::cINITIAL, WsfL16::Messages::InitialBase::GetHeader(), WsfL16::Messages::InitialBase::GetMessageLength(), mUnhandledJMessages, NewMessage(), ok, WsfL16::Messages::MessageBitInput::Read(), WsfL16::Messages::MessageBitInput::Skip(), and WsfL16::Messages::Base::TransferI().

◆ RegisterScriptClasses()

void WsfL16::Messages::Factory::RegisterScriptClasses ( UtScriptTypes & aTypes)
staticprotected

References WsfL16::Messages::Factory::MessageInfo::mClassName, WsfL16::Messages::Factory::MessageInfo::mMessagePtr, mMessages, and WsfL16::Messages::Factory::MessageInfo::mScriptClass.

Referenced by Initialize().

◆ ResetState()

void WsfL16::Messages::Factory::ResetState ( )
static

References mMessages, and mUnhandledJMessages.

Referenced by ~Factory().

Member Data Documentation

◆ mMessages

std::map< int, Factory::MessageInfo > WsfL16::Messages::Factory::mMessages
staticprotected

Referenced by AddMessage(), GetMessages(), GetMessageScriptClass(), NewMessage(), RegisterScriptClasses(), and ResetState().

◆ mUnhandledJMessages

std::set< int > WsfL16::Messages::Factory::mUnhandledJMessages
staticprotected

Referenced by ReadMessage(), and ResetState().

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved