OMK::Name Class Reference

Class for naming things in Mask. More...

#include <OMKName.h>

Inheritance diagram for OMK::Name:

[legend]Collaboration diagram for OMK::Name:

[legend]List of all members.

redefine standard operators
bool	operator== (const Name &first, const Name &second)
	compare
bool	operator!= (const Name &first, const Name &second)
	compare.
bool OMK_API	operator< (const Name &Source1, const Name &Source2)
	smaller than
bool OMK_API	operator> (const Name &Source1, const Name &Source2)
	greater than
bool OMK_API	operator<= (const Name &Source1, const Name &Source2)
	smaller than or equal to
bool OMK_API	operator>= (const Name &Source1, const Name &Source2)
	greater than or equal to
virtual Name &	operator= (const Name &)
	affectation
virtual Name &	operator= (const char *)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual Name &	operator= (const std::string &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Public Types
typedef long	idType
	real type of name identifiers
Public Member Functions
	Name ()
	Default contructor.
	Name (const std::string &)
	Construction from a std::string.
	Name (const char *)
	Construction from a char * (getCString).
	Name (const Name &)
	copy constructor
virtual	~Name ()
	Destructor.
bool	undefined () const
	Return true if the name is undefined.
virtual Type::PolatorNT *	createPolator (void)
	Creation a Polator for names, a Name derives from OMKType.
virtual const char *	getCString () const
	get C style string corresponding to name
virtual const std::string &	getString () const
	get std::string corresponding to name
virtual void	insertInStream (std::ostream &out) const
	Insert in a stream.
virtual void	extract (std::istream &in)
	Extract from a stream.
virtual void	unpack (IncomingSynchronisationMessage &)
	unpack from a message
virtual void	pack (OutgoingSynchronisationMessage &) const
	pack in a message
Static Public Member Functions
static NameServer *	getNameServer ()
	get the name server.
static void	setNameServer (NameServer *)
	change the name server will only have any effect if the new name server is equivalent to the old one
Static Public Attributes
static const idType	_maxReservedId
	max id of reserved ids (reserved ids are called system ids)
Protected Member Functions
virtual void	changeId (idType oldId, idType newId)
	a protected member function to enable change of the id by the name server
	Name (idType)
	constructor using the associated id.
Protected Attributes
idType	_identifier
	the identifier used to store the name
Static Protected Attributes
static NameServer *	_nameServer
	the current name server
Friends
class	OMK::NameServer
Related Functions
(Note that these are not member functions.)
functions and object-function to manipulate names
bool	operator== (const Name &a, const char *b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	operator== (const char *a, const Name &b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	operator!= (const Name &a, const char *b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	operator!= (const char *a, const Name &b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Classes
struct	hash_compare_Name
	a function object for a hash function More...

---

Detailed Description

Class for naming things in Mask.

For efficiency reasons, names appear to the user as human readable strings but are in fact identifiers. Correpondance between an identifier and a human readable string is kept by the name server. The following Names are reserved id:

• _OpenMASKpackedWithControlParameters
• _OpenMASKpackedWithoutControlParameters
• _OpenMASKEndOfSynchronisationMessage

Performance issue

As Name are identifiers, when two Name are compared, it is inlined and fast. But when a Name is compared to a string (std::string or const char*), the string corresponding to the Name is retrieved by the NameServer and the two strings are compared. So the first way is faster than the second one.

Example: It is faster to compare Name like

bool myOSO::processEvent( Event *event )
{
static Name eventName( "theEvent" ) ;
if( event->eventId == eventName )
{ 
// Compare identifiers => fast
}
}

than compare strings like

bool myOSO::processEvent( Event *event )
{
if( event->eventId == "theEvent" )
{ 
// Compare strings => slow
}
}

Definition at line 73 of file OMKName.h.

---

Member Typedef Documentation

typedef long OMK::Name::idType

real type of name identifiers

Definition at line 206 of file OMKName.h.

---

Constructor & Destructor Documentation

Name::Name

(

)

Default contructor.

Definition at line 65 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), getNameServer(), OMK_DEBUG_OMK_NAME, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name()" ) ;
   _identifier=0;
   getNameServer()->created( _identifier, this );
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name() end" ) ;
}

Name::Name

(

const std::string &

)

Construction from a std::string.

Definition at line 84 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), OMK::NameServer::getIdentifier(), getNameServer(), OMK_DEBUG_OMK_NAME, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(const std::string & \"" << name << "\" )"
     << endl <<"Name server = " << (void*)getNameServer() ) ;
   _identifier = getNameServer()->getIdentifier(name);
   getNameServer()->created( _identifier, this ) ;
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(const std::string &) end" ) ;
}

Name::Name

(

const char *

)

Construction from a char * (getCString).

Definition at line 73 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), OMK::NameServer::getIdentifier(), getNameServer(), OMK_DEBUG_OMK_NAME, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(const char * (" << (void*)name << ")\"" << name << "\" )"
     << endl <<"Name server = " << (void*)getNameServer() ) ;
   _identifier = getNameServer()->getIdentifier(std::string(name));
   getNameServer()->created( _identifier, this ) ;
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(const char *) end" );
}

Name::Name

(

const Name &

)

copy constructor

Definition at line 94 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), getNameServer(), OMK_DEBUG_OMK_NAME, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(const Name & \"" << aCopier << "\") " << aCopier._identifier ) ;
   _identifier = aCopier._identifier;
   getNameServer()->created(_identifier,this);
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(const Name &) end" ) ;
} 

Name::~Name

(

)

[virtual]

Destructor.

Definition at line 102 of file OMKName.cpp.

References _identifier, OMK::NameServer::deleted(), and getNameServer().

{
        getNameServer()->deleted( _identifier, this );
}

Name::Name

(

idType

)

[explicit, protected]

constructor using the associated id.

It's usage is reserved for the creation of system identifiers

Definition at line 56 of file OMKName.cpp.

References _identifier, _maxReservedId, OMK::NameServer::created(), getNameServer(), OMASSERT, OMK_DEBUG_OMK_NAME, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(idType " << i << " )" ) ;
   OMASSERT( i < _maxReservedId ) ;
   _identifier = i ;
   getNameServer()->created( _identifier , this );
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::Name(idType) end" ) ;   
}

---

Member Function Documentation

bool OMK::Name::undefined

(

)

const [inline]

Return true if the name is undefined.

It is the same to write

 name == OMK::Name() 

Definition at line 102 of file OMKName.h.

Referenced by OMK::IAttribute::activateConnectBySignal(), OMK::IAttribute::activateGetBySignal(), OMK::IAttribute::activateSetBySignal(), and OMK::IAttribute::activateSetBySignalOf().

{ return 0 == _identifier ; }

OMK::Type::PolatorNT * Name::createPolator

(

void

)

[virtual]

Creation a Polator for names, a Name derives from OMKType.

Implements OMK::Type::Base.

Definition at line 109 of file OMKName.cpp.

{
   return new OMK::Type::Polator<Name>();
}

const char * Name::getCString

(

)

const [virtual]

get C style string corresponding to name

Definition at line 115 of file OMKName.cpp.

References _identifier, getNameServer(), and OMK::NameServer::getStringAssociatedTo().

Referenced by OMK::PvmSvm::addNewWorkstation(), OMK::Vis::VisBase::createInput(), OMK::Vis::debugMsg(), OMK::ParametersAccessor::getAndCheckObject(), OMK::Output< T >::getDateOfLastExactValue(), OMK::Output< T >::getLastExactValue(), OMK::Controller::getPointerToDuplicatedObjectNamed(), OMK::Iii::InteractorExtension::InteractorExtension(), OMK::Iii::JointInteractorExtension::loadExtensionParameters(), OMK::MultiValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), OMK::Output< T >::localInsert(), OMK::Name::hash_compare_Name::operator()(), OMK::ValuedEventListenerCallBack< CallerClass, PrmType >::processEvent(), OMK::PvmSvm::removeWorkstation(), OMK::ObjectDescriptor::setProcess(), and OMK::PvmSvm::spawnProcess().

{
   //OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::getCString()" ) ;
   const char * result = ( getNameServer()->getStringAssociatedTo( _identifier ) ).c_str() ;
   //OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::getCString() returns \"" << resul << "\"" ) ;
   return result ;
}

const std::string & Name::getString

(

)

const [virtual]

get std::string corresponding to name

Definition at line 123 of file OMKName.cpp.

References _identifier, getNameServer(), OMK::NameServer::getStringAssociatedTo(), OMK_DEBUG_OMK_NAME, and OMTRACEID.

Referenced by OMK::ExtensibleSimulatedObject::addAttribute(), OMK::ExtensionManager::addExtension(), OMK::MKMHumano::computeParameters(), OMK::Iii::SharedConnectorT< Type >::connect(), OMK::Iii::SimpleConnectorT< Type >::connect(), OMK::IAttribute::connectTo(), OMK::debugMsg(), OMK::Vis::debugMsg(), OMK::Iii::SharedConnectorT< Type >::disconnect(), OMK::Iii::SimpleConnectorT< Type >::disconnect(), OMK::IAttribute::fireValueTo(), OMK::StaticHumano::getInitialiseSequence(), OMK::Vis::VisObjectExtension::loadAnimatorParameters(), OMK::HumanoRecorder::loadParameters(), OMK::HumanoPlayer::loadParameters(), OMK::ObjectDescriptor::ObjectDescriptor(), operator!=(), OMK::Name::hash_compare_Name::operator()(), OMK::Vis::VisBase::processEvent(), OMK::Inp::InputCreatorListener::processEvent(), OMK::IAttribute::processGetValue(), OMK::IAttribute::sendValueTo(), and OMK::Output< T >::set().

{
   OMTRACEID( OMK_DEBUG_OMK_NAME, "Name::getString()" ) ;
   return getNameServer()->getStringAssociatedTo( _identifier ) ;
}

void Name::insertInStream

(

std::ostream &

out

)

const [virtual]

Insert in a stream.

Implements OMK::Flowable.

Definition at line 130 of file OMKName.cpp.

References _identifier, getNameServer(), and OMK::NameServer::getStringAssociatedTo().

{
//     cerr<<"Name::insertInStream of id "<<_identifier<<endl;
//     cerr<<"Name::insertInStream of "<<getNameServer()->getStringAssociatedTo(_identifier)<<endl;
   out << getNameServer()->getStringAssociatedTo( _identifier );
}

void Name::extract

(

std::istream &

in

)

[virtual]

Extract from a stream.

Implements OMK::Flowable.

Definition at line 138 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), OMK::NameServer::deleted(), OMK::NameServer::getIdentifier(), and getNameServer().

{
  std::string name ;
   in >> name ;
   idType oldIdentifier = _identifier ;

   _identifier = getNameServer()->getIdentifier ( name );

   getNameServer()->created( _identifier, this );

   getNameServer()->deleted( oldIdentifier, this );
}

void Name::unpack

(

IncomingSynchronisationMessage &

)

[virtual]

unpack from a message

Reimplemented from OMK::Flowable.

Definition at line 216 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), OMK::NameServer::deleted(), and getNameServer().

Referenced by OMK::PvmController::parseSynchronisationMessage(), OMK::PvmController::sendInitialValuesToMirror(), OMK::SimulatedObject::unpack(), OMK::PvmReferenceObjectHandle::unpack(), and OMK::SimulatedObject::unpackAllValues().

{
   idType oldIdentifier = _identifier ;

   in>>_identifier ;
   getNameServer()->created( _identifier, this ); 

   getNameServer()->deleted( oldIdentifier, this ); 
}

void Name::pack

(

OutgoingSynchronisationMessage &

)

const [virtual]

pack in a message

Reimplemented from OMK::Flowable.

Definition at line 227 of file OMKName.cpp.

References _identifier.

Referenced by OMK::Process::pack(), OMK::Output< T >::pack(), OMK::Output< T >::packAllValues(), OMK::PvmReferenceObjectHandle::packInitialValues(), OMK::PvmMirrorObjectHandle::registerToReferenceObject(), and OMK::PvmController::sendInitialValuesToMirror().

{
  out << _identifier ;
}

Name & Name::operator=

(

const Name &

)

[virtual]

affectation

Definition at line 177 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), OMK::NameServer::deleted(), and getNameServer().

{
   // copy into onself
   idType oldIdentifier = _identifier ;

   _identifier = aCopier._identifier;
   getNameServer()->created( _identifier, this );

   getNameServer()->deleted( oldIdentifier, this );

   return *this;
}

Name & Name::operator=

(

const char *

)

[virtual]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 171 of file OMKName.cpp.

{
   return *this = std::string( original ) ;
}

Name & Name::operator=

(

const std::string &

)

[virtual]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 156 of file OMKName.cpp.

References _identifier, OMK::NameServer::created(), OMK::NameServer::deleted(), OMK::NameServer::getIdentifier(), and getNameServer().

{
   // copy into onself : creation must happen before deletion
   idType oldIdentifier = _identifier ;

   _identifier = getNameServer()->getIdentifier( original );

   getNameServer()->created(_identifier, this);

   getNameServer()->deleted( oldIdentifier, this );

   return *this;
}

NameServer * Name::getNameServer

(

)

[static]

get the name server.

If no name server has been set yet, a default name server is created

Definition at line 29 of file OMKName.cpp.

References _nameServer.

Referenced by OMK::Svm::connectToDistributedSimulation(), extract(), getCString(), getString(), insertInStream(), Name(), operator=(), OMK::Svm::serveNameRequestsUntilEnd(), unpack(), and ~Name().

{
   static bool initialised = false ;
   if ( ! initialised )
      {
         _nameServer = new NameServer () ;
         initialised = true ;
      }
   return _nameServer ;
}

void Name::setNameServer

(

NameServer *

)

[static]

change the name server will only have any effect if the new name server is equivalent to the old one

Definition at line 42 of file OMKName.cpp.

References _nameServer, OMK::NameServer::includes(), and OMMESSAGE.

Referenced by OMK::Svm::connectToDistributedSimulation(), and OMK::Svm::serveNameRequestsUntilEnd().

{
   // the new name server is only installed if it has the same pairs <id,char *> as the old one.
  if ( newNameServer->includes( *_nameServer ) ) 
    {
     _nameServer = newNameServer ;
    }
  else 
    {
      OMMESSAGE( "WARNING : the name server wasn't changed because it wasn't equal to the old one" );
    }
}

void Name::changeId	(	idType	oldId,
		idType	newId
	)			[protected, virtual]

a protected member function to enable change of the id by the name server

Parameters:

	oldId	only used for verifications
	newId	the new id to use

Definition at line 232 of file OMKName.cpp.

References _identifier, and OMASSERTM.

Referenced by OMK::NameServer::changeNamesId().

{
   //cerr<<"Name::changeId ( "<<oldId<    <", "<<newId<<" ) "<<endl;
   //this is called by the name server : do not need to call back to keep the books
   OMASSERTM( oldId == _identifier, "" ) ;

   _identifier = newId ;
}

---

Friends And Related Function Documentation

friend class OMK::NameServer [friend]

Definition at line 245 of file OMKName.h.

bool operator==	(	const Name &	first,
		const Name &	second
	)			[friend]

compare

inlined because heavely used in the maps of the kernel

Definition at line 272 of file OMKName.h.

{
  return !( a != b );
}

bool operator!=	(	const Name &	first,
		const Name &	second
	)			[friend]

compare.

inlined because != is heavely used in the maps of the kernel

Definition at line 302 of file OMKName.h.

{
  return first._identifier != second._identifier;
}

bool OMK_API operator<	(	const Name &	Source1,
		const Name &	Source2
	)			[friend]

smaller than

Warning:

here, lexicographic order isn't used, it's the identifier order.

Definition at line 191 of file OMKName.cpp.

{ 
   return premier._identifier < second._identifier; 
}

bool OMK_API operator>	(	const Name &	Source1,
		const Name &	Source2
	)			[friend]

greater than

Warning:

here, lexicographic order isn't used, it's the identifier order.

Definition at line 197 of file OMKName.cpp.

{ 
   return premier._identifier > second._identifier; 
}

bool OMK_API operator<=	(	const Name &	Source1,
		const Name &	Source2
	)			[friend]

smaller than or equal to

Warning:

here, lexicographic order isn't used, it's the identifier order.

Definition at line 203 of file OMKName.cpp.

{ 
   return premier._identifier <= second._identifier; 
}

bool OMK_API operator>=	(	const Name &	Source1,
		const Name &	Source2
	)			[friend]

greater than or equal to

Warning:

here, lexicographic order isn't used, it's the identifier order.

Definition at line 210 of file OMKName.cpp.

{ 
   return premier._identifier >= second._identifier; 
}

bool operator==	(	const Name &	a,
		const char *	b
	)			[related]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Warning:

Avoid using this operator, see Performance issue

Definition at line 283 of file OMKName.h.

{
  return !( a != b ) ;
}

bool operator==	(	const char *	a,
		const Name &	b
	)			[related]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Warning:

Avoid using this operator, see Performance issue

Definition at line 293 of file OMKName.h.

{
  return b == a ;
}

bool operator!=	(	const Name &	a,
		const char *	b
	)			[related]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Warning:

Avoid using this operator, see Performance issue

Definition at line 312 of file OMKName.h.

References getString().

{
  return a.getString() != b ;
}

bool operator!=	(	const char *	a,
		const Name &	b
	)			[related]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Warning:

Avoid using this operator, see Performance issue

Definition at line 322 of file OMKName.h.

{
  return b != a;
}

---

Member Data Documentation

const Name::idType Name::_maxReservedId [static]

max id of reserved ids (reserved ids are called system ids)

Definition at line 210 of file OMKName.h.

Referenced by OMK::NameServer::getSystemIdentifier(), OMK::EventIdentifier::isSystemEvent(), Name(), and OMK::NameServer::NameServer().

NameServer * Name::_nameServer [static, protected]

the current name server

Definition at line 254 of file OMKName.h.

Referenced by getNameServer(), and setNameServer().

idType OMK::Name::_identifier [protected]

the identifier used to store the name

Definition at line 262 of file OMKName.h.

Referenced by changeId(), extract(), getCString(), getString(), insertInStream(), OMK::EventIdentifier::isSystemEvent(), Name(), OMK::operator!=(), OMK::operator<(), OMK::operator<=(), operator=(), OMK::operator>(), OMK::operator>=(), pack(), unpack(), and ~Name().

---