Altium C++ SDK 3.0
Loading...
Searching...
No Matches
CServerModule Class Referenceabstract

#include <DXP.Classes.h>

Inheritance diagram for CServerModule:
DXP::CAbstractServerModule CAbstractSupportService CDispatchObject IServicesSupportInternal CDispatchRecord

Public Member Functions

 CServerModule (IClient *const AClient, const wstring AName)
virtual ~CServerModule ()
virtual void Initialize ()
IServerOptions * GetIServerOptions ()
DXP::IServerSecurity * GetIServerSecurity ()
Public Member Functions inherited from DXP::CAbstractServerModule
IServerModule * GetIServerModule ()
Public Member Functions inherited from CAbstractSupportService
virtual HRESULT __stdcall QueryInterface (const IID &riid, void **ppvObject)
virtual ULONG __stdcall AddRef (void)
virtual ULONG __stdcall Release (void)
IServicesSupportInternal * GetServicesSupportInternal ()
Public Member Functions inherited from CDispatchObject
 CDispatchObject ()
virtual ~CDispatchObject ()
IDispatch * GetIDispatch ()
Public Member Functions inherited from CDispatchRecord
 CDispatchRecord ()
virtual HRESULT __stdcall GetTypeInfoCount (UINT *pctinfo)
virtual HRESULT __stdcall GetTypeInfo (UINT iTInfo, LCID lcid, ITypeInfo **ppTInfo)
virtual HRESULT __stdcall GetIDsOfNames (REFIID riid, LPOLESTR *rgszNames, UINT cNames, LCID lcid, DISPID *rgDispId)

Protected Member Functions

virtual bool SupportsService (std::wstring const AServiceName)
void RegisterOptionsPageCreator (const wstring OptionsPageName, pCreateOptionsPage PageCreator)
void CheckTechnologySets ()
virtual void CreateCommandLauncher ()
virtual void CreateProcessControl ()
virtual void InitializeCommands ()
virtual void RegisterOptionsPages ()
virtual void CreateServerViews ()
virtual void AddView (IServerView *const AView)
virtual IServerDocument * NewDocumentInstance (const wstring AKind, const wstring AFileNameWide)=0
virtual IServerDocument * NewDocumentInstanceShowOrHide (const wstring AKind, const wstring AFileName, bool AShowInTree)
virtual HRESULT __stdcall Invoke (DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS *pDispParams, VARIANT *pVarResult, EXCEPINFO *pExcepInfo, UINT *puArgErr)
virtual void ApplicationIdle ()
virtual void ReceiveNotification (INotification *const ANotification)
virtual IServerDocument * CreateDocument (const wstring AKind, const wstring AFileName)
virtual IServerDocument * CreateDocumentShowOrHide (const wstring AKind, const wstring AFileName, bool AShowInTree)
virtual void DestroyDocument (IServerDocument *const ADocument)
virtual IClient * GetClient ()
virtual ICommandLauncher * GetCommandLauncher ()
virtual int GetDocumentCount ()
virtual IServerDocument * GetDocuments (int Index)
virtual long GetHandle ()
virtual wstring GetModuleName ()
virtual IProcessControl * GetProcessControl ()
virtual int GetViewCount ()
virtual IServerView * GetViews (int Index)
virtual IDocumentOptionsView * CreateOptionsView (const wstring AName)
virtual IServerView * CreateServerView (const wstring AName)
virtual void RemoveServerView (IServerView *const AView)
virtual void AddServerView (IServerView *const AView)
virtual IServerDocumentView * CreateServerDocView (const wstring AName, IServerDocument *const ADocument)
virtual IOptionsPage * CreateOptionsPageByName (const wstring OptionsPageName)
virtual void FlushOptions ()
virtual void ReloadOptions ()
virtual bool IsTechnologySetSupported (const wstring ATechnologySet)
Protected Member Functions inherited from DXP::CAbstractServerModule
virtual IServerDocument * CreateDocument (std::wstring const AKind, std::wstring const AFileName)=0
virtual IDocumentOptionsView * CreateOptionsView (std::wstring const AName)=0
virtual IServerView * CreateServerView (std::wstring const AName)=0
virtual IServerDocumentView * CreateServerDocView (std::wstring const AName, IServerDocument *const ADocument)=0
virtual IServerDocument * CreateDocumentShowOrHide (std::wstring const AKind, std::wstring const AFileName, bool AShowInTree)=0

Protected Attributes

ICommandLauncherPtr mCommandLauncherIntf
CCommandLauncher * mCommandLauncher
IProcessControlPtr mProcessControlIntf
vector< wstring > mTechnologySets
long mLicenseInfoValidAt
Protected Attributes inherited from CDispatchRecord
ULONG mRefCount

Private Types

typedef COptionsPage *(* pCreateOptionsPage) ()
typedef std::map< wstring, pCreateOptionsPage, CInsensitiveCompare > OptionsPagesMap

Private Attributes

std::wstring mName
std::vector< IServerDocument * > mDocuments
std::vector< IServerView * > mServerViews
OptionsPagesMap mOptionsPages

Member Typedef Documentation

◆ OptionsPagesMap

typedef std::map<wstring, pCreateOptionsPage, CInsensitiveCompare> CServerModule::OptionsPagesMap
private

◆ pCreateOptionsPage

typedef COptionsPage *(* CServerModule::pCreateOptionsPage) ()
private

Constructor & Destructor Documentation

◆ CServerModule()

CServerModule::CServerModule ( IClient *const AClient,
const wstring AName )

◆ ~CServerModule()

virtual CServerModule::~CServerModule ( )
virtual

Member Function Documentation

◆ AddServerView()

virtual void CServerModule::AddServerView ( IServerView *const AView)
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ AddView()

virtual void CServerModule::AddView ( IServerView *const AView)
protectedvirtual

◆ ApplicationIdle()

virtual void CServerModule::ApplicationIdle ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ CheckTechnologySets()

void CServerModule::CheckTechnologySets ( )
protected

◆ CreateCommandLauncher()

virtual void CServerModule::CreateCommandLauncher ( )
protectedvirtual

◆ CreateDocument()

virtual IServerDocument * CServerModule::CreateDocument ( const wstring AKind,
const wstring AFileName )
protectedvirtual

◆ CreateDocumentShowOrHide()

virtual IServerDocument * CServerModule::CreateDocumentShowOrHide ( const wstring AKind,
const wstring AFileName,
bool AShowInTree )
protectedvirtual

◆ CreateOptionsPageByName()

virtual IOptionsPage * CServerModule::CreateOptionsPageByName ( const wstring OptionsPageName)
protectedvirtual

◆ CreateOptionsView()

virtual IDocumentOptionsView * CServerModule::CreateOptionsView ( const wstring AName)
protectedvirtual

◆ CreateProcessControl()

virtual void CServerModule::CreateProcessControl ( )
protectedvirtual

◆ CreateServerDocView()

virtual IServerDocumentView * CServerModule::CreateServerDocView ( const wstring AName,
IServerDocument *const ADocument )
protectedvirtual

◆ CreateServerView()

virtual IServerView * CServerModule::CreateServerView ( const wstring AName)
protectedvirtual

◆ CreateServerViews()

virtual void CServerModule::CreateServerViews ( )
protectedvirtual

◆ DestroyDocument()

virtual void CServerModule::DestroyDocument ( IServerDocument *const ADocument)
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ FlushOptions()

virtual void CServerModule::FlushOptions ( )
protectedvirtual

◆ GetClient()

virtual IClient * CServerModule::GetClient ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetCommandLauncher()

virtual ICommandLauncher * CServerModule::GetCommandLauncher ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetDocumentCount()

virtual int CServerModule::GetDocumentCount ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetDocuments()

virtual IServerDocument * CServerModule::GetDocuments ( int Index)
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetHandle()

virtual long CServerModule::GetHandle ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetIServerOptions()

IServerOptions * CServerModule::GetIServerOptions ( )
inline

◆ GetIServerSecurity()

DXP::IServerSecurity * CServerModule::GetIServerSecurity ( )
inline

◆ GetModuleName()

virtual wstring CServerModule::GetModuleName ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetProcessControl()

virtual IProcessControl * CServerModule::GetProcessControl ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetViewCount()

virtual int CServerModule::GetViewCount ( )
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ GetViews()

virtual IServerView * CServerModule::GetViews ( int Index)
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ Initialize()

virtual void CServerModule::Initialize ( )
virtual

◆ InitializeCommands()

virtual void CServerModule::InitializeCommands ( )
protectedvirtual

◆ Invoke()

virtual HRESULT __stdcall CServerModule::Invoke ( DISPID dispIdMember,
REFIID riid,
LCID lcid,
WORD wFlags,
DISPPARAMS * pDispParams,
VARIANT * pVarResult,
EXCEPINFO * pExcepInfo,
UINT * puArgErr )
protectedvirtual

Reimplemented from DXP::CAbstractServerModule.

◆ IsTechnologySetSupported()

virtual bool CServerModule::IsTechnologySetSupported ( const wstring ATechnologySet)
protectedvirtual

◆ NewDocumentInstance()

virtual IServerDocument * CServerModule::NewDocumentInstance ( const wstring AKind,
const wstring AFileNameWide )
protectedpure virtual

◆ NewDocumentInstanceShowOrHide()

virtual IServerDocument * CServerModule::NewDocumentInstanceShowOrHide ( const wstring AKind,
const wstring AFileName,
bool AShowInTree )
protectedvirtual

◆ ReceiveNotification()

virtual void CServerModule::ReceiveNotification ( INotification *const ANotification)
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ RegisterOptionsPageCreator()

void CServerModule::RegisterOptionsPageCreator ( const wstring OptionsPageName,
pCreateOptionsPage PageCreator )
protected

◆ RegisterOptionsPages()

virtual void CServerModule::RegisterOptionsPages ( )
protectedvirtual

◆ ReloadOptions()

virtual void CServerModule::ReloadOptions ( )
protectedvirtual

◆ RemoveServerView()

virtual void CServerModule::RemoveServerView ( IServerView *const AView)
protectedvirtual

Implements DXP::CAbstractServerModule.

◆ SupportsService()

virtual bool CServerModule::SupportsService ( std::wstring const AServiceName)
protectedvirtual

Reimplemented from DXP::CAbstractServerModule.

Member Data Documentation

◆ mCommandLauncher

CCommandLauncher* CServerModule::mCommandLauncher
protected

◆ mCommandLauncherIntf

ICommandLauncherPtr CServerModule::mCommandLauncherIntf
protected

◆ mDocuments

std::vector<IServerDocument *> CServerModule::mDocuments
private

◆ mLicenseInfoValidAt

long CServerModule::mLicenseInfoValidAt
protected

◆ mName

std::wstring CServerModule::mName
private

◆ mOptionsPages

OptionsPagesMap CServerModule::mOptionsPages
private

◆ mProcessControlIntf

IProcessControlPtr CServerModule::mProcessControlIntf
protected

◆ mServerViews

std::vector<IServerView *> CServerModule::mServerViews
private

◆ mTechnologySets

vector<wstring> CServerModule::mTechnologySets
protected
The documentation for this class was generated from the following file: