MIRA
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NullClass Class Reference

Marker class for marking an invalid "null" class. More...

#include <factory/NullClass.h>

Inheritance diagram for NullClass:
Inheritance graph
[legend]

Public Member Functions

virtual ~NullClass ()
 
virtual std::string const & getIdentifier () const
 Return identifier for the class. More...
 
virtual std::string const & getName () const
 Return name of the class. More...
 
virtual int getTypeId () const
 Return unique id for the class. More...
 
virtual Typename getTypename () const
 Returns the platform independent C++ typename of the class. More...
 
virtual ObjectnewInstance () const
 Return a new instance of the class associated with the class object. More...
 
virtual ObjectnewInstance (int paramCount,...) const
 Return a new instance of the class associated with the class object. More...
 
virtual ObjectnewInstance (std::string const &childIdentifier) const
 Return a new instance of the child class with the given identifier. More...
 
virtual ObjectnewInstance (std::string const &childIdentifier, int paramCount,...) const
 Return a new instance of the child class with the given identifier. More...
 
virtual bool isAbstract () const
 Return true if the associated class is abstract. More...
 
std::map< std::string, std::string > const & getMetaInfo () const
 Return map with meta information. More...
 
std::string const & getMetaInfo (const std::string &meta) const
 Returns meta information for the given meta key. More...
 
bool isClassRegistered (std::string const &classIdentifier) const
 Return true if a class with the desired identifier is registered. More...
 
void eraseChild (Class const *const iClass)
 Remove the given child class from the class. More...
 
void eraseParent (Class const *const iClass)
 Remove the given class from the list of parents. More...
 
ClassProxy getClassByIdentifier (std::string const &classIdentifier) const
 Return the ClassProxy object for the desired Class. More...
 
std::vector< ClassProxygetClassByMeta (std::string const &metaKey, std::string const &metaValue) const
 Return vector of ClassProxy objects matching the meta criterion. More...
 
template<class T >
std::vector< ClassProxygetClassByMeta (T funcPtr) const
 Return vector of Class objects returning true for the given comparison function. More...
 
std::map< std::string, ClassProxygetDerivedClasses () const
 Return registered children for the associated class to the given map. More...
 
std::map< std::string, ClassProxygetDirectParents () const
 Return map with the direct parents of this class. More...
 
bool isBaseOf (Class const *const derived) const
 Return true if given class is registered and derived from this class. More...
 
bool isBaseOf (ClassProxy derived) const
 Return true if given class is registered and derived from this class. More...
 
bool isBaseOf (std::string const &identifier) const
 Return true if given class is registered and derived from this class. More...
 
bool isDerivedFrom (Class const *const base) const
 Return true if given class is registered and parent of this class. More...
 
bool isDerivedFrom (ClassProxy base) const
 Return true if given class is registered and parent of this class. More...
 
bool isDirectlyDerivedFrom (Class const *const base) const
 Return true if the given class is a direct parent. More...
 
bool isDirectlyDerivedFrom (ClassProxy base) const
 Return true if the given class is a direct parent. More...
 
bool isDeclaredAbstract () const
 Return true if the associated class is declared to be abstract (comparison with isAbstract() allows to detect programming errors.) More...
 
bool isLibraryLoaded () const
 Return true if the library which contains the associated class is loaded. More...
 
template<typename Reflector >
MIRA_SPLIT_REFLECT_MEMBER void reflectRead (Reflector &r)
 Implementation of class member reflection. More...
 
template<typename Reflector >
void reflectRead (Reflector &r)
 
template<typename Reflector >
void reflectWrite (Reflector &r)
 Implementation of class member reflection. More...
 
bool operator== (Class const &other) const
 Returns true, if the two classes are identical. More...
 
bool operator!= (Class const &other) const
 Returns true, if the two classes are not identical. More...
 
bool operator< (Class const &other) const
 Return true, if the comparison of the identifiers returns true. More...
 

Static Public Member Functions

static Classnull ()
 Returns the only single existing instance of a NullClass. More...
 

Protected Member Functions

virtual ObjectnewVAInstance (int paramCount, std::va_list) const
 Call the specific constructor depending on the number of parameters passed to the function. More...
 

Protected Attributes

std::map< std::string, ClassProxymDerivedChildren
 map of children More...
 
std::map< std::string, ClassProxymDirectParents
 map of parents More...
 
std::string mIdentifier
 class identifier More...
 
std::string mName
 class name More...
 
std::string mLib
 lib name More...
 
std::map< std::string, std::string > mMetaInfo
 meta info of class More...
 
bool mLibLoaded
 is associated lib loaded? More...
 

Detailed Description

Marker class for marking an invalid "null" class.

All class methods will raise an exception if they are called. This class can be used only to check if another class is "null".

Usage: const Class& c = ... ; if(c == NullClass::null()) ....

Constructor & Destructor Documentation

◆ ~NullClass()

virtual ~NullClass ( )
inlinevirtual

Member Function Documentation

◆ null()

static Class& null ( )
static

Returns the only single existing instance of a NullClass.

◆ getIdentifier()

virtual std::string const& getIdentifier ( ) const
virtual

Return identifier for the class.

The identifiers probably contains the namespace of the class.

Reimplemented from Class.

◆ getName()

virtual std::string const& getName ( ) const
virtual

Return name of the class.

The name will not contain any informations about the class namespace (if the macro for automatic extraction of the name has been used). Otherwise the function simply returns the name given in the object macro.

Reimplemented from Class.

◆ getTypeId()

virtual int getTypeId ( ) const
virtual

Return unique id for the class.

Keep in mind that this id is only valid during execution time and only for this process.

Implements Class.

◆ getTypename()

virtual Typename getTypename ( ) const
virtual

Returns the platform independent C++ typename of the class.

Implements Class.

◆ newInstance() [1/4]

virtual Object* newInstance ( ) const
virtual

Return a new instance of the class associated with the class object.

The derived TClass and VacantClasses will return the derived class type using covariant return types.

Exceptions
XFactoryLogicalIf the class is abstract.
XFactoryLogicalIf the class has no default constructor

Implements Class.

◆ newInstance() [2/4]

virtual Object* newInstance ( int  paramCount,
  ... 
) const
virtual

Return a new instance of the class associated with the class object.

A list of parameters for the constructor can be passed. The derived TClass and VacantClasses will NOT return the derived class type since the combination of va_list and covariant return types seems to be unsupported...

Exceptions
XFactoryLogicalIf the class is abstract.
XFactoryLogicalIf the class has no constructor matching the given parameter list (or if the constructor is not registered)

Implements Class.

◆ newInstance() [3/4]

virtual Object* newInstance ( std::string const &  childIdentifier) const
virtual

Return a new instance of the child class with the given identifier.

The derived TClass and VacantClasses will return the derived class type using covariant return types.

Exceptions
XFactoryLogicalIf the class is abstract.
XFactoryLogicalIf the class has no default constructor

Implements Class.

◆ newInstance() [4/4]

virtual Object* newInstance ( std::string const &  childIdentifier,
int  paramCount,
  ... 
) const
virtual

Return a new instance of the child class with the given identifier.

A list of parameters for the constructor can be passed. The derived TClass and VacantClasses will NOT return the derived class type since the combination of va_list and covariant return types seems to be unsupported...

Exceptions
XFactoryLogicalIf the class is abstract.
XFactoryLogicalIf the class has no constructor matching the given parameter list (or if the constructor is not registered)

Implements Class.

◆ isAbstract()

virtual bool isAbstract ( ) const
virtual

Return true if the associated class is abstract.

Implements Class.

◆ newVAInstance()

virtual Object* newVAInstance ( int  paramCount,
std::va_list   
) const
protectedvirtual

Call the specific constructor depending on the number of parameters passed to the function.

Implements Class.

◆ getMetaInfo() [1/2]

std::map<std::string, std::string> const& getMetaInfo ( ) const
inherited

Return map with meta information.

meta information is coded as key-value pair.

◆ getMetaInfo() [2/2]

std::string const& getMetaInfo ( const std::string &  meta) const
inherited

Returns meta information for the given meta key.

This method is provided for convenience. If the specified meta information is not available an empty string is returned.

◆ isClassRegistered()

bool isClassRegistered ( std::string const &  classIdentifier) const
inherited

Return true if a class with the desired identifier is registered.

◆ eraseChild()

void eraseChild ( Class const *const  iClass)
inherited

Remove the given child class from the class.

Calls eraseChild on all parents and removes the given class from its own child list.

◆ eraseParent()

void eraseParent ( Class const *const  iClass)
inherited

Remove the given class from the list of parents.

Calls eraseParent on all children and removes the given class from its own parent list.

◆ getClassByIdentifier()

ClassProxy getClassByIdentifier ( std::string const &  classIdentifier) const
inherited

Return the ClassProxy object for the desired Class.

Exceptions
XFactoryUnknownIf the identifier is unknown.

◆ getClassByMeta() [1/2]

std::vector<ClassProxy> getClassByMeta ( std::string const &  metaKey,
std::string const &  metaValue 
) const
inherited

Return vector of ClassProxy objects matching the meta criterion.

The returned classes matches the given metakey and metavalue.

◆ getClassByMeta() [2/2]

std::vector< ClassProxy > getClassByMeta ( funcPtr) const
inlineinherited

Return vector of Class objects returning true for the given comparison function.

The comparison function has to take the meta information std::map<std::string, std::string> const& as argument and should return true if the meta information matches the desired criterion.

◆ getDerivedClasses()

std::map<std::string, ClassProxy> getDerivedClasses ( ) const
inherited

Return registered children for the associated class to the given map.

◆ getDirectParents()

std::map<std::string, ClassProxy> getDirectParents ( ) const
inherited

Return map with the direct parents of this class.

◆ isBaseOf() [1/3]

bool isBaseOf ( Class const *const  derived) const
inherited

Return true if given class is registered and derived from this class.

◆ isBaseOf() [2/3]

bool isBaseOf ( ClassProxy  derived) const
inherited

Return true if given class is registered and derived from this class.

◆ isBaseOf() [3/3]

bool isBaseOf ( std::string const &  identifier) const
inherited

Return true if given class is registered and derived from this class.

◆ isDerivedFrom() [1/2]

bool isDerivedFrom ( Class const *const  base) const
inherited

Return true if given class is registered and parent of this class.

◆ isDerivedFrom() [2/2]

bool isDerivedFrom ( ClassProxy  base) const
inherited

Return true if given class is registered and parent of this class.

◆ isDirectlyDerivedFrom() [1/2]

bool isDirectlyDerivedFrom ( Class const *const  base) const
inherited

Return true if the given class is a direct parent.

◆ isDirectlyDerivedFrom() [2/2]

bool isDirectlyDerivedFrom ( ClassProxy  base) const
inherited

Return true if the given class is a direct parent.

◆ isDeclaredAbstract()

bool isDeclaredAbstract ( ) const
inherited

Return true if the associated class is declared to be abstract (comparison with isAbstract() allows to detect programming errors.)

◆ isLibraryLoaded()

bool isLibraryLoaded ( ) const
inherited

Return true if the library which contains the associated class is loaded.

TClass classes will return true and VacantClass classes will return false.

◆ reflectRead() [1/2]

MIRA_SPLIT_REFLECT_MEMBER void reflectRead ( Reflector &  r)
inherited

Implementation of class member reflection.

Attention: the default implementation will reflect the abstract key in order to read the information from the object. However, the abstract key will be ignored when writing information to the object.

◆ reflectRead() [2/2]

void reflectRead ( Reflector &  r)
inlineinherited

◆ reflectWrite()

void reflectWrite ( Reflector &  r)
inlineinherited

Implementation of class member reflection.

Attention: the default implementation will reflect the abstract key in order to read the information from the object. However, the abstract key will be ignored when writing information to the object.

◆ operator==()

bool operator== ( Class const &  other) const
inlineinherited

Returns true, if the two classes are identical.

◆ operator!=()

bool operator!= ( Class const &  other) const
inlineinherited

Returns true, if the two classes are not identical.

◆ operator<()

bool operator< ( Class const &  other) const
inlineinherited

Return true, if the comparison of the identifiers returns true.

Member Data Documentation

◆ mDerivedChildren

std::map<std::string, ClassProxy > mDerivedChildren
protectedinherited

map of children

◆ mDirectParents

std::map<std::string, ClassProxy> mDirectParents
protectedinherited

map of parents

◆ mIdentifier

std::string mIdentifier
protectedinherited

class identifier

◆ mName

std::string mName
protectedinherited

class name

◆ mLib

std::string mLib
protectedinherited

lib name

◆ mMetaInfo

std::map<std::string, std::string> mMetaInfo
protectedinherited

meta info of class

◆ mLibLoaded

bool mLibLoaded
protectedinherited

is associated lib loaded?


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