Bexel Manager API Documentation
Bexel.Api.ElementSource Class Reference

Represents a single source of Bexel.Api.Elements. More...

Inheritance diagram for Bexel.Api.ElementSource:
Bexel.Api.ApiObject IEquatable

Public Member Functions

bool Equals (ElementSource other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (ElementSource left, ElementSource right)
 
static bool operator!= (ElementSource left, ElementSource right)
 

Properties

override bool IsValid [get]
 
Project Project [get]
 Returns the project in which the element source resides. More...
 
ElementSourceID ID [get]
 Returns a unique identifier for the element source within a single project. More...
 
string Name [get]
 Returns the name of the element source. More...
 
string FilePath [get]
 Returns the path of the external resource (e.g. an IFC file) from which this element source is created. More...
 
ElementSourceElements Elements [get]
 Returns a collection of all elements that are contained within the element source. More...
 
ElementSourceProperties Properties [get]
 Returns a collection of all properties that are contained within the element source. More...
 
- Properties inherited from Bexel.Api.ApiObject
abstract bool IsValid [get]
 Indicates if the API object is valid or not. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Bexel.Api.ApiObject
virtual void CheckValidity ()
 

Detailed Description

Represents a single source of Bexel.Api.Elements.

Sources are generated from external resources such as IFC files while creating or updating a Bexel.Api.Project. One Bexel.Api.Project may contain multiple sources.

Property Documentation

◆ Elements

ElementSourceElements Bexel.Api.ElementSource.Elements
get

Returns a collection of all elements that are contained within the element source.

◆ FilePath

string Bexel.Api.ElementSource.FilePath
get

Returns the path of the external resource (e.g. an IFC file) from which this element source is created.

◆ ID

ElementSourceID Bexel.Api.ElementSource.ID
get

Returns a unique identifier for the element source within a single project.

◆ Name

string Bexel.Api.ElementSource.Name
get

Returns the name of the element source.

◆ Project

Project Bexel.Api.ElementSource.Project
get

Returns the project in which the element source resides.

◆ Properties

ElementSourceProperties Bexel.Api.ElementSource.Properties
get

Returns a collection of all properties that are contained within the element source.