fw4spl
fwDataIO::reader::DictionaryReader Class Reference

Dictionary reader. Read file with .dic extension. More...

#include <DictionaryReader.hpp>

+ Inheritance diagram for fwDataIO::reader::DictionaryReader:
+ Collaboration diagram for fwDataIO::reader::DictionaryReader:

Public Member Functions

virtual bool isA (const std::string &type) const override
 
FWDATAIO_API DictionaryReader (::fwDataIO::reader::IObjectReader::Key key)
 Constructor. Do nothing .
 
virtual FWDATAIO_API ~DictionaryReader ()
 Destructor. Do nothing.
 
virtual FWDATAIO_API void read () override
 Read the file with standard iostream API.
 
FWDATAIO_API std::string extension () override
 
- Public Member Functions inherited from fwDataIO::reader::GenericObjectReader< ::fwData::StructureTraitsDictionary >
 GenericObjectReader ()
 Constructor. Do nothing.
 
virtual ~GenericObjectReader ()
 Destructor. Do nothing.
 
virtual void setObject (::fwTools::Object::sptr obj) override
 m_object setter. More...
 
virtual std::shared_ptr< DataTypegetConcreteObject ()
 m_object getter. More...
 
- Public Member Functions inherited from fwDataIO::reader::IObjectReader
virtual FWDATAIO_API::fwTools::Object::sptr getObject ()
 m_object getter. More...
 
virtual FWDATAIO_API void setLocation (const ::fwData::location::ILocation::sptr _location)
 m_location setter. More...
 
virtual FWDATAIO_API::fwData::location::ILocation::sptr getLocation ()
 m_location getter. More...
 
FWDATAIO_API void cancel ()
 Requests reader abortion.
 
virtual FWDATAIO_API std::shared_ptr< ::fwJobs::IJobgetJob () const
 Returns the internal job.
 
- Public Member Functions inherited from fwCore::BaseObject
- Public Member Functions inherited from fwData::location::enableSingleFile< IObjectReader >
 enableSingleFile (IObjectReader *rw)
 constructor More...
 
void setFile (ILocation::PathType path)
 Set file system path.
 
ILocation::PathType getFile ()
 Get file system path.
 

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
static FWDATAIO_API::boost::filesystem::path getDefaultDictionaryPath ()
 Returns the default dictionary path ( file in rc directory path of fwDataIO library )
 
- Static Public Member Functions inherited from fwDataIO::reader::GenericObjectReader< ::fwData::StructureTraitsDictionary >
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- Static Public Member Functions inherited from fwDataIO::reader::IObjectReader
static bool isTypeOf (const std::string &type)
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 
- Static Public Member Functions inherited from fwCore::BaseObject
static bool isTypeOf (const std::string &type)
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Friends

template<class , class , class >
class ::fwTools::ClassFactory
 
class ::fwTools::Factory
 

Demangling methods

virtual const std::string & getLeafClassname () const override
 return object's classname without its namespace, i.e. BaseObject
 
virtual const std::string & getClassname () const override
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Additional Inherited Members

- Public Types inherited from fwDataIO::reader::GenericObjectReader< ::fwData::StructureTraitsDictionary >
typedef ::fwData::StructureTraitsDictionary DataType
 the object type related
 
- Public Types inherited from fwDataIO::reader::IObjectReader
typedef std::function< void(std::uint64_t) > ProgressCallback
 
typedef std::function< void() > CancelCallback
 
typedef ::fwDataIO::reader::factory::Key Key
 
- Protected Member Functions inherited from fwDataIO::reader::IObjectReader
FWDATAIO_API IObjectReader ()
 Constructor. Do nothing.
 
virtual FWDATAIO_API ~IObjectReader ()
 Destructor. Do nothing.
 
- Protected Attributes inherited from fwDataIO::reader::IObjectReader
::fwTools::Object::wptr m_object
 Object result of reading process. More...
 
::fwData::location::ILocation::sptr m_location
 Object location ( file path, directory path, url, etc )
 

Detailed Description

Dictionary reader. Read file with .dic extension.

Ircad reader to read a fwData::StructureTraitsDictionary on filesystem which the file format is .dic. This is an ascii file the structure of each line is defined on the first line of this file.

Definition at line 36 of file DictionaryReader.hpp.


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