SCENE C++ API  2.0.27
Public Member Functions | List of all members
LSProjectMetadata Class Reference

Interface to access metadata of FARO project formats. More...

#include <lsprojectmetadata.h>

+ Inheritance diagram for LSProjectMetadata:

Public Member Functions

LSString getPath () const
 Gets the file system path to the directory of this project. More...
 
LSString getUuid () const
 Returns the unique id of this project. More...
 
LSString getName () const
 Returns the name of this project. More...
 
LSString getType () const
 Returns the format type of this project. More...
 
- Public Member Functions inherited from LSAttributeContainer
LSString getTypeName () const
 Gets the type name of this instance. More...
 
LSString getName () const
 Gets the name of the container. More...
 
LSResult::Result setName (LSString name)
 Sets the name of the container. More...
 
LSString getUuid () const
 Returns the unique id of the container. More...
 
LSString assignUuid ()
 Assigns a unique id to the container if the container does not not yet have a unique id. More...
 
unsigned int getNumAttributes () const
 Get the number of attributes in the container. More...
 
LSString getAttributeName (unsigned int index) const
 Get the name of an attribute in the container. More...
 
unsigned int getAttributeIndex (LSString name) const
 Get the index of an attribute in the container. More...
 
LSAttribute getAttribute (unsigned int index) const
 Get an attribute based on its index. More...
 
LSAttribute getAttribute (LSString name) const
 Get an attribute based on its name. More...
 
LSResult::Result setAttribute (unsigned int index, const LSAttribute &attribute)
 Set an attribute based on its index. More...
 
LSResult::Result setAttribute (LSString name, const LSAttribute &attribute)
 Set an attribute based on its name. More...
 
LSResult::Result addCustomAttribute (LSString name, const LSAttribute &attribute)
 Add a new custom attribute to the container. More...
 
bool removeCustomAttribute (LSString name)
 Remove a custom attribute from the container. More...
 
unsigned int getNumFields () const
 Returns the number of fields in the container. More...
 
ref_ptr< LSAttributeContainergetField (unsigned int index) const
 Returns the field at position n in the container. More...
 
ref_ptr< LSAttributeContainergetField (const LSString &name) const
 Returns the field with the given name. More...
 
LSResult::Result addField (const LSString &name, const LSString &typeName, ref_ptr< LSAttributeContainer > &fieldOut)
 Add a field to the container. More...
 
bool rmField (const LSString &name)
 Removes the field with a given name from the container. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

Interface to access metadata of FARO project formats.

Version
SCENE API version 2.0.27.

Member Function Documentation

◆ getPath()

LSString getPath ( ) const

Gets the file system path to the directory of this project.

Version
SCENE API version 2.0.27.

◆ getUuid()

LSString getUuid ( ) const

Returns the unique id of this project.

The UUID is of the windows API GUID structure type (see guiddef.h)

Version
SCENE API version 2.0.27.

◆ getName()

LSString getName ( ) const

Returns the name of this project.

Version
SCENE API version 2.0.27.

◆ getType()

LSString getType ( ) const

Returns the format type of this project.

Currently the following project types are supported: 'lsproj' - SCENE Project Format 'raw' - SD card format pre V9 Focus 'lsdatav2' - SD card format introduced with V9 Focus

Version
SCENE API version 2.0.27.