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

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

Public Member Functions
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...

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

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

virtual List< ElevationInstanceInfo >	CreateChildren (int amount)
	Currently not supported in non-UI mode. More...

virtual void	DeleteElevationInstance (ElevationInstanceInfo elevationInstanceInfo)
	Currently not supported in non-UI mode. 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...

Public Attributes
DocumentContainer	Documents => _documentContainerManager.GetDocumentContainer()

Protected Member Functions
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
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

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

Member Function Documentation

◆ CanEdit()

override OperationInfo Ofcas.Lk.Api.Client.Core.Elevation.CanEdit	(	string	key,
		object	value
	)

virtual

Checks whether an elevation can be edited or not.

Parameters

key	The key of the value to be edited. See WellKnownEditKeys.Elevation for all available edit keys.
value	The value to be set.

Returns

Reimplemented from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Phase, ElevationInfo, ElevationInstance, ElevationInstanceInfo >.

◆ CreateChild()

override ElevationInstanceInfo Ofcas.Lk.Api.Client.Core.Elevation.CreateChild ( )

Checks whether CreateChild can be executed.

Returns: Returns an OperationInfo which indicates if CreateChild can be executed.

◆ CreateChildren()

virtual List<ElevationInstanceInfo> Ofcas.Lk.Api.Client.Core.Elevation.CreateChildren ( int amount )

virtual

Currently not supported in non-UI mode.

Exceptions

NotSupportedException

Reimplemented in Ofcas.Lk.Api.Client.Ui.ElevationUi.

◆ CreateElevationInstance()

virtual ElevationInstanceInfo Ofcas.Lk.Api.Client.Core.Elevation.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 in Ofcas.Lk.Api.Client.Ui.ElevationUi.

◆ DeleteElevationInstance()

virtual void Ofcas.Lk.Api.Client.Core.Elevation.DeleteElevationInstance ( ElevationInstanceInfo elevationInstanceInfo )

virtual

Currently not supported in non-UI mode.

Exceptions

NotSupportedException

Reimplemented in Ofcas.Lk.Api.Client.Ui.ElevationUi.

◆ Edit()

override ElevationInfo Ofcas.Lk.Api.Client.Core.Elevation.Edit	(	string	key,
		object	value
	)

virtual

Edits an elevation based on a key and a value.

Parameters

key	The key of the value to be edited. See WellKnownEditKeys.Elevation for all available edit keys.
value	The value to be set.

Returns: Returns an info object of the edited elevation.

Reimplemented from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Phase, ElevationInfo, ElevationInstance, ElevationInstanceInfo >.

◆ ElevationInstanceAmount()

int Ofcas.Lk.Api.Client.Core.Elevation.ElevationInstanceAmount ( )

Returns the amount of elevation instances.

Returns: Amount of elevation instances

◆ Get3D()

Stream Ofcas.Lk.Api.Client.Core.Elevation.Get3D ( Settings3D settings )

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

Parameters

settings unused

Returns: The content for the 3D definition is written in this stream. In case of the 3D definition is not available the length of the stream is zero.

Exceptions

ApiException Occurs if the method fails.

◆ GetAvailableElevationEditModes()

IList<ElevationEditMode> Ofcas.Lk.Api.Client.Core.Elevation.GetAvailableElevationEditModes ( )

Returns a list of all available ElevationEditMode for the current Elevation.

Returns: List with all available elevation edit modes

◆ GetDrawing()

Stream Ofcas.Lk.Api.Client.Core.Elevation.GetDrawing ( GraphicSettings settings )

Returns a drawing from the elevation. Use Format in GraphicSettings to specify the format of the drawing. Currently supported are:

DXF: Exports the File as dxf file

Use Parameters in GraphicSettings to specify the type and version of the drawing.

TYPE: Specify a ElevationDrawingType.

VERSION: Specify a DxfVersion if your export is a DXF drawing.

For section line drawings these parameters are needed:

STARTX: specifies the x-coordinate of the start position, value-type: double

STARTY: specifies the y-coordinate of the start position, value-type: double

ENDX: specifies the x-coordinate of the end position, value-type: double

ENDY: specifies the y-coordinate of the end position, value-type: double

WITHGLASS: specifies whether the section line shows the glass or not, value-type: bool

Parameters

settings The settings specifed for the drawing.

◆ GetElevationInstance()

ElevationInstance Ofcas.Lk.Api.Client.Core.Elevation.GetElevationInstance ( ElevationInstanceInfo elevationInstanceInfo )

Returns the corresponding elevation instance based on the given information data.

Parameters

elevationInstanceInfo The elevation instance information obtained through the CoreObject<T>.Infos function.

Returns: the ElevationInstance

Exceptions

Exception If getting elevation instance failed.

◆ GetGdz()

void Ofcas.Lk.Api.Client.Core.Elevation.GetGdz	(	Stream	target,
		GdzSettings	settings
	)

Returns the gdz stream (as a zip-stream).

Parameters

target	The gdz is written in this stream. If the elevation has no gdz, the lenght of target is zero.
settings	unused

◆ GetPartsList()

Stream Ofcas.Lk.Api.Client.Core.Elevation.GetPartsList ( )

Returns the parts list of this Elevation as a sqlite file.

Returns: The sqlite file of the parts list as a Stream.

Exceptions

ApiException Occurs if the method fails.

◆ GetThumbnail()

void Ofcas.Lk.Api.Client.Core.Elevation.GetThumbnail	(	Stream	target,
		GraphicSettings	settings
	)

An overview image from the elevation. The thumbnail will be returned as image file.

Parameters

target	The image file is written in this stream. If the elevation has no thumbnail, the lenght of target is zero.
settings	GraphicSettings.Format: defines the image format which will be returned "PNG", "JPG" or "EMF"

GraphicSettings.Parameters

Necessary parameters:

WIDTH: the width of the image in pixel

HEIGHT: the height of the image in pixel

Optional parameters:

SHOW_DIMENSIONS: TRUE or FALSE, enable or disable the output of dimensions

SHOW_DESCRIPTION: TRUE or FALSE, enable or disable the output of the description to the elevation

◆ SetParameter()

ElevationInfo Ofcas.Lk.Api.Client.Core.Elevation.SetParameter	(	string	key,
		object	value
	)

Takes the parameter to update the elevation.

Parameters

key	The parameter key. Available keys are:

ELEVATION_STATUS: ElevationStatus. Changes the elevation status.

ELEVATION_NAME: string. Changes the elevation name.

ELEVATION_CLOUDURN: string. Changes the elevation cloud urn.

Parameters

value The value for the parameter.

Returns: Returns the updated ElevationInfo.

Exceptions

Exception Occurs if any exception occured.

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

Core/src/Elevation.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CanEdit()

◆ CreateChild()

◆ CreateChildren()

◆ CreateElevationInstance()

◆ DeleteElevationInstance()

◆ Edit()

◆ ElevationInstanceAmount()

◆ Get3D()

◆ GetAvailableElevationEditModes()

◆ GetDrawing()

◆ GetElevationInstance()

◆ GetGdz()

◆ GetPartsList()

◆ GetThumbnail()

◆ SetParameter()