ProjectCenter 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. More...

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

Public Member Functions

Project GetProject (ProjectInfo projectInfo)

Returns the corresponding project based on the given information data. More...

ProjectCenter GetProjectCenter (ProjectDirectoryInfo projectDirectoryInfo)

Creates a new ProjectCenter for the given directory. Each ProjectCenter belongs to a fixed directory. More...

override OperationInfo CanCreateChild ()

Checks whether a project can be created or not. More...

override ProjectInfo CreateChild ()

Creates a new project with a default name. Call Project.Edit with WellKnownEditKeys.Project.Name to change the name after the creation. More...

override OperationInfo CanDeleteChild (ProjectInfo projectInfo)

Checks whether a project can be deleted or not. More...

override void DeleteChild (ProjectInfo projectInfo)

Deletes a project based on an info object. More...

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

override ProjectInfo MoveFrom (ICoreInfo coreInfo)

Moves an object into this directory based on an info object. More...

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

override ProjectInfo CopyFrom (ICoreInfo coreInfo)

Copies an object into this directory based on an info object. More...

ProjectInfo CreateLkProject (string projectName)

Creates a new Project in the LogiKal project structure. The project will be created in the current active directory. More...

void DeleteLkProject (ProjectInfo projectInfo)

Deletes the corresponding logikal project based on the given information data. More...

ProjectInfo MoveLkProjectFrom (ProjectInfo projectInfo, string newProjectName)

Moves a project to this project center based on the given project info and the new project name. More...

ProjectInfo CopyProjectFrom (ProjectInfo projectInfo, string newProjectName)

Copies a project and its elevations. More...

Elevation GetElevationFromLkId (Guid lkElevGuid)

Exceptions

NotSupportedException

ElevationInstance GetElevationInstanceFromLkId (Guid lkElevInstanceGuid)

Exceptions

NotSupportedException

ProjectDirectoryInfo CreateDirectory (string directoryName)

Creates a new directory in the current project center. More...

override ProjectInfo RefreshChild (ProjectInfo childInfo)

override Project GetChild (ProjectInfo childInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< LoginScope, ProjectCenterInfo, Project, ProjectInfo >

TOwnInfo Refresh ()

virtual OperationInfo CanEdit (string key, object value)

virtual TOwnInfo Edit (string key, object value)

Public Attributes
ProjectDirectoryInfo	OwnDirectoryInfo => _ownDirectoryInfo
	Returns the directory info for the project-center More...

Protected Member Functions
override CoreInfoResponse	GetInfoResponse ()

virtual Project	CreateNewInstance (Guid coreObjectId, ProjectInfo childInfo)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< LoginScope, ProjectCenterInfo, Project, ProjectInfo >
	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
IList< ProjectDirectoryInfo >	ProjectDirectoryInfos `[get]`

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< LoginScope, ProjectCenterInfo, Project, ProjectInfo >
TParent	Parent `[get]`

TOwnInfo	CoreInfo `[get, protected set]`

TOwnInfo	Info `[get, protected set]`

Detailed Description

ProjectCenter 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.

Member Function Documentation

◆ CanCreateChild()

override OperationInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.CanCreateChild ( )

Checks whether a project can be created or not.

Returns

◆ CanDeleteChild()

override OperationInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.CanDeleteChild ( ProjectInfo projectInfo )

Checks whether a project can be deleted or not.

Parameters

projectInfo The info of the project to be deleted.

Returns

◆ CopyFrom()

override ProjectInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.CopyFrom ( ICoreInfo coreInfo )

Copies an object into this directory based on an info object.

Parameters

coreInfo The info of the object to be copied.

Returns: Returns an info object of the copied / created project.

◆ CopyProjectFrom()

ProjectInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.CopyProjectFrom	(	ProjectInfo	projectInfo,
		string	newProjectName
	)

Copies a project and its elevations.

Parameters

projectInfo	The info of the project to copy.
newProjectName	The new project name of the copy. If no name is defined the name from the given projectInfo will be used

Returns: The ProjectInfo to the created project

Exceptions

Exception contains api error message

◆ CreateChild()

override ProjectInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.CreateChild ( )

Creates a new project with a default name. Call Project.Edit with WellKnownEditKeys.Project.Name to change the name after the creation.

Returns: Returns an info object of the created project.

◆ CreateDirectory()

ProjectDirectoryInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.CreateDirectory ( string directoryName )

Creates a new directory in the current project center.

Parameters

directoryName The name of the directory to be created.

Returns: Returns the ProjectDirectoryInfo for the directory.

Exceptions

ArgumentNullException	Occurs if the directory name is null or empty.
InvalidOperationException	Occurs if the directory could not be found after refresh.
NotSupportedException	Occurs if the directory could not be found after refresh.

◆ CreateLkProject()

ProjectInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.CreateLkProject ( string projectName )

Creates a new Project in the LogiKal project structure. The project will be created in the current active directory.

Parameters

projectName The name of the new project

Returns: The ProjectInfo to the created project

Exceptions

Exception contains api error message

◆ DeleteChild()

override void Ofcas.Lk.Api.Client.Core.ProjectCenter.DeleteChild ( ProjectInfo projectInfo )

Deletes a project based on an info object.

Parameters

projectInfo Returns an info of the project to be deleted.

◆ DeleteLkProject()

void Ofcas.Lk.Api.Client.Core.ProjectCenter.DeleteLkProject ( ProjectInfo projectInfo )

Deletes the corresponding logikal project based on the given information data.

Parameters

projectInfo The project information

◆ GetProject()

Project Ofcas.Lk.Api.Client.Core.ProjectCenter.GetProject ( ProjectInfo projectInfo )

Returns the corresponding project based on the given information data.

Parameters

projectInfo The project information obtained through the CoreObject<T>.Infos function.

Returns: the Project

Exceptions

Exception If getting elevation failed.

◆ GetProjectCenter()

ProjectCenter Ofcas.Lk.Api.Client.Core.ProjectCenter.GetProjectCenter ( ProjectDirectoryInfo projectDirectoryInfo )

Creates a new ProjectCenter for the given directory. Each ProjectCenter belongs to a fixed directory.

Parameters

projectDirectoryInfo The project directory to use

Returns: The new ProjectCenter

Exceptions

Exception if creating project-center failed (for example invalid directory)

◆ MoveFrom()

override ProjectInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.MoveFrom ( ICoreInfo coreInfo )

Moves an object into this directory based on an info object.

Parameters

coreInfo The info of the object to be moved.

Returns: Returns an info object of the moved / created project.

◆ MoveLkProjectFrom()

ProjectInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.MoveLkProjectFrom	(	ProjectInfo	projectInfo,
		string	newProjectName
	)

Moves a project to this project center based on the given project info and the new project name.

Parameters

projectInfo	The information of the project.
newProjectName	The name for the moved project.

Returns: Returns the new project info.

Member Data Documentation

◆ OwnDirectoryInfo

ProjectDirectoryInfo Ofcas.Lk.Api.Client.Core.ProjectCenter.OwnDirectoryInfo => _ownDirectoryInfo

Returns the directory info for the project-center

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

Core/src/ProjectCenter.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CanCreateChild()

◆ CanDeleteChild()

◆ CopyFrom()

◆ CopyProjectFrom()

◆ CreateChild()

◆ CreateDirectory()

◆ CreateLkProject()

◆ DeleteChild()

◆ DeleteLkProject()

◆ GetProject()

◆ GetProjectCenter()

◆ MoveFrom()

◆ MoveLkProjectFrom()

Member Data Documentation

◆ OwnDirectoryInfo