apollo::cyber::class_loader::ClassLoader类 参考

for library load,createclass object 更多...

#include <class_loader.h>

apollo::cyber::class_loader::ClassLoader 的协作图:

Public 成员函数
	ClassLoader (const std::string &library_path)
virtual	~ClassLoader ()
bool	IsLibraryLoaded ()
bool	LoadLibrary ()
int	UnloadLibrary ()
const std::string	GetLibraryPath () const
template<typename Base >
std::vector< std::string >	GetValidClassNames ()
template<typename Base >
std::shared_ptr< Base >	CreateClassObj (const std::string &class_name)
template<typename Base >
bool	IsClassValid (const std::string &class_name)

详细描述

for library load,createclass object

在文件 class_loader.h 第 35 行定义.

构造及析构函数说明

ClassLoader()

apollo::cyber::class_loader::ClassLoader::ClassLoader ( const std::string &  library_path )

explicit

在文件 class_loader.cc 第 21 行定义.

    : library_path_(library_path),
      loadlib_ref_count_(0),
      classobj_ref_count_(0) {
  LoadLibrary();
}

~ClassLoader()

apollo::cyber::class_loader::ClassLoader::~ClassLoader ( )

virtual

在文件 class_loader.cc 第 28 行定义.

{ UnloadLibrary(); }

成员函数说明

CreateClassObj()

template<typename Base >

std::shared_ptr< Base > apollo::cyber::class_loader::ClassLoader::CreateClassObj

(

const std::string &

class_name

)

在文件 class_loader.h 第 76 行定义.

                                 {
  if (!IsLibraryLoaded()) {
    LoadLibrary();
  }
 
  Base* class_object = utility::CreateClassObj<Base>(class_name, this);
  if (class_object == nullptr) {
    AWARN << "CreateClassObj failed, ensure class has been registered. "
          << "classname: " << class_name << ",lib: " << GetLibraryPath();
    return std::shared_ptr<Base>();
  }
 
  std::lock_guard<std::mutex> lck(classobj_ref_count_mutex_);
  classobj_ref_count_ = classobj_ref_count_ + 1;
  std::shared_ptr<Base> classObjSharePtr(
      class_object, std::bind(&ClassLoader::OnClassObjDeleter<Base>, this,
                              std::placeholders::_1));
  return classObjSharePtr;
}

GetLibraryPath()

const std::string apollo::cyber::class_loader::ClassLoader::GetLibraryPath

(

)

const

在文件 class_loader.cc 第 62 行定义.

{ return library_path_; }

GetValidClassNames()

template<typename Base >

std::vector< std::string > apollo::cyber::class_loader::ClassLoader::GetValidClassNames

(

)

在文件 class_loader.h 第 64 行定义.

                                                     {
  return (utility::GetValidClassNames<Base>(this));
}

IsClassValid()

template<typename Base >

bool apollo::cyber::class_loader::ClassLoader::IsClassValid

(

const std::string &

class_name

)

在文件 class_loader.h 第 69 行定义.

                                                          {
  std::vector<std::string> valid_classes = GetValidClassNames<Base>();
  return (std::find(valid_classes.begin(), valid_classes.end(), class_name) !=
          valid_classes.end());
}

IsLibraryLoaded()

bool apollo::cyber::class_loader::ClassLoader::IsLibraryLoaded

(

)

在文件 class_loader.cc 第 30 行定义.

                                  {
  return utility::IsLibraryLoaded(library_path_, this);
}

LoadLibrary()

bool apollo::cyber::class_loader::ClassLoader::LoadLibrary

(

)

在文件 class_loader.cc 第 34 行定义.

                              {
  std::lock_guard<std::mutex> lck(loadlib_ref_count_mutex_);
  ++loadlib_ref_count_;
  AINFO << "Begin LoadLibrary: " << library_path_;
  return utility::LoadLibrary(library_path_, this);
}

UnloadLibrary()

int apollo::cyber::class_loader::ClassLoader::UnloadLibrary

(

)

在文件 class_loader.cc 第 41 行定义.

                               {
  std::lock_guard<std::mutex> lckLib(loadlib_ref_count_mutex_);
  std::lock_guard<std::mutex> lckObj(classobj_ref_count_mutex_);
 
  if (classobj_ref_count_ > 0) {
    AINFO << "There are still classobjs have not been deleted, "
             "classobj_ref_count_: "
          << classobj_ref_count_;
  } else {
    --loadlib_ref_count_;
    if (loadlib_ref_count_ == 0) {
      utility::UnloadLibrary(library_path_, this);
    } else {
      if (loadlib_ref_count_ < 0) {
        loadlib_ref_count_ = 0;
      }
    }
  }
  return loadlib_ref_count_;
}

---

该类的文档由以下文件生成:

• cyber/class_loader/class_loader.h
• cyber/class_loader/class_loader.cc