The LoginScope is the the scope to interact with LogiKal. The LoginScope can only be received by valid connection to a service (LoginScopeFactoryBase<T>.Login). It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenter. The children can be received from the CoreObject<T>.Infos. More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.LoginScope:

Public Member Functions
	LoginScope (IApiService apiService, Guid coreObjectId, TimeSpan synchronizeInternal)

ProgramInformation	GetProgramInformation ()

ProgramRuntime	GetProgramRuntime ()
	Retrieves a ProgramRuntime of the current LoginScope. More...

IList< LoginRunnableProgram >	GetRunnablePrograms ()
	Retrieves a list of available LoginRunnablePrograms. More...

ProjectCenter	GetProjectCenter (ProjectCenterInfo projectCenterInfo)
	Returns the corresponding project-center based on the given information data. Available project-center type are defined in ProjectType. More...

override ProjectCenter	GetChild (ProjectCenterInfo childInfo)

ProjectCenter	GetProjectCenter (ProjectCenterInfo childInfo, ProjectInfo projectInfo)
	Gets a ProjectCenter based on a ProjectCenterInfo and a ProjectInfo. More...

ProjectCenter	GetStandardProjectCenter ()
	Returns the standard project-center. The standard project-center is from type ProjectType.Project. More...

IList< ElementType >	GetAvailableElementTypes ()
	Returns a list of all available ElementType for the current LoginScope. More...

override ProjectCenterInfo	RefreshChild (ProjectCenterInfo childInfo)

string	GetTranslation (string text, int firstIndex, int secondIndex, params string[] parameters)
	Translates a given text to the language which the API is currently running. More...

IList< ProjectInfo >	GetRecentProjectInfos ()
	Obtains the ProjectInfo of the recently opened projects. More...

bool	IsExportNeeded (DatabaseExportType databaseExportType)
	Checks whether the export is needed or not. More...

Stream	GetExport (ExportSettings exportSettings)
	Gets an export stream for the stated export settings. Use ExportSettings.Format in ExportSettings to specify the format of the export. Currently supported are: More...

double	GetGlassPrice (Dictionary< string, object > parameters)
	Gets a glass price based on the stated parameters. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >
void	DisposeChild (ICoreObject coreObject)

bool	IsParentOf (ICoreObject coreObject)

abstract TChildInfo	RefreshChild (TChildInfo childInfo)

void	RefreshChildren ()

virtual TChild	GetChild (TChildInfo childInfo)

virtual OperationInfo	CanCreateChild ()

virtual TChildInfo	CreateChild ()

virtual OperationInfo	CanDeleteChild (TChildInfo childInfo)

virtual void	DeleteChild (TChildInfo childInfo)

virtual OperationInfo	CanMoveFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	MoveFrom (ICoreInfo coreInfo)

virtual OperationInfo	CanCopyFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	CopyFrom (ICoreInfo coreInfo)

void	RefreshInfos ()

Protected Member Functions
override CoreInfoResponse	GetInfoResponse ()
	Gets the info response from service. More...

virtual ProjectCenter	CreateNewInstance (Guid coreObjectId, ProjectCenterInfo projectCenterInfo, ProjectDirectoryInfo projectDirectoryInfo)

override void	Dispose (bool disposing)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >
	CoreObjectWithChildren (IApiService apiService, Guid coreObjectId)

TChildInfo	RefreshChild (Predicate< TChildInfo > predicate)
	Refreshes all infos and returns the appropriate info. More...

Additional Inherited Members
Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >
IList< TChildInfo >	Infos

IList< TChildInfo >	ChildrenInfos

Detailed Description

The LoginScope is the the scope to interact with LogiKal. The LoginScope can only be received by valid connection to a service (LoginScopeFactoryBase<T>.Login). It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenter. The children can be received from the CoreObject<T>.Infos.

Member Function Documentation

◆ GetAvailableElementTypes()

IList<ElementType> Ofcas.Lk.Api.Client.Core.LoginScope.GetAvailableElementTypes ( )

Returns a list of all available ElementType for the current LoginScope.

Returns: List with all available element types

◆ GetExport()

Stream Ofcas.Lk.Api.Client.Core.LoginScope.GetExport ( ExportSettings exportSettings )

Gets an export stream for the stated export settings. Use ExportSettings.Format in ExportSettings to specify the format of the export. Currently supported are:

MDB: exports the stream as MDB file

XML: exports the stream as XML file

Use ExportSettings.Parameters in ExportSettings to specify additional parameters of the exports. For ExportType.Database these parameters are needed:

DATABASE_EXPORT_TYPE: specifies the type of the database export (value-type: DatabaseExportType)

Parameters

exportSettings The settings for the export.

Returns: Returns the export as a read-only Stream.

◆ GetGlassPrice()

double Ofcas.Lk.Api.Client.Core.LoginScope.GetGlassPrice ( Dictionary< string, object > parameters )

Gets a glass price based on the stated parameters.

Parameters

parameters GLASSNAME: specifies the name of the glass (value-type: string) GLASSTYPE: specifies the type of the glass (value-type: GlassType) WIDTH: specifies the width of the glass (value-type: double) HEIGHT: specifies the height of the glass (value-type: double) THICKNESS: specifies the thickness of the glass (value-type: int) GLASSORIGIN: specifies the origin of the glass (value-type: GlassOrigin) PROJECTGUID (with GlassOrigin.Project): specifies the project origin of the glass (value-type: Guid) SPECIALINSIDE (optional): specifies the special inside (value-type: string) SPECIALOUTSIDE (optional): specifies the special outside (value-type: string) MODELTYPE (optional): specifies the model type of the glass (value-type: int)

Returns: Returns the glass price calculated.

◆ GetInfoResponse()

override CoreInfoResponse Ofcas.Lk.Api.Client.Core.LoginScope.GetInfoResponse ( )

protectedvirtual

Gets the info response from service.

Returns: Return the CoreInfoResponse.

Implements Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >.

◆ GetProgramRuntime()

ProgramRuntime Ofcas.Lk.Api.Client.Core.LoginScope.GetProgramRuntime ( )

Retrieves a ProgramRuntime of the current LoginScope.

Returns: Returns a ProgramRuntime of the current LoginScope.

◆ GetProjectCenter() [1/2]

ProjectCenter Ofcas.Lk.Api.Client.Core.LoginScope.GetProjectCenter ( ProjectCenterInfo projectCenterInfo )

Returns the corresponding project-center based on the given information data. Available project-center type are defined in ProjectType.

Parameters

projectCenterInfo The project-center information obtained through the CoreObject<T>.Infos function.

Returns: the ProjectCenter

Exceptions

Exception If getting project-center failed.

◆ GetProjectCenter() [2/2]

ProjectCenter Ofcas.Lk.Api.Client.Core.LoginScope.GetProjectCenter	(	ProjectCenterInfo	childInfo,
		ProjectInfo	projectInfo
	)

Gets a ProjectCenter based on a ProjectCenterInfo and a ProjectInfo.

Parameters

childInfo	The stated ProjectCenterInfo.
projectInfo	The stated ProjectInfo.

Returns: Returns a ProjectCenter based on the stated arguments.

◆ GetRecentProjectInfos()

IList<ProjectInfo> Ofcas.Lk.Api.Client.Core.LoginScope.GetRecentProjectInfos ( )

Obtains the ProjectInfo of the recently opened projects.

Returns: Returns a list of ProjectInfo objects of the recently opened projects.

◆ GetRunnablePrograms()

IList<LoginRunnableProgram> Ofcas.Lk.Api.Client.Core.LoginScope.GetRunnablePrograms ( )

Retrieves a list of available LoginRunnablePrograms.

Returns: Returns a a list of available LoginRunnablePrograms.

◆ GetStandardProjectCenter()

ProjectCenter Ofcas.Lk.Api.Client.Core.LoginScope.GetStandardProjectCenter ( )

Returns the standard project-center. The standard project-center is from type ProjectType.Project.

Returns: the ProjectCenter from type ProjectType.Project

Exceptions

Exception	If getting project-center failed.
NotImplementedException

◆ GetTranslation()

string Ofcas.Lk.Api.Client.Core.LoginScope.GetTranslation	(	string	text,
		int	firstIndex,
		int	secondIndex,
		params string []	parameters
	)

Translates a given text to the language which the API is currently running.

Parameters

text	The specified text to be translated.
firstIndex	The first index used to determine the translation text.
secondIndex	The second index used to determine the translation text.
parameters	Optional parameters to replace placeholders in the text to be translated. The maximum count is five.

Returns: Returns the translated text.

◆ IsExportNeeded()

bool Ofcas.Lk.Api.Client.Core.LoginScope.IsExportNeeded ( DatabaseExportType databaseExportType )

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAvailableElementTypes()

◆ GetExport()

◆ GetGlassPrice()

◆ GetInfoResponse()

◆ GetProgramRuntime()

◆ GetProjectCenter() [1/2]

◆ GetProjectCenter() [2/2]

◆ GetRecentProjectInfos()

◆ GetRunnablePrograms()

◆ GetStandardProjectCenter()

◆ GetTranslation()

◆ IsExportNeeded()