UniSet  2.8.0
Перечисления | Функции
Группа сервисных функций Репозитория объектов

Перечисления

enum  uniset::ObjectRepository::ObjectType { uniset::ObjectRepository::ObjectRef, uniset::ObjectRepository::Section }
 

Функции

bool uniset::ObjectRepository::list (const std::string &section, uniset::ListObjectName *ls, size_t how_many=300) const
 
bool uniset::ObjectRepository::listSections (const std::string &in_section, uniset::ListObjectName *ls, size_t how_many=300) const
 
bool uniset::ObjectRepository::createSection (const std::string &name, const std::string &in_section) const
 
bool uniset::ObjectRepository::createSectionF (const std::string &fullName) const
 
bool uniset::ObjectRepository::createRootSection (const std::string &name) const
 Функция создания секции в корневом 'каталоге'. Подробнее...
 
bool uniset::ObjectRepository::removeSection (const std::string &fullName, bool recursive=false) const
 Функция удаления секции Подробнее...
 
bool uniset::ObjectRepository::renameSection (const std::string &newName, const std::string &fullName) const
 Функция переименования секции Подробнее...
 
void uniset::ObjectRepository::printSection (const std::string &fullName) const
 

Подробное описание

Перечисления

◆ ObjectType

Тип объекта

Элементы перечислений
ObjectRef 

ссылка на объект

Section 

подсекция

Функции

◆ createRootSection()

bool ObjectRepository::createRootSection ( const std::string &  name) const

Функция создания секции в корневом 'каталоге'.

◆ createSection()

bool ObjectRepository::createSection ( const std::string &  name,
const std::string &  in_section 
) const

Создание секции throw(uniset::ORepFailed, uniset::InvalidObjectName);

Аргументы
name- имя создаваемой секции
in_section- полное имя секции внутри которой создается новая
section- полное имя секции начиная с Root.
Исключения
ORepFailed- генерируется если произошла при получении доступа к секции

◆ createSectionF()

bool ObjectRepository::createSectionF ( const std::string &  fullName) const

Создание секции по полному имени throw(uniset::ORepFailed, uniset::InvalidObjectName);

Аргументы
fullName- полное имя создаваемой секции
Исключения
ORepFailed- генерируется, если произошла при получении доступа к секции

◆ list()

bool ObjectRepository::list ( const std::string &  section,
uniset::ListObjectName ls,
size_t  how_many = 300 
) const

Получение списка how_many объектов из секции section. throw(uniset::ORepFailed)

Аргументы
ls- указатель на список, который надо заполнить
how_many- максимальное количество заносимых элементов
section- полное имя секции, начиная с Root.
Возвращает
Функция возвращает true, если в список были внесены не все элементы. Т.е. действительное количество объектов в этой секции превышает заданное how_many.
Исключения
ORepFailed- генерируется если произошла при получении доступа к секции

◆ listSections()

bool ObjectRepository::listSections ( const std::string &  in_section,
uniset::ListObjectName ls,
size_t  how_many = 300 
) const

Получение списка how_many подсекций из секции in_section. throw(uniset::ORepFailed);

Аргументы
ls- указатель на список который надо заполнить
how_many- максимальное количество заносимых элементов
in_section- полное имя секции начиная с Root.
Возвращает
Функция возвращает true, если в список были внесены не все элементы. Т.е. действительное количество объектов в этой секции превышает заданное how_many.
Исключения
ORepFailed- генерируется если произошла при получении доступа к секции

◆ printSection()

void ObjectRepository::printSection ( const std::string &  fullName) const

Функция выводящая на экран список всех объектов расположенных в данной секции

Заметки
Функция не вывести список, если не сможет получить доступ к секции

◆ removeSection()

bool ObjectRepository::removeSection ( const std::string &  fullName,
bool  recursive = false 
) const

Функция удаления секции

Аргументы
fullName- имя удаляемой секции
recursive- удалять рекурсивно все секции или возвращать не удалять и ошибку ( временно )
Предупреждения
Функция вынимает только первые 1000 объектов, остальные игнорируются...

◆ renameSection()

bool ObjectRepository::renameSection ( const std::string &  newName,
const std::string &  fullName 
) const

Функция переименования секции

Аргументы
newFName- полное имя новой секции
oldFName- полное имя удаляемой секции