OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ot::ModelServiceAPI Class Reference

#include "ModelServiceAPI.h"

Inheritance diagram for ot::ModelServiceAPI:
ot::components::ModelComponent

Public Member Functions

 ModelServiceAPI (const std::string &thisServiceURL, const std::string &modelServiceURL)
 
 ModelServiceAPI ()
 
std::string getCurrentModelVersion (void)
 
EntityBase * readEntityFromEntityIDandVersion (UID _entityID, UID _version, ClassFactoryHandler &classFactory)
 
UID getCurrentVisualizationModelID (void)
 
std::list< std::string > getListOfFolderItems (const std::string &_folder, bool recursive=false)
 
void getAvailableMeshes (std::string &_meshFolderName, UID &_meshFolderID, std::string &_meshName, UID &_meshID)
 
std::list< UID > getIDsOfFolderItemsOfType (const std::string &_folder, const std::string &_entityClassName, bool recursive)
 
void enableMessageQueueing (bool flag)
 
void modelChangeOperationCompleted (const std::string &description)
 
void addEntitiesToModel (std::list< UID > &_topologyEntityIDList, std::list< UID > &_topologyEntityVersionList, std::list< bool > &_topologyEntityForceVisible, std::list< UID > &_dataEntityIDList, std::list< UID > &_dataEntityVersionList, std::list< UID > &_dataEntityParentList, const std::string &_changeComment, bool askForBranchCreation=true, bool saveModel=true)
 
void addEntitiesToModel (std::list< UID > &&_topologyEntityIDList, std::list< UID > &&_topologyEntityVersionList, std::list< bool > &&_topologyEntityForceVisible, std::list< UID > &&_dataEntityIDList, std::list< UID > &&_dataEntityVersionList, std::list< UID > &&_dataEntityParentList, const std::string &_changeComment, bool askForBranchCreation=true, bool saveModel=true)
 
void addGeometryOperation (UID _newEntityID, UID _newEntityVersion, std::string _newEntityName, std::list< UID > &_dataEntityIDList, std::list< UID > &_dataEntityVersionList, std::list< UID > &_dataEntityParentList, std::list< std::string > &_childrenList, const std::string &_changeComment)
 
void deleteEntitiesFromModel (std::list< std::string > &_entityNameList, bool _saveModel=true)
 
void getEntityInformation (const std::list< UID > &_entities, std::list< EntityInformation > &_entityInfo)
 
void getEntityInformation (const std::list< std::string > &_entities, std::list< EntityInformation > &_entityInfo)
 
bool getEntityInformation (const std::string &_entity, EntityInformation &_entityInfo)
 
void getEntityChildInformation (const std::string &_entity, std::list< EntityInformation > &_entityInfo, bool recursive)
 
void getEntityChildInformation (UID _entity, std::list< EntityInformation > &_entityInfo, bool recursive)
 
void getSelectedEntityInformation (std::list< EntityInformation > &_entityInfo, const std::string &typeFilter="")
 
void addPropertiesToEntities (std::list< UID > &_entityList, const ot::PropertyGridCfg &_configuration)
 
void getEntityProperties (UID _entity, bool _recursive, const std::string &_propertyGroupFilter, std::map< UID, EntityProperties > &_entityProperties)
 
void getEntityProperties (const std::string &entityName, bool _recursive, const std::string &_propertyGroupFilter, std::map< UID, EntityProperties > &_entityProperties)
 
void updatePropertyGrid ()
 
void updateTopologyEntities (ot::UIDList &topologyEntityIDs, ot::UIDList &topologyEntityVersions, const std::string &comment)
 

Protected Member Functions

virtual const std::string & getModelServiceURL ()
 
virtual const std::string & getThisServiceURL ()
 

Protected Attributes

std::string m_modelServiceURL
 
std::string m_thisServiceURL
 

Constructor & Destructor Documentation

◆ ModelServiceAPI() [1/2]

ot::ModelServiceAPI::ModelServiceAPI ( const std::string & thisServiceURL,
const std::string & modelServiceURL )
inline

◆ ModelServiceAPI() [2/2]

ot::ModelServiceAPI::ModelServiceAPI ( )
inline

Member Function Documentation

◆ addEntitiesToModel() [1/2]

void ot::ModelServiceAPI::addEntitiesToModel ( std::list< UID > && _topologyEntityIDList,
std::list< UID > && _topologyEntityVersionList,
std::list< bool > && _topologyEntityForceVisible,
std::list< UID > && _dataEntityIDList,
std::list< UID > && _dataEntityVersionList,
std::list< UID > && _dataEntityParentList,
const std::string & _changeComment,
bool askForBranchCreation = true,
bool saveModel = true )

◆ addEntitiesToModel() [2/2]

void ot::ModelServiceAPI::addEntitiesToModel ( std::list< UID > & _topologyEntityIDList,
std::list< UID > & _topologyEntityVersionList,
std::list< bool > & _topologyEntityForceVisible,
std::list< UID > & _dataEntityIDList,
std::list< UID > & _dataEntityVersionList,
std::list< UID > & _dataEntityParentList,
const std::string & _changeComment,
bool askForBranchCreation = true,
bool saveModel = true )

◆ addGeometryOperation()

void ot::ModelServiceAPI::addGeometryOperation ( UID _newEntityID,
UID _newEntityVersion,
std::string _newEntityName,
std::list< UID > & _dataEntityIDList,
std::list< UID > & _dataEntityVersionList,
std::list< UID > & _dataEntityParentList,
std::list< std::string > & _childrenList,
const std::string & _changeComment )

◆ addPropertiesToEntities()

void ot::ModelServiceAPI::addPropertiesToEntities ( std::list< UID > & _entityList,
const ot::PropertyGridCfg & _configuration )

◆ deleteEntitiesFromModel()

void ot::ModelServiceAPI::deleteEntitiesFromModel ( std::list< std::string > & _entityNameList,
bool _saveModel = true )

◆ enableMessageQueueing()

void ot::ModelServiceAPI::enableMessageQueueing ( bool flag)

◆ getAvailableMeshes()

void ot::ModelServiceAPI::getAvailableMeshes ( std::string & _meshFolderName,
UID & _meshFolderID,
std::string & _meshName,
UID & _meshID )

◆ getCurrentModelVersion()

std::string ot::ModelServiceAPI::getCurrentModelVersion ( void )

◆ getCurrentVisualizationModelID()

ot::UID ot::ModelServiceAPI::getCurrentVisualizationModelID ( void )

◆ getEntityChildInformation() [1/2]

void ot::ModelServiceAPI::getEntityChildInformation ( const std::string & _entity,
std::list< EntityInformation > & _entityInfo,
bool recursive )

◆ getEntityChildInformation() [2/2]

void ot::ModelServiceAPI::getEntityChildInformation ( UID _entity,
std::list< EntityInformation > & _entityInfo,
bool recursive )

◆ getEntityInformation() [1/3]

void ot::ModelServiceAPI::getEntityInformation ( const std::list< std::string > & _entities,
std::list< EntityInformation > & _entityInfo )

◆ getEntityInformation() [2/3]

void ot::ModelServiceAPI::getEntityInformation ( const std::list< UID > & _entities,
std::list< EntityInformation > & _entityInfo )

◆ getEntityInformation() [3/3]

bool ot::ModelServiceAPI::getEntityInformation ( const std::string & _entity,
EntityInformation & _entityInfo )

◆ getEntityProperties() [1/2]

void ot::ModelServiceAPI::getEntityProperties ( const std::string & entityName,
bool _recursive,
const std::string & _propertyGroupFilter,
std::map< UID, EntityProperties > & _entityProperties )

◆ getEntityProperties() [2/2]

void ot::ModelServiceAPI::getEntityProperties ( UID _entity,
bool _recursive,
const std::string & _propertyGroupFilter,
std::map< UID, EntityProperties > & _entityProperties )

◆ getIDsOfFolderItemsOfType()

std::list< ot::UID > ot::ModelServiceAPI::getIDsOfFolderItemsOfType ( const std::string & _folder,
const std::string & _entityClassName,
bool recursive )

◆ getListOfFolderItems()

std::list< std::string > ot::ModelServiceAPI::getListOfFolderItems ( const std::string & _folder,
bool recursive = false )

◆ getModelServiceURL()

virtual const std::string & ot::ModelServiceAPI::getModelServiceURL ( )
inlineprotectedvirtual

Reimplemented in ot::components::ModelComponent.

◆ getSelectedEntityInformation()

void ot::ModelServiceAPI::getSelectedEntityInformation ( std::list< EntityInformation > & _entityInfo,
const std::string & typeFilter = "" )

◆ getThisServiceURL()

virtual const std::string & ot::ModelServiceAPI::getThisServiceURL ( )
inlineprotectedvirtual

Reimplemented in ot::components::ModelComponent.

◆ modelChangeOperationCompleted()

void ot::ModelServiceAPI::modelChangeOperationCompleted ( const std::string & description)

◆ readEntityFromEntityIDandVersion()

EntityBase * ot::ModelServiceAPI::readEntityFromEntityIDandVersion ( UID _entityID,
UID _version,
ClassFactoryHandler & classFactory )

◆ updatePropertyGrid()

void ot::ModelServiceAPI::updatePropertyGrid ( )

◆ updateTopologyEntities()

void ot::ModelServiceAPI::updateTopologyEntities ( ot::UIDList & topologyEntityIDs,
ot::UIDList & topologyEntityVersions,
const std::string & comment )

Member Data Documentation

◆ m_modelServiceURL

std::string ot::ModelServiceAPI::m_modelServiceURL
protected

◆ m_thisServiceURL

std::string ot::ModelServiceAPI::m_thisServiceURL
protected
The documentation for this class was generated from the following files: