Ofcas.Lk.Api.Client - Version 3.0  3.0.0.106
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234567]
 NOfcas
 NLk
 NApi
 NClient
 NCore
 NExceptions
 CApiExceptionAn internal exception.
 CServiceNotFoundExceptionOccurs if the host was not found.
 NInterfaces
 CICoreInfoThis is the base interface for object-related information
 CICoreInfoDeletableBasic interface for erasable objects, e.g. for an elevation (ElevationInfo).
 CICoreInfoReportableBasic class for reportable objects, e.g. for an elevation (ElevationInfo).
 CICoreInfoWithGuidRepresents a ICoreInfo with a globally unique identifier.
 CICoreInfoWithParentThis is the specialized base interface for object-related information

Template Parameters
TParentThe type of the parent of this object-related information.
 CICoreObjectRepresents a basic core object which lifetime is controlled by the creator.
 CICoreObjectWithChildrenRepresents a ICoreObject with children.
 CICoreObjectWithInfoRepresents a ICoreObject with an own info object.
 CICoreObjectWithParentRepresents a ICoreObject with a parent.
 CICoreObjectWithSynchronizationsRepresents a ICoreObject with a ISynchronizationContainer.
 CISynchronizationContainerUsed to retrieve ISynchronizedEvent and ISynchronizationContainer.
 CConnectedClientProvides information about a currently connected client.
 CCoreInfoThis is the base class for object-related information

Template Parameters
TParentThe type of the parent of this object-related information.
 CCoreObjectBaseCoreObjectBase is the base class for all objects and holds general data (for example, the object instance ID of the parent). Each object is assigned with a unique identification number (CoreObjectId)
 CCoreObjectFullyQualifiedRealisation of ICoreObjectWithChildren<TChild,TChildInfo>, ICoreObjectWithParent<TParent>, ICoreObjectWithInfo<TOwnInfo>.
 CCoreObjectWithChildrenRealisation of ICoreObjectWithChildren<TChild,TChildInfo>.
 CDisposableDisposable pattern helper class.
 CDocumentThe class Document is the represenation of a LogiKal document.
 CDocumentContainerDocumentContainer gives access to manage documents. Documents can be used in projects (Project).
 CDocumentInfoRepresents the metadata to a Document
 CElementTypeElementType represents an available element construction types. Available types can be received with the method LoginScope.GetAvailableElementTypes.
 CElevationElevation is the representation of a LogiKal element (for example, a window, a facade, ...). The children are of type ElevationInstance. The children can be received from the InfoList (CoreObject<T>.Infos).
 CElevationEditModeElevationEditMode represents an available edit mode for elevations. Available modes can be received with the method Elevation.GetAvailableElevationEditModes.
 CElevationInfoRepresents the metadata to a Elevation
 CElevationInstanceElevationInstance is the representation of an instance for an element (Elevation). An instance of an elavation has no children.
 CElevationInstanceInfoRepresents the metadata to a ElevationInstance.
 CExportSettingsDefines the settings for export.
 CGdzSettingsPlaceholder to configure getting gdz
 CGraphicSettingsSettings for methods with graphical returns such as thumbnails or drawings.
 CInfoListContainer
 CLoginScopeThe 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.
 COperationInfoContains information about an operation whether it can be called.
 CPhasePhase is the representation of a LogiKal phase. The children are of type Elevation. The children can be received from the InfoList (CoreObject<T>.Infos).
 CPhaseInfoRepresents a metadata object for a phase.
 CProgramInformation
 CProgramRuntimeProvides information about the program after a successful login. Information is created at runtime. Provides the possibility to adjust runtime data.
 CProjectProject is the representation of a LogiKal project. The children are of type Phase. The children can be received from the InfoList (CoreObject<T>.Infos).
 CProjectCenterProjectCenter is the representation of a LogiKal project-center. The children are of type Project. The children can be received from the InfoList (CoreObject<T>.Infos). Each ProjectCenter belongs to a fixed directory. To use another project directory, create a new project center using method GetProjectCenter.
 CProjectCenterInfoRepresents the metadata to a ProjectCenter
 CProjectDirectoryInfoRepresents the directory data to a ProjectCenter
 CProjectInfoRepresents the metadata to a Project
 CReportCategoryReportCategory represents a report category. The report items (ReportItem) are sorted in these categrories. Available reports can be received with the method Project.GetAvailableUserReports.
 CReportItemReportItem represents an available report. Available reports can be received with the method Project.GetAvailableUserReports.
 CSettings3DPlaceholder to configure getting 3D defintion from an Elevation
 NUi
 NInterfaces
 CIDialogResultSpecifies the result of a dialog with a result code.
 CElevationUiElevationUi is the representation of a LogiKal element (for example, a window, a facade, ...) and provides methods with user interaction. The children are of type ElevationInstance. The children can be received from the InfoList (CoreObject<T>.Infos).
 CLoginScopeUiThe LoginScopeUi is the the scope to interact with LogiKal via user interfaces. The LoginScopeUi can only be obtained by using the ServiceProxyBase. It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenterUi. The children can be received from the CoreObject<T>.Infos.
 CPhaseUiPhaseUi is the representation of a LogiKal phase and provides methods with user interactions. The children are of type ElevationUi. The children can be received from the InfoList (CoreObject<T>.Infos).
 CProjectCenterUiProjectCenterUi is the representation of a LogiKal project-center. The ProjectCenterUi provides methods with user interactions. The children are of type Project. The children can be received from the InfoList (CoreObject<T>.Infos). Each ProjectCenter project center belongs to a fixed directory. To use another project directory, create a new project center using method ProjectCenter.GetProjectCenter.
 CProjectUiProjectUi is the representation of a LogiKal project and provides methods with user interactions. The children are of type PhaseUi. The children can be received from the InfoList (CoreObject<T>.Infos).
 CServiceProxyServiceProxy is used to establish a connection to the service. The ServiceProxy ensures that the necessary service is started (Start). The service to be used is part of the LogiKal installation. After the start of the service the login takes place (Login). If a scope is completed, the service must be terminate with the method Stop. The ServiceProxy must be held during the lifetime of the scope.
 CServiceProxyBase
 NShared
 NDC
 NInterfaces
 CISynchronization
 CISynchronizationException
 CISynchronizedEventAn event that occurred asynchronously and was synchronized.
 CISynchronizedThread
 CLoginRunnableProgramRepresents a login-specific runnable program.
 CProjectAddressRepresents an address attached to a project
 CProjectRunnableProgramRepresents a project-specific runnable program.
 CRestriction
 CRunnableProgramRepresents a runnable program.
 CSegmentInfo
 CSurfaceData
 CSynchronization
 CSynchronizationException
 CSynchronizedEvent
 CSynchronizedThread