cnoid::ItemFileIO Class Reference

#include <ItemFileIO.h>

Inheritance diagram for cnoid::ItemFileIO:

Public Types
enum	API {   Load = 1 << 0, Options = 1 << 1, OptionPanelForLoading = 1 << 2, Save = 1 << 3,   OptionPanelForSaving = 1 << 4 }
enum	InterfaceLevel { Standard, Conversion, Internal }
enum	InvocationType { Direct, Dialog, DragAndDrop }

Public Member Functions
	~ItemFileIO ()
bool	isFormat (const std::string &id) const
int	api () const
void	setApi (int apiSet)
bool	hasApi (int api) const
void	setCaption (const std::string &caption)
const std::string &	caption () const
void	setFileTypeCaption (const std::string &caption)
const std::string &	fileTypeCaption () const
void	addFormatIdAlias (const std::string &formatId)
void	addExtensions (const std::vector< std::string > &extensions)
void	setExtensionFunction (std::function< std::string()> func)
std::vector< std::string >	extensions () const
void	setInterfaceLevel (InterfaceLevel level)
int	interfaceLevel () const
virtual Item *	createItem ()=0
void	setInvocationType (int type)
Item *	loadItem (const std::string &filename, Item *parentItem=nullptr, bool doAddition=true, Item *nextItem=nullptr, const Mapping *options=nullptr)
bool	loadItem (Item *item, const std::string &filename, Item *parentItem=nullptr, bool doAddition=true, Item *nextItem=nullptr, const Mapping *options=nullptr)
bool	saveItem (Item *item, const std::string &filename, const Mapping *options=nullptr)
virtual void	resetOptions ()
virtual void	storeOptions (Mapping *options)
virtual bool	restoreOptions (const Mapping *options)
virtual QWidget *	getOptionPanelForLoading ()
virtual void	fetchOptionPanelForLoading ()
virtual QWidget *	getOptionPanelForSaving (Item *item)
virtual void	fetchOptionPanelForSaving ()
Item *	parentItem ()
int	invocationType () const
bool	isRegisteredForSingletonItem () const
Item *	findSingletonItemInstance () const
void	setItemClassInfo (Referenced *info)
const Referenced *	itemClassInfo () const
Public Member Functions inherited from cnoid::Referenced
virtual	~Referenced ()

Static Public Member Functions
static std::vector< std::string >	separateExtensions (const std::string &multiExtString)

Protected Member Functions
	ItemFileIO (const std::string &formatId, int api)
	ItemFileIO (const ItemFileIO &org)
	ItemFileIO ()
void	copyFrom (const ItemFileIO &org)
void	setExtension (const std::string &extension)
void	setExtensions (const std::vector< std::string > &extensions)
virtual bool	load (Item *item, const std::string &filename)
virtual bool	save (Item *item, const std::string &filename)
std::ostream &	os ()
void	putWarning (const std::string &message)
void	putError (const std::string &message)
void	setActuallyLoadedItem (Item *item)
Protected Member Functions inherited from cnoid::Referenced
	Referenced ()
	Referenced (const Referenced &)
int	refCount () const

Friends
class	ItemManager
class	ItemFileIoExtenderBase
class	ItemFileDialog

Member Enumeration Documentation

API

enum cnoid::ItemFileIO::API

Enumerator
Load
Options
OptionPanelForLoading
Save
OptionPanelForSaving

InterfaceLevel

enum cnoid::ItemFileIO::InterfaceLevel

Enumerator
Standard
Conversion
Internal

InvocationType

enum cnoid::ItemFileIO::InvocationType

Enumerator
Direct
Dialog
DragAndDrop

Constructor & Destructor Documentation

~ItemFileIO()

ItemFileIO::~ItemFileIO

(

)

ItemFileIO() [1/3]

ItemFileIO::ItemFileIO ( const std::string &  formatId, int  api  )

protected

ItemFileIO() [2/3]

ItemFileIO::ItemFileIO ( const ItemFileIO &  org )

protected

ItemFileIO() [3/3]

ItemFileIO::ItemFileIO ( )

protected

Member Function Documentation

addExtensions()

void ItemFileIO::addExtensions

(

const std::vector< std::string > &

extensions

)

addFormatIdAlias()

void ItemFileIO::addFormatIdAlias

(

const std::string &

formatId

)

api()

int ItemFileIO::api

(

)

const

caption()

const std::string & ItemFileIO::caption

(

)

const

copyFrom()

void ItemFileIO::copyFrom ( const ItemFileIO &  org )

protected

createItem()

virtual Item* cnoid::ItemFileIO::createItem ( )

pure virtual

Implemented in cnoid::ItemFileIoExtender< ItemType, BaseItemType >, cnoid::ItemFileIoBase< ItemType >, cnoid::ItemFileIoBase< SceneItem >, and cnoid::ItemFileIoBase< BodyItem >.

extensions()

std::vector< std::string > ItemFileIO::extensions

(

)

const

fetchOptionPanelForLoading()

void ItemFileIO::fetchOptionPanelForLoading ( )

virtual

Reimplemented in cnoid::ItemFileIoExtenderBase, and cnoid::GeneralSceneFileImporterBase.

fetchOptionPanelForSaving()

void ItemFileIO::fetchOptionPanelForSaving ( )

virtual

Reimplemented in cnoid::ItemFileIoExtenderBase, and cnoid::BodyItemBodyFileIO.

fileTypeCaption()

const std::string & ItemFileIO::fileTypeCaption

(

)

const

findSingletonItemInstance()

Item * ItemFileIO::findSingletonItemInstance

(

)

const

getOptionPanelForLoading()

QWidget * ItemFileIO::getOptionPanelForLoading ( )

virtual

Reimplemented in cnoid::ItemFileIoExtenderBase, and cnoid::GeneralSceneFileImporterBase.

getOptionPanelForSaving()

QWidget * ItemFileIO::getOptionPanelForSaving ( Item *  item )

virtual

Reimplemented in cnoid::ItemFileIoExtenderBase, cnoid::ItemFileIoBase< ItemType >, cnoid::ItemFileIoBase< SceneItem >, and cnoid::ItemFileIoBase< BodyItem >.

hasApi()

bool ItemFileIO::hasApi

(

int

api

)

const

interfaceLevel()

int ItemFileIO::interfaceLevel

(

)

const

invocationType()

int ItemFileIO::invocationType

(

)

const

isFormat()

bool ItemFileIO::isFormat

(

const std::string &

id

)

const

isRegisteredForSingletonItem()

bool ItemFileIO::isRegisteredForSingletonItem

(

)

const

itemClassInfo()

const Referenced * ItemFileIO::itemClassInfo

(

)

const

load()

bool ItemFileIO::load ( Item *  item, const std::string &  filename  )

protectedvirtual

Reimplemented in cnoid::ItemFileIoExtenderBase, cnoid::ItemFileIoBase< ItemType >, cnoid::ItemFileIoBase< SceneItem >, and cnoid::ItemFileIoBase< BodyItem >.

loadItem() [1/2]

Item * ItemFileIO::loadItem	(	const std::string &	filename,
		Item *	parentItem = nullptr,
		bool	doAddition = true,
		Item *	nextItem = nullptr,
		const Mapping *	options = nullptr
	)

loadItem() [2/2]

bool ItemFileIO::loadItem	(	Item *	item,
		const std::string &	filename,
		Item *	parentItem = nullptr,
		bool	doAddition = true,
		Item *	nextItem = nullptr,
		const Mapping *	options = nullptr
	)

os()

std::ostream & ItemFileIO::os ( )

protected

parentItem()

Item * ItemFileIO::parentItem

(

)

putError()

void ItemFileIO::putError ( const std::string &  message )

protected

putWarning()

void ItemFileIO::putWarning ( const std::string &  message )

protected

resetOptions()

void ItemFileIO::resetOptions ( )

virtual

Reimplemented in cnoid::ItemFileIoExtenderBase, and cnoid::GeneralSceneFileImporterBase.

restoreOptions()

bool ItemFileIO::restoreOptions ( const Mapping *  options )

virtual

Reimplemented in cnoid::ItemFileIoExtenderBase, and cnoid::GeneralSceneFileImporterBase.

save()

bool ItemFileIO::save ( Item *  item, const std::string &  filename  )

protectedvirtual

Reimplemented in cnoid::ItemFileIoExtenderBase, cnoid::ItemFileIoBase< ItemType >, cnoid::ItemFileIoBase< SceneItem >, and cnoid::ItemFileIoBase< BodyItem >.

saveItem()

bool ItemFileIO::saveItem	(	Item *	item,
		const std::string &	filename,
		const Mapping *	options = nullptr
	)

separateExtensions()

std::vector< std::string > ItemFileIO::separateExtensions ( const std::string &  multiExtString )

static

setActuallyLoadedItem()

void ItemFileIO::setActuallyLoadedItem ( Item *  item )

protected

When the file is loaded as a composite item tree and the item that actually loads the file is different from the top item, the following function must be called with the corresponding item.

setApi()

void ItemFileIO::setApi

(

int

apiSet

)

setCaption()

void ItemFileIO::setCaption

(

const std::string &

caption

)

setExtension()

void ItemFileIO::setExtension ( const std::string &  extension )

protected

setExtensionFunction()

void ItemFileIO::setExtensionFunction

(

std::function< std::string()>

func

)

setExtensions()

void ItemFileIO::setExtensions ( const std::vector< std::string > &  extensions )

protected

setFileTypeCaption()

void ItemFileIO::setFileTypeCaption

(

const std::string &

caption

)

setInterfaceLevel()

void ItemFileIO::setInterfaceLevel

(

InterfaceLevel

level

)

setInvocationType()

void ItemFileIO::setInvocationType

(

int

type

)

setItemClassInfo()

void ItemFileIO::setItemClassInfo

(

Referenced *

info

)

storeOptions()

void ItemFileIO::storeOptions ( Mapping *  options )

virtual

Reimplemented in cnoid::ItemFileIoExtenderBase, and cnoid::GeneralSceneFileImporterBase.

Friends And Related Function Documentation

ItemFileDialog

friend class ItemFileDialog

friend

ItemFileIoExtenderBase

friend class ItemFileIoExtenderBase

friend

ItemManager

friend class ItemManager

friend

---

The documentation for this class was generated from the following files:

• ItemFileIO.h
• ItemFileIO.cpp
• ItemManager.cpp