holds data about codes and names for grammatical categories, etc. More...

#include <common/MediaticData/mediaticData.h>

Inheritance diagram for Lima::Common::MediaticData::MediaticData:

Public Member Functions
void	init (const std::string &resourcesPath, const std::string &configPath, const std::string &configFile, const std::deque< std::string > &meds, const std::map< std::string, std::string > &opts={})
	initializes the system with the configuration file.

void	initMedia (const std::string &media)

const FsaStringsPool &	stringsPool (MediaId med) const

FsaStringsPool &	stringsPool (MediaId med)

const std::map< std::string, MediaId > &	getMediasIds () const

const std::string &	getMediaId (MediaId idNum) const

MediaId	getMediaId (const std::string &stringId) const

const std::string &	media (MediaId media) const

MediaId	media (const std::string &media) const

const std::deque< std::string > &	getMedias () const

const MediaData &	mediaData (MediaId media) const

const MediaData &	mediaData (const std::string &med) const

MediaData &	mediaData (MediaId media)

uint8_t	getRelation (const std::string &relation) const

const std::string &	getRelation (uint8_t relation) const

ConceptType	getConceptType (const std::string &typeName) const

const std::string &	getConceptName (const ConceptType &typeName) const

bool	getOptionValue (const std::string &name, std::string &value) const

bool	releaseStringsPool () const

const std::string &	getResourcesPath () const

const std::string &	getConfigPath () const

size_t	getNbCategories () const

virtual	~MediaticData ()

virtual void	initEntityTypes (XMLConfigurationFiles::XMLConfigurationFileParser &configParser)

const LimaString &	getEntityTypeNameSeparator () const


EntityType	getEntityType (const LimaString &entityName) const
	entity types manager

EntityType	getEntityType (const LimaString &groupName, const LimaString &entityName) const

EntityType	getEntityType (EntityGroupId groupId, const LimaString &entityName) const

EntityGroupId	getEntityGroupId (const LimaString &groupName) const

LimaString	getEntityName (const EntityType &type) const

const LimaString &	getEntityGroupName (EntityGroupId id) const

EntityGroupId	addEntityGroup (const LimaString &groupName)

EntityType	addEntity (const LimaString &groupName, const LimaString &entityName)

void	addEntityParentLink (const EntityType &child, const EntityType &parent)

bool	isEntityAncestor (const EntityType &child, const EntityType &parent) const

std::vector< EntityType >	getGroupAncestors (EntityGroupId id) const

EntityType	getEntityAncestor (const EntityType &child) const

EntityType	getEntityParent (const EntityType &child) const

bool	getEntityChildList (const EntityType &parent, std::map< EntityType, EntityType > &EntityTypeMapping) const

void	writeEntityTypes (std::ostream &os) const

void	readEntityTypes (std::istream &os, std::map< EntityGroupId, EntityGroupId > &EntityGroupIdMapping, std::map< EntityType, EntityType > &EntityTypeMapping)

Public Member Functions inherited from Lima::Singleton< MediaticData >
	Singleton ()=default

virtual	~Singleton ()=default

Friends
class	Singleton< MediaticData >

Additional Inherited Members
Static Public Member Functions inherited from Lima::Singleton< MediaticData >
static const MediaticData &	single ()
	const singleton accessor

static const MediaticData *	psingle ()

static MediaticData &	changeable ()
	singleton accessor

static MediaticData *	pchangeable ()

Detailed Description

holds data about codes and names for grammatical categories, etc.

Author: Gael de Chalendar

Definition at line 52 of file mediaticData.h.

Constructor & Destructor Documentation

◆ ~MediaticData()

Lima::Common::MediaticData::MediaticData::~MediaticData ( )

virtual

Definition at line 168 of file mediaticData.cpp.

Member Function Documentation

◆ addEntity()

EntityType Lima::Common::MediaticData::MediaticData::addEntity	(	const LimaString &	groupName,
		const LimaString &	entityName
	)

Definition at line 983 of file mediaticData.cpp.

◆ addEntityGroup()

EntityGroupId Lima::Common::MediaticData::MediaticData::addEntityGroup ( const LimaString & groupName )

Definition at line 959 of file mediaticData.cpp.

◆ addEntityParentLink()

void Lima::Common::MediaticData::MediaticData::addEntityParentLink	(	const EntityType &	child,
		const EntityType &	parent
	)

Definition at line 994 of file mediaticData.cpp.

◆ getConceptName()

const std::string & Lima::Common::MediaticData::MediaticData::getConceptName ( const ConceptType & typeName ) const

Definition at line 760 of file mediaticData.cpp.

◆ getConceptType()

ConceptType Lima::Common::MediaticData::MediaticData::getConceptType ( const std::string & typeName ) const

Definition at line 743 of file mediaticData.cpp.

◆ getConfigPath()

const std::string & Lima::Common::MediaticData::MediaticData::getConfigPath ( ) const

Definition at line 207 of file mediaticData.cpp.

◆ getEntityAncestor()

EntityType Lima::Common::MediaticData::MediaticData::getEntityAncestor ( const EntityType & child ) const

Definition at line 1007 of file mediaticData.cpp.

◆ getEntityChildList()

bool Lima::Common::MediaticData::MediaticData::getEntityChildList	(	const EntityType &	parent,
		std::map< EntityType, EntityType > &	EntityTypeMapping
	)		const

Definition at line 1019 of file mediaticData.cpp.

◆ getEntityGroupId()

EntityGroupId Lima::Common::MediaticData::MediaticData::getEntityGroupId ( const LimaString & groupName ) const

Definition at line 1150 of file mediaticData.cpp.

◆ getEntityGroupName()

const LimaString & Lima::Common::MediaticData::MediaticData::getEntityGroupName ( EntityGroupId id ) const

Definition at line 1200 of file mediaticData.cpp.

◆ getEntityName()

LimaString Lima::Common::MediaticData::MediaticData::getEntityName ( const EntityType & type ) const

Definition at line 1156 of file mediaticData.cpp.

◆ getEntityParent()

EntityType Lima::Common::MediaticData::MediaticData::getEntityParent ( const EntityType & child ) const

Definition at line 1013 of file mediaticData.cpp.

◆ getEntityType() [1/3]

EntityType Lima::Common::MediaticData::MediaticData::getEntityType ( const LimaString & entityName ) const

entity types manager

Definition at line 1052 of file mediaticData.cpp.

◆ getEntityType() [2/3]

EntityType Lima::Common::MediaticData::MediaticData::getEntityType	(	const LimaString &	groupName,
		const LimaString &	entityName
	)		const

Definition at line 1085 of file mediaticData.cpp.

◆ getEntityType() [3/3]

EntityType Lima::Common::MediaticData::MediaticData::getEntityType	(	EntityGroupId	groupId,
		const LimaString &	entityName
	)		const

Deprecated:: This method has always made it very difficult to debug errors by obfuscating the group name. It will be made private in a future version.

Definition at line 1127 of file mediaticData.cpp.

◆ getEntityTypeNameSeparator()

const LimaString & Lima::Common::MediaticData::MediaticData::getEntityTypeNameSeparator ( ) const

Definition at line 1384 of file mediaticData.cpp.

◆ getGroupAncestors()

std::vector< EntityType > Lima::Common::MediaticData::MediaticData::getGroupAncestors ( EntityGroupId id ) const

Definition at line 1026 of file mediaticData.cpp.

◆ getMediaId() [1/2]

MediaId Lima::Common::MediaticData::MediaticData::getMediaId ( const std::string & stringId ) const

Returns: the numerical value of the given string Media id (3 chars code)

Definition at line 380 of file mediaticData.cpp.

◆ getMediaId() [2/2]

const std::string & Lima::Common::MediaticData::MediaticData::getMediaId ( MediaId idNum ) const

Returns: the string value of the given numerical Media ID

Definition at line 342 of file mediaticData.cpp.

◆ getMedias()

const std::deque< std::string > & Lima::Common::MediaticData::MediaticData::getMedias ( ) const

Definition at line 188 of file mediaticData.cpp.

◆ getMediasIds()

const std::map< std::string, MediaId > & Lima::Common::MediaticData::MediaticData::getMediasIds ( ) const

Definition at line 173 of file mediaticData.cpp.

◆ getNbCategories()

size_t Lima::Common::MediaticData::MediaticData::getNbCategories ( ) const

Returns: the number of categories

◆ getOptionValue()

bool Lima::Common::MediaticData::MediaticData::getOptionValue	(	const std::string &	name,
		std::string &	value
	)		const

Definition at line 1347 of file mediaticData.cpp.

◆ getRelation() [1/2]

uint8_t Lima::Common::MediaticData::MediaticData::getRelation ( const std::string & relation ) const

Returns: the numerical value of the given relation name

Definition at line 657 of file mediaticData.cpp.

◆ getRelation() [2/2]

const std::string & Lima::Common::MediaticData::MediaticData::getRelation ( uint8_t relation ) const

Returns: the string value of the given relation numerical value

Definition at line 643 of file mediaticData.cpp.

◆ getResourcesPath()

const std::string & Lima::Common::MediaticData::MediaticData::getResourcesPath ( ) const

Definition at line 202 of file mediaticData.cpp.

◆ init()

void Lima::Common::MediaticData::MediaticData::init	(	const std::string &	resourcesPath,
		const std::string &	configPath,
		const std::string &	configFile,
		const std::deque< std::string > &	meds,
		const std::map< std::string, std::string > &	opts = `{}`
	)

initializes the system with the configuration file.

Parameters

configurationFileName	IN path to main configuration file
media	IN the only media to load. If not specified then load all activated medias in configuration file.

initialize active medias

Definition at line 212 of file mediaticData.cpp.

◆ initEntityTypes()

void Lima::Common::MediaticData::MediaticData::initEntityTypes ( XMLConfigurationFiles::XMLConfigurationFileParser & configParser )

virtual

Definition at line 942 of file mediaticData.cpp.

◆ initMedia()

void Lima::Common::MediaticData::MediaticData::initMedia ( const std::string & media )

Definition at line 324 of file mediaticData.cpp.

◆ isEntityAncestor()

bool Lima::Common::MediaticData::MediaticData::isEntityAncestor	(	const EntityType &	child,
		const EntityType &	parent
	)		const

Definition at line 1000 of file mediaticData.cpp.

◆ media() [1/2]

MediaId Lima::Common::MediaticData::MediaticData::media ( const std::string & media ) const

Definition at line 183 of file mediaticData.cpp.

◆ media() [2/2]

const std::string & Lima::Common::MediaticData::MediaticData::media ( MediaId media ) const

Definition at line 178 of file mediaticData.cpp.

◆ mediaData() [1/3]

const MediaData & Lima::Common::MediaticData::MediaticData::mediaData ( const std::string & med ) const

Definition at line 404 of file mediaticData.cpp.

◆ mediaData() [2/3]

MediaData & Lima::Common::MediaticData::MediaticData::mediaData ( MediaId media )

Definition at line 411 of file mediaticData.cpp.

◆ mediaData() [3/3]

const MediaData & Lima::Common::MediaticData::MediaticData::mediaData ( MediaId media ) const

Definition at line 398 of file mediaticData.cpp.

◆ readEntityTypes()

void Lima::Common::MediaticData::MediaticData::readEntityTypes	(	std::istream &	os,
		std::map< EntityGroupId, EntityGroupId > &	EntityGroupIdMapping,
		std::map< EntityType, EntityType > &	EntityTypeMapping
	)

Definition at line 1273 of file mediaticData.cpp.

◆ releaseStringsPool()

bool Lima::Common::MediaticData::MediaticData::releaseStringsPool ( ) const

Definition at line 197 of file mediaticData.cpp.

◆ stringsPool() [1/2]

FsaStringsPool & Lima::Common::MediaticData::MediaticData::stringsPool ( MediaId med )

Definition at line 1371 of file mediaticData.cpp.

◆ stringsPool() [2/2]

const FsaStringsPool & Lima::Common::MediaticData::MediaticData::stringsPool ( MediaId med ) const

Definition at line 1358 of file mediaticData.cpp.

◆ writeEntityTypes()

void Lima::Common::MediaticData::MediaticData::writeEntityTypes ( std::ostream & os ) const

Definition at line 1219 of file mediaticData.cpp.

Friends And Related Symbol Documentation

◆ Singleton< MediaticData >

friend class Singleton< MediaticData >

friend