ProjectUi is the representation of a LogiKal project and provides methods with user interactions. The children are of type ElevationUi. The children can be received from the InfoList (CoreObject<T>.Infos). More...

Inheritance diagram for Ofcas.Lk.Api.Ui.ProjectUi:

Public Member Functions
	ProjectUi (IApiService apiService, Guid coreObjectId, ProjectCenterUi parent, ProjectInfo coreInfo)

void	Report (ReportItem reportItem, IList< ICoreInfoReportable > items, Dictionary< string, string > parameters)
	Creates a report according to the given report type via user interface. The report is generated for the passed elevations. If an empty list is passed, a report with all elevations of the project is automatically generated. More...

IList< ProjectRunnableProgram >	GetRunnablePrograms ()

OperationStatus	RunProgram (ProjectRunnableProgram program, Dictionary< string, object > optionalParameters=null)
	Runs the project program specified by the ProjectRunnableProgram. More...

ElevationInfo	RestoreElevation (ElevationInfo elevationInfo)
	Restore and return the corresponding elevationInfo based on the given information data. A UI window pops when the elevationInfo number of the deleted elevationInfo already exists or when a phase is required More...

new ElevationUi	GetElevation (ElevationInfo elevationInfo)
	Returns the corresponding elevation based on the given information data. More...

ElevationInfo	CreateLkElevation (string elevationName, ElementType elementType)
	Creates a new Elevation to the LogiKal projectvia user interface. More...

ElevationInfo	CopyElevationFrom (ElevationInfo sourceElevationInfo, string elevationName)
	Copies the specified elevation into the calling project. More...

void	ExportCncFiles (List< ElevationInfo > elevationInfos)
	Opens a user interface to export the given elevations as CNC files. More...

override ElevationInfo	ExecuteBasicOperation (ElevationInfo sourceInfo, BasicOperationItem basicOperation, IDictionary< string, object > parameters)

Public Member Functions inherited from Ofcas.Lk.Api.Core.Project
	Project (IApiService apiService, Guid coreObjectId, ProjectCenter parent, ProjectInfo coreInfo)

Elevation	GetElevation (ElevationInfo elevationInfo)
	Returns the corresponding elevation based on the given information data. More...

ElevationInfo	CreateLkElevation (string elevationName, ElementType elementType, string shortDescription, double amount, bool isAlternative)
	Creates a new Elevation to the LogiKal projectvia user interface. More...

void	DeleteLkElevation (ElevationInfo elevationInfo)
	Deletes the corresponding logikal elevation based on the given information data. More...

IList< ReportCategory >	GetAvailableUserReports ()
	Return all available reports. More...

string	GetNextPositionNumber (string phase="")
	Retrieves the next available position number of the stated phase. More...

ProjectInfo	SetParameter (string key, object value)
	Takes the parameter to update the project. More...

override ElevationInfo	ExecuteBasicOperation (ElevationInfo sourceInfo, BasicOperationItem basicOperation, IDictionary< string, object > parameters)

Protected Member Functions
override CoreObjectBase	GetElevationObject (Guid responseNewCoreObjectId, ElevationInfo elevationInfo)

override List< BasicOperationItem >	GetBasicOperationItems (ElevationInfo sourceInfo)

Protected Member Functions inherited from Ofcas.Lk.Api.Core.Project
ElevationInfo	GetElevationFromLkGuid (Guid lkElevationGuid)

override List< BasicOperationItem >	GetBasicOperationItems (ElevationInfo sourceInfo)

Detailed Description

ProjectUi is the representation of a LogiKal project and provides methods with user interactions. The children are of type ElevationUi. The children can be received from the InfoList (CoreObject<T>.Infos).

Member Function Documentation

◆ CopyElevationFrom()

ElevationInfo Ofcas.Lk.Api.Ui.ProjectUi.CopyElevationFrom	(	ElevationInfo	sourceElevationInfo,
		string	elevationName
	)

Copies the specified elevation into the calling project.

Parameters

sourceElevationInfo	The ElevationInfo of the elevation be copied.
elevationName	The name of the copied elevation.

Returns: The ElevationInfo of the copied elevation.

◆ CreateLkElevation()

ElevationInfo Ofcas.Lk.Api.Ui.ProjectUi.CreateLkElevation	(	string	elevationName,
		ElementType	elementType
	)

Creates a new Elevation to the LogiKal projectvia user interface.

Parameters

elevationName	The name of the new elevation
elementType	The type of the new elevation (ElementType)

Returns: The ElevationInfo to the created elevation or NULL if the user rejected the dialog.

Exceptions

Exception contains api error message

◆ ExportCncFiles()

void Ofcas.Lk.Api.Ui.ProjectUi.ExportCncFiles ( List< ElevationInfo > elevationInfos )

Opens a user interface to export the given elevations as CNC files.

Parameters

elevationInfos The list of elevations to be exported.

Exceptions

ApiException Occurs if the method fails.

◆ GetElevation()

new ElevationUi Ofcas.Lk.Api.Ui.ProjectUi.GetElevation ( ElevationInfo elevationInfo )

Returns the corresponding elevation based on the given information data.

Parameters

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

Returns: the Elevation

Exceptions

Exception If getting elevation failed.

◆ Report()

void Ofcas.Lk.Api.Ui.ProjectUi.Report	(	ReportItem	reportItem,
		IList< ICoreInfoReportable >	items,
		Dictionary< string, string >	parameters
	)

Creates a report according to the given report type via user interface. The report is generated for the passed elevations. If an empty list is passed, a report with all elevations of the project is automatically generated.

Parameters

reportItem	Defines the type of report. Report types can be received with Project.GetAvailableUserReports
items	List of elevations to be used for the report
parameters	A dictionary with parameters can be used to specify reports options. (Not supported)

◆ RestoreElevation()

ElevationInfo Ofcas.Lk.Api.Ui.ProjectUi.RestoreElevation ( ElevationInfo elevationInfo )

Restore and return the corresponding elevationInfo based on the given information data. A UI window pops when the elevationInfo number of the deleted elevationInfo already exists or when a phase is required

Parameters

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

Returns: ElevationInfo

Exceptions

Exception If restore elevation failed or the passed elevationInfo is not deleted

◆ RunProgram()

OperationStatus Ofcas.Lk.Api.Ui.ProjectUi.RunProgram	(	ProjectRunnableProgram	program,
		Dictionary< string, object >	optionalParameters = `null`
	)

Runs the project program specified by the ProjectRunnableProgram.

Parameters

program	The info object of the program to be run.
optionalParameters	The optional parameters for the program to be run.

OBJECTGUID: sets the object guid for special mode, value-type: Guid

PROGRAMMODE: sets the program mode for special mode, value-type: ProgramMode

Returns: Returns an OperationStatus for the running program.

Exceptions

ApiException Occurs if the method fails.

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

Ofcas.Lk.Api.Ui/ProjectUi.cs

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ CopyElevationFrom()

◆ CreateLkElevation()

◆ ExportCncFiles()

◆ GetElevation()

◆ Report()

◆ RestoreElevation()

◆ RunProgram()