Ofcas.Lk.Api.Core.ProjectCenter Class Reference

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

Public Member Functions
	ProjectCenter (IApiService service, Guid coreObjectId, LoginScope parent, ProjectCenterInfo coreInfo, ProjectDirectoryInfo projectDirectoryInfo)
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...
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	ExecuteBasicOperation (ProjectInfo sourceInfo, BasicOperationItem basicOperation, IDictionary< string, object > parameters)

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

Protected Member Functions
override List< BasicOperationItem >	GetBasicOperationItems (ProjectInfo sourceInfo)

Properties
IList< ProjectDirectoryInfo >	ProjectDirectoryInfos [get]

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

CopyProjectFrom()

ProjectInfo Ofcas.Lk.Api.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

CreateDirectory()

ProjectDirectoryInfo Ofcas.Lk.Api.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.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

DeleteLkProject()

void Ofcas.Lk.Api.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.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.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)

MoveLkProjectFrom()

ProjectInfo Ofcas.Lk.Api.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.Core.ProjectCenter.OwnDirectoryInfo => _ownDirectoryInfo

Returns the directory info for the project-center

---

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

• Ofcas.Lk.Api.Core/ProjectCenter.cs