ElevationUi 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). More...

Inheritance diagram for Ofcas.Lk.Api.Client.Ui.ElevationUi:

Public Member Functions
ElevationInfo	Edit (ElevationEditMode elevationEditMode)
	Starts editing the elevation via user interface More...

ElevationInfo	Import3D (Stream content)
	Imports a 3D definition to the current Elevation. Available formats are specified in "Public API Documentation" (Confluence). Importing 3d data is only allowed for empty created elevations (ElevationInfo.State). More...

ElevationInfo	Set3D (Stream content)
	Sets a 3D definition to the current Elevation. Available formats are specified in "Public API Documentation" (Confluence). Setting 3D data is only allowed for empty created elevations (ElevationInfo.State). More...

ElevationInfo	Setup2D (Stream content)
	Setup the Elevation with a 2D definition. For example this method can be used to setup the grid of the Elevation. Available formats are specified in "Public API Documentation" (Confluence). Setup 2D data is only allowed for empty created elevations (ElevationInfo.State). More...

async Task< ElevationInfo >	EditAsync (ElevationEditMode elevationEditMode)
	Asynchronously starts the editing of the elevation via user interface. More...

override ElevationInstanceInfo	CreateElevationInstance ()
	Creates a new ElevationInstance to this Elevation. More...

override OperationInfo	CanCreateChild ()
	Checks whether an ElevationInstance can be created or not. More...

override ElevationInstanceInfo	CreateChild ()
	Creates a new ElevationInstance to this Elevation. More...

override List< ElevationInstanceInfo >	CreateChildren (int amount)
	Creates an amount of new ElevationInstance to this Elevation. More...

override void	DeleteElevationInstance (ElevationInstanceInfo elevationInstanceInfo)
	Deletes an existing ElevationInstance from this Elevation. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Elevation
override OperationInfo	CanEdit (string key, object value)
	Checks whether an elevation can be edited or not. More...

override ElevationInfo	Edit (string key, object value)
	Edits an elevation based on a key and a value. More...

ElevationInstance	GetElevationInstance (ElevationInstanceInfo elevationInstanceInfo)
	Returns the corresponding elevation instance based on the given information data. More...

override ElevationInstanceInfo	CreateChild ()
	Checks whether CreateChild can be executed. More...

void	GetThumbnail (Stream target, GraphicSettings settings)
	An overview image from the elevation. The thumbnail will be returned as image file. More...

Stream	GetDrawing (GraphicSettings settings)
	Returns a drawing from the elevation. Use Format in GraphicSettings to specify the format of the drawing. Currently supported are: More...

void	GetGdz (Stream target, GdzSettings settings)
	Returns the gdz stream (as a zip-stream). More...

Stream	Get3D (Settings3D settings)
	Returns the 3D definition from the current Elevation. Available formats are specified in "Public API Documentation" (Confluence). More...

Stream	GetPartsList ()
	Returns the parts list of this Elevation as a sqlite file. More...

IList< ElevationEditMode >	GetAvailableElevationEditModes ()
	Returns a list of all available ElevationEditMode for the current Elevation. More...

int	ElevationInstanceAmount ()
	Returns the amount of elevation instances. More...

ElevationInfo	SetParameter (string key, object value)
	Takes the parameter to update the elevation. More...

override ElevationInstanceInfo	RefreshChild (ElevationInstanceInfo elevationInstanceInfo)

override ElevationInstance	GetChild (ElevationInstanceInfo childInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Phase, ElevationInfo, ElevationInstance, ElevationInstanceInfo >
TOwnInfo	Refresh ()

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
bool	CanDispose ()
	Checks whether the ICoreInfo can be disposed. More...

Additional Inherited Members
Public Attributes inherited from Ofcas.Lk.Api.Client.Core.Elevation
DocumentContainer	Documents => _documentContainerManager.GetDocumentContainer()

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.Elevation
override CoreInfoResponse	GetInfoResponse ()

virtual ElevationInstance	CreateNewInstance (Guid coreObjectId, ElevationInstanceInfo elevationInstanceInfo)

ElevationInfo	HandleElevationOperationStatusResponse (OperationStatusResponse response, string information)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Phase, ElevationInfo, ElevationInstance, ElevationInstanceInfo >
	CoreObjectFullyQualified (IApiService apiService, Guid coreObjectId, TParent parent, TOwnInfo ownInfo)
	Creates a new instance of CoreObjectFullyQualified<TParent,TOwnInfo,TChild,TChildInfo> with the given parameters. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Elevation
ISynchronizationContainer	SynchronizationContainer `[get]`

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Phase, ElevationInfo, ElevationInstance, ElevationInstanceInfo >
TParent	Parent `[get]`

TOwnInfo	CoreInfo `[get, protected set]`

TOwnInfo	Info `[get, protected set]`

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithSynchronizations
ISynchronizationContainer	SynchronizationContainer `[get]`
	The ISynchronizationContainer of this ICoreObject. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid	CoreObjectId `[get]`
	The unique identifier of this core object. More...

Detailed Description

ElevationUi 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).

Member Function Documentation

◆ CanCreateChild()

override OperationInfo Ofcas.Lk.Api.Client.Ui.ElevationUi.CanCreateChild ( )

Checks whether an ElevationInstance can be created or not.

Returns

◆ CreateChild()

override ElevationInstanceInfo Ofcas.Lk.Api.Client.Ui.ElevationUi.CreateChild ( )

Creates a new ElevationInstance to this Elevation.

Returns: The ElevationInstanceInfo to the created elevation instance.

Exceptions

ApiException Occurs if the method fails.

◆ CreateChildren()

override List<ElevationInstanceInfo> Ofcas.Lk.Api.Client.Ui.ElevationUi.CreateChildren ( int amount )

virtual

Creates an amount of new ElevationInstance to this Elevation.

Returns: The list of created elevation instances.

Exceptions

ApiException Occurs if the method fails.

Reimplemented from Ofcas.Lk.Api.Client.Core.Elevation.

◆ CreateElevationInstance()

override ElevationInstanceInfo Ofcas.Lk.Api.Client.Ui.ElevationUi.CreateElevationInstance ( )

virtual

Creates a new ElevationInstance to this Elevation.

Returns: The ElevationInstanceInfo to the created elevation instance

Exceptions

ApiException Occurs if the method fails.

Reimplemented from Ofcas.Lk.Api.Client.Core.Elevation.

◆ DeleteElevationInstance()

override void Ofcas.Lk.Api.Client.Ui.ElevationUi.DeleteElevationInstance ( ElevationInstanceInfo elevationInstanceInfo )

virtual

Deletes an existing ElevationInstance from this Elevation.

Parameters

elevationInstanceInfo

Reimplemented from Ofcas.Lk.Api.Client.Core.Elevation.

◆ Edit()

ElevationInfo Ofcas.Lk.Api.Client.Ui.ElevationUi.Edit ( ElevationEditMode elevationEditMode )

Starts editing the elevation via user interface

Parameters

elevationEditMode Possible modes to edit can be received with Elevation.GetAvailableElevationEditModes

Returns: the edited elevation as ElevationInfo

◆ EditAsync()

async Task<ElevationInfo> Ofcas.Lk.Api.Client.Ui.ElevationUi.EditAsync ( ElevationEditMode elevationEditMode )

Asynchronously starts the editing of the elevation via user interface.

Parameters

elevationEditMode Possible modes to edit can be received with Elevation.GetAvailableElevationEditModes

Returns

◆ Import3D()

ElevationInfo Ofcas.Lk.Api.Client.Ui.ElevationUi.Import3D ( Stream content )

Imports a 3D definition to the current Elevation. Available formats are specified in "Public API Documentation" (Confluence). Importing 3d data is only allowed for empty created elevations (ElevationInfo.State).

Parameters

content the content to import

Returns: the imported elevation data as ElevationInfo

◆ Set3D()

ElevationInfo Ofcas.Lk.Api.Client.Ui.ElevationUi.Set3D ( Stream content )

Sets a 3D definition to the current Elevation. Available formats are specified in "Public API Documentation" (Confluence). Setting 3D data is only allowed for empty created elevations (ElevationInfo.State).

Parameters

content the content to set

Returns: the new elevation data as ElevationInfo

◆ Setup2D()

ElevationInfo Ofcas.Lk.Api.Client.Ui.ElevationUi.Setup2D ( Stream content )

Setup the Elevation with a 2D definition. For example this method can be used to setup the grid of the Elevation. Available formats are specified in "Public API Documentation" (Confluence). Setup 2D data is only allowed for empty created elevations (ElevationInfo.State).

Parameters

content the content to setup

Returns: the current elevation data as ElevationInfo

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

Ui/src/ElevationUi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanCreateChild()

◆ CreateChild()

◆ CreateChildren()

◆ CreateElevationInstance()

◆ DeleteElevationInstance()

◆ Edit()

◆ EditAsync()

◆ Import3D()

◆ Set3D()

◆ Setup2D()