Class SBCMetaValueBase

ClassList > SBCMetaValueBase

This class is the base class of value holders. More...

• #include <SBCMetaValueBase.hpp>

Inherited by the following classes: SBCMetaValueType, SBCMetaValueType

Public Functions

Type	Name
virtual SBCMetaValueBase *	call (const SBCMetaValue & object, const std::string & functionName, const SBCMetaValue & t0, const SBCMetaValue & t1, const SBCMetaValue & t2, const SBCMetaValue & t3, const SBCMetaValue & t4, const SBCMetaValue & t5, const SBCMetaValue & t6, const SBCMetaValue & t7, const SBCMetaValue & t8, const SBCMetaValue & t9, const SBCMetaValue & t10, const SBCMetaValue & t11, const SBCMetaValue & t12, const SBCMetaValue & t13, const SBCMetaValue & t14, const SBCMetaValue & t15) const Calls the function functionName of the value with argumentst0 ,t1 , ...,t15 .
virtual void	clear (const SBCMetaValue & object, const std::string & attributeName) const Clears attribute attributeName from the value when possible.
virtual SBCMetaValueBase *	clone () const Clones the value.
virtual SBCMetaValueBase *	constCall (const SBCMetaValue & object, const std::string & functionName, const SBCMetaValue & t0, const SBCMetaValue & t1, const SBCMetaValue & t2, const SBCMetaValue & t3, const SBCMetaValue & t4, const SBCMetaValue & t5, const SBCMetaValue & t6, const SBCMetaValue & t7, const SBCMetaValue & t8, const SBCMetaValue & t9, const SBCMetaValue & t10, const SBCMetaValue & t11, const SBCMetaValue & t12, const SBCMetaValue & t13, const SBCMetaValue & t14, const SBCMetaValue & t15) const Calls the const function functionName of the value with argumentst0 ,t1 , ...,t15 .
virtual SBCMetaValueBase *	get (const SBCMetaValue & object, const std::string & attributeName) const Returns the value of attribute attributeName for this value.
virtual SBCMetaValueBase *	getBaseType () const Returns the base type.
virtual std::string	getBaseTypeName () const Returns the base type name.
virtual SBCMetaValueBase *	getClassType () const Returns the class type.
virtual std::string	getClassTypeName () const Returns the class type name.
virtual unsigned int	getNumberOfParameters () const Returns the number of parameters of a function type.
virtual SBCMetaValueBase *	getOutputType () const Returns the output type.
virtual std::string	getOutputTypeName () const Returns the output type name.
virtual SBCMetaValueBase *	getParameterType (unsigned int i) const Returns the type of parameter i .
virtual std::string	getParameterTypeName (unsigned int i) const Returns the type name of parameter i .
virtual SBCMetaValueBase *	getParentType () const Returns the parent type.
virtual std::string	getParentTypeName () const Returns the parent type name.
virtual SBCClassProxy *	getProxy () const Returns the proxy of the value.
virtual SBCMetaValueBase *	getRootType () const Returns the root type.
virtual std::string	getRootTypeName () const Returns the root type name.
virtual std::string	getShortBaseTypeName () const Returns the short base type name.
virtual std::string	getShortClassTypeName () const Returns the short class type name.
virtual std::string	getShortOutputTypeName () const Returns the short output type name.
virtual std::string	getShortParameterTypeName (unsigned int i) const Returns the short type name of parameter i .
virtual std::string	getShortParentTypeName () const Returns the short parent type name.
virtual std::string	getShortRootTypeName () const Returns the short root type name.
virtual std::string	getShortTypeName () const Returns the short type name.
virtual unsigned int	getSize (const SBCMetaValue & object, const std::string & attributeName) const Returns the size of attribute attributeName in the value when relevant.
virtual std::string	getTypeName () const Returns the type name.
virtual SBCContainerUUID	getTypeUUID () const Returns the type UUID .
virtual bool	has (const SBCMetaValue & object, const std::string & attributeName) const Returns whether attribute attributeName exists in the value and has a value.
virtual bool	hasBaseType () const Returns true if the value is of a type that has a base type.
virtual bool	isArrayType () const Returns true if the value is of an array type.
virtual bool	isClassType () const Returns true if the value is of a class type.
virtual bool	isConstType () const Returns true if the value is of a const type.
virtual bool	isEnumType () const Returns true if the value is of an enum type.
virtual bool	isFunctionType () const Returns true if the value is of a function type.
virtual bool	isFundamentalType () const Returns true if the value is of a fundamental type.
virtual bool	isPointerToFunctionType () const Returns true if the value is of a pointer to function type.
virtual bool	isPointerToMemberFunctionType () const Returns true if the value is of a pointer to member function type.
virtual bool	isPointerToMemberType () const Returns true if the value is of a pointer to member type.
virtual bool	isPointerType () const Returns true if the value is of a pointer type.
virtual bool	isReferenceType () const Returns true if the value is of a reference type.
virtual bool	isRegisteredType () const Returns true if the value is of a registered type.
virtual bool	isVolatileType () const Returns true if the value is of a volatile type.
virtual void	set (const SBCMetaValue & object, const std::string & attributeName, const SBCMetaValue & value, const SBCMetaValue & size) const Sets the value of attribute attributeName for this value tovalue .
virtual	~SBCMetaValueBase () Destructs the value.

Protected Functions

Type	Name
	SBCMetaValueBase () Constructs a value.

Detailed Description

This class is the base class of value holders, and a key component of the introspection mechanism. In particular, it is the direct base class of the template class SBCMetaValueType, used to contain type information, which is itself the direct base class of the template class SBCMetaValueHolder, used to hold values.

Assume a SAMSON Extension called SEElement defines a class A, and another Extension called SEOtherElement wants to use it. If the Extension called SEOtherElement does not have access to the declaration of class A (typically provided in a header file included in SEElement), it cannot use the symbol A in its source code. For example, if the source code of SEOtherElement contained the line:

A* a = new A();

the compiler would complain that the symbol A is not defined.

In order to provide access to exposed classes, SAMSON uses a mechanism to hold values (for example, pointers to objects) in a uniform way. In the example above, the constructor exposed in the Extension SEElement returns a value holder that stores a pointer to the new instance of class A:

return new SBValueHolder<A*>(new A());

and the Extension SEOtherElement sees this value holder as a pointer to a SBValueBase (the base class of SBValueHolder<A*>):

SBValue* objectHolder = classProxy->createInstance();

This class is able to provide information about a held type or a held value.

Short name: SBValueBase

See also: SBCMetaType, SBCMetaValueType, SBCMetaValueHolder

See also: Introspection

Public Functions Documentation

function call

Calls the function functionName of the value with argumentst0 ,t1 , ...,t15 .

virtual SBCMetaValueBase * SBCMetaValueBase::call (
    const SBCMetaValue & object,
    const std::string & functionName,
    const SBCMetaValue & t0,
    const SBCMetaValue & t1,
    const SBCMetaValue & t2,
    const SBCMetaValue & t3,
    const SBCMetaValue & t4,
    const SBCMetaValue & t5,
    const SBCMetaValue & t6,
    const SBCMetaValue & t7,
    const SBCMetaValue & t8,
    const SBCMetaValue & t9,
    const SBCMetaValue & t10,
    const SBCMetaValue & t11,
    const SBCMetaValue & t12,
    const SBCMetaValue & t13,
    const SBCMetaValue & t14,
    const SBCMetaValue & t15
) const

---

function clear

Clears attribute attributeName from the value when possible.

virtual void SBCMetaValueBase::clear (
    const SBCMetaValue & object,
    const std::string & attributeName
) const

---

function clone

Clones the value.

virtual SBCMetaValueBase * SBCMetaValueBase::clone () const

---

function constCall

Calls the const function functionName of the value with argumentst0 ,t1 , ...,t15 .

virtual SBCMetaValueBase * SBCMetaValueBase::constCall (
    const SBCMetaValue & object,
    const std::string & functionName,
    const SBCMetaValue & t0,
    const SBCMetaValue & t1,
    const SBCMetaValue & t2,
    const SBCMetaValue & t3,
    const SBCMetaValue & t4,
    const SBCMetaValue & t5,
    const SBCMetaValue & t6,
    const SBCMetaValue & t7,
    const SBCMetaValue & t8,
    const SBCMetaValue & t9,
    const SBCMetaValue & t10,
    const SBCMetaValue & t11,
    const SBCMetaValue & t12,
    const SBCMetaValue & t13,
    const SBCMetaValue & t14,
    const SBCMetaValue & t15
) const

---

function get

Returns the value of attribute attributeName for this value.

virtual SBCMetaValueBase * SBCMetaValueBase::get (
    const SBCMetaValue & object,
    const std::string & attributeName
) const

---

function getBaseType

Returns the base type.

virtual SBCMetaValueBase * SBCMetaValueBase::getBaseType () const

This function returns the base type, i.e. an instance of the template class SBCMetaValueType which contains type information about the base type of this type. For example, the base type of SBMStructuralModelNodeAtom is SBMStructuralModelNode.

Note that this function returns a type. If a string is needed, use SBCMetaValueBase::getBaseTypeName().

See also: SBCMetaValueBase::getBaseTypeName()

---

function getBaseTypeName

Returns the base type name.

virtual std::string SBCMetaValueBase::getBaseTypeName () const

This function returns the type name of the base type of T. For example, the base type name of SBMStructuralModelNodeAtom is "SBMStructuralModelNode".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getBaseType().

See also: SBCMetaValueBase::getBaseType()

---

function getClassType

Returns the class type.

virtual SBCMetaValueBase * SBCMetaValueBase::getClassType () const

This function returns the class type, i.e. an instance of the template class SBCMetaValueType which contains type information about the class type of this type, when the type is a pointer to a member or a pointer to a member function. For example, the class type name of & SBMStructuralModelNodeAtom::clearName is SBMStructuralModelNodeAtom.

Note that this function returns a type. If a string is needed, use SBCMetaValueBase::getClassTypeName().

See also: SBCMetaValueBase::getClassTypeName()

---

function getClassTypeName

Returns the class type name.

virtual std::string SBCMetaValueBase::getClassTypeName () const

This function returns the type name of the class associated to T, when T is a pointer to a member or a pointer to a member function ("void" otherwise). For example, the class type name of & SBMStructuralModelNodeAtom::clearName is "SBMStructuralModelNodeAtom".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getClassType().

See also: SBCMetaValueBase::getClassType()

---

function getNumberOfParameters

Returns the number of parameters of a function type.

virtual unsigned int SBCMetaValueBase::getNumberOfParameters () const

---

function getOutputType

Returns the output type.

virtual SBCMetaValueBase * SBCMetaValueBase::getOutputType () const

This function returns the output type, i.e. an instance of the template class SBCMetaValueType which contains type information about the output type of this type, when the type is a function. For example, the output type name of SBMStructuralModelNodeAtom* getFirstAtom() is SBMStructuralModelNodeAtom.

Note that this function returns a type. If a string is needed, use SBCMetaValueBase::getOutputTypeName().

See also: SBCMetaValueBase::getOutputTypeName()

---

function getOutputTypeName

Returns the output type name.

virtual std::string SBCMetaValueBase::getOutputTypeName () const

This function returns the type name of the output type of T, when T is a function. For example, the output type name of SBMStructuralModelNodeAtom* getFirstAtom() is "SBMStructuralModelNodeAtom*".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getOutputType().

See also: SBCMetaValueBase::getOutputType()

---

function getParameterType

Returns the type of parameter i .

virtual SBCMetaValueBase * SBCMetaValueBase::getParameterType (
    unsigned int i
) const

This function returns the type of parameter i, , i.e. an instance of the template class SBCMetaValueType which contains type information about the type of parameter i, when the type is a function. For example, the type name of parameter 2 of myFunction(int, double, const SBMStructuralModelNodeAtom*) is const SBMStructuralModelNodeAtom*.

Note that this function returns a type. If a string is needed, use SBCMetaValueBase::getParameterTypeName().

See also: SBCMetaValueBase::getParameterTypeName()

---

function getParameterTypeName

Returns the type name of parameter i .

virtual std::string SBCMetaValueBase::getParameterTypeName (
    unsigned int i
) const

This function returns the type name of parameter i of type T, when T is a function ("void" otherwise). For example, the type name of parameter 2 of myFunction(int, double, const SBMStructuralModelNodeAtom*) is "const SBMStructuralModelNodeAtom*".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getParameterType().

See also: SBCMetaValueBase::getParameterType()

---

function getParentType

Returns the parent type.

virtual SBCMetaValueBase * SBCMetaValueBase::getParentType () const

This function returns the parent type, i.e. an instance of the template class SBCMetaValueType which contains type information about the parent type of this type. For example, the parent type of int* is int.

Note that this function returns a type. If a string is needed, use SBCMetaValueBase::getParentTypeName().

See also: SBCMetaValueBase::getParentTypeName()

---

function getParentTypeName

Returns the parent type name.

virtual std::string SBCMetaValueBase::getParentTypeName () const

This function returns the type name of the parent type of T. For example, the parent type name of int* is "int".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getParentType().

See also: SBCMetaValueBase::getParentType()

See also: SBCMetaValueBase::getRootTypeName()

---

function getProxy

Returns the proxy of the value.

virtual SBCClassProxy * SBCMetaValueBase::getProxy () const

---

function getRootType

Returns the root type.

virtual SBCMetaValueBase * SBCMetaValueBase::getRootType () const

This function returns the root type, i.e. an instance of the template class SBCMetaValueType which contains type information about the root type of this type. For example, the root type of const std::string& is std::string.

Note that this function returns a type. If a string is needed, use SBCMetaValueBase::getRootTypeName().

See also: SBCMetaValueBase::getRootTypeName()

---

function getRootTypeName

Returns the root type name.

virtual std::string SBCMetaValueBase::getRootTypeName () const

This function returns the type name of the root type of T. For example, the root type name of const std::string& is "std::string".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getRootType().

See also: SBCMetaValueBase::getRootType()

See also: SBCMetaValueBase::getParentTypeName()

---

function getShortBaseTypeName

Returns the short base type name.

virtual std::string SBCMetaValueBase::getShortBaseTypeName () const

This function returns the short type name of the base type of T. For example, the short base type name of SBMStructuralModelNodeAtom is "SBNode".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getBaseType().

See also: SBCMetaValueBase::getBaseType()

---

function getShortClassTypeName

Returns the short class type name.

virtual std::string SBCMetaValueBase::getShortClassTypeName () const

This function returns the short type name of the class associated to T, when T is a pointer to a member or a pointer to a member function ("void" otherwise). For example, the short class type name of & SBMStructuralModelNodeAtom::clearName is "SBAtom*".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getClassType().

See also: SBCMetaValueBase::getClassType()

---

function getShortOutputTypeName

Returns the short output type name.

virtual std::string SBCMetaValueBase::getShortOutputTypeName () const

This function returns the short type name of the output type of T, when T is a function. For example, the short output type name of SBMStructuralModelNodeAtom* getFirstAtom() is "SBAtom".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getOutputType().

See also: SBCMetaValueBase::getOutputType()

---

function getShortParameterTypeName

Returns the short type name of parameter i .

virtual std::string SBCMetaValueBase::getShortParameterTypeName (
    unsigned int i
) const

This function returns the short type name of parameter i of type T, when T is a function ("void" otherwise). For example, the short type name of parameter 2 of myFunction(int, double, const SBMStructuralModelNodeAtom*) is "const SBAtom*".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getParameterType().

See also: SBCMetaValueBase::getParameterType()

---

function getShortParentTypeName

Returns the short parent type name.

virtual std::string SBCMetaValueBase::getShortParentTypeName () const

This function returns the short type name of the parent type of T. For example, the short parent type name of SBMStructuralModelNodeAtom* is "SBAtom".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getParentType().

See also: SBCMetaValueBase::getParentType()

See also: SBCMetaValueBase::getShortRootTypeName()

---

function getShortRootTypeName

Returns the short root type name.

virtual std::string SBCMetaValueBase::getShortRootTypeName () const

This function returns the type name of the root type of T. For example, the short root type name of const SBMStructuralModelNodeAtom & is "SBAtom".

Note that this function returns a string. If a type is needed, use SBCMetaValueBase::getRootType().

See also: SBCMetaValueBase::getRootType()

See also: SBCMetaValueBase::getShortParentTypeName()

---

function getShortTypeName

Returns the short type name.

virtual std::string SBCMetaValueBase::getShortTypeName () const

When the type T is fundamental, this function returns a string containing the fundamental type (e.g. "unsigned int"). When T is registered, this function returns its short type name. Else, this function recursively decomposes the type in order to provide a string describing it, but using short names (e.g. "const SBAtom*").

---

function getSize

Returns the size of attribute attributeName in the value when relevant.

virtual unsigned int SBCMetaValueBase::getSize (
    const SBCMetaValue & object,
    const std::string & attributeName
) const

---

function getTypeName

Returns the type name.

virtual std::string SBCMetaValueBase::getTypeName () const

When the type T is fundamental, this function returns a string containing the fundamental type (e.g. "unsigned int"). When T is registered, this function returns its type name. Else, this function recursively decomposes the type in order to provide a string describing it (e.g. "const SBMStructuralModelNodeAtom*").

---

function getTypeUUID

Returns the type UUID .

virtual SBCContainerUUID SBCMetaValueBase::getTypeUUID () const

If the type is registered, this function returns the associated UUID. Else, the function returns an invalid UUID.

---

function has

Returns whether attribute attributeName exists in the value and has a value.

virtual bool SBCMetaValueBase::has (
    const SBCMetaValue & object,
    const std::string & attributeName
) const

---

function hasBaseType

Returns true if the value is of a type that has a base type.

virtual bool SBCMetaValueBase::hasBaseType () const

---

function isArrayType

Returns true if the value is of an array type.

virtual bool SBCMetaValueBase::isArrayType () const

---

function isClassType

Returns true if the value is of a class type.

virtual bool SBCMetaValueBase::isClassType () const

---

function isConstType

Returns true if the value is of a const type.

virtual bool SBCMetaValueBase::isConstType () const

---

function isEnumType

Returns true if the value is of an enum type.

virtual bool SBCMetaValueBase::isEnumType () const

---

function isFunctionType

Returns true if the value is of a function type.

virtual bool SBCMetaValueBase::isFunctionType () const

---

function isFundamentalType

Returns true if the value is of a fundamental type.

virtual bool SBCMetaValueBase::isFundamentalType () const

Returns true if the value is of a fundamental type (void, bool, char, signed char, unsigned char, wchar_t, short, unsigned short, int, unsigned int, long, unsigned long, float, double or long double).

---

function isPointerToFunctionType

Returns true if the value is of a pointer to function type.

virtual bool SBCMetaValueBase::isPointerToFunctionType () const

---

function isPointerToMemberFunctionType

Returns true if the value is of a pointer to member function type.

virtual bool SBCMetaValueBase::isPointerToMemberFunctionType () const

---

function isPointerToMemberType

Returns true if the value is of a pointer to member type.

virtual bool SBCMetaValueBase::isPointerToMemberType () const

---

function isPointerType

Returns true if the value is of a pointer type.

virtual bool SBCMetaValueBase::isPointerType () const

---

function isReferenceType

Returns true if the value is of a reference type.

virtual bool SBCMetaValueBase::isReferenceType () const

---

function isRegisteredType

Returns true if the value is of a registered type.

virtual bool SBCMetaValueBase::isRegisteredType () const

---

function isVolatileType

Returns true if the value is of a volatile type.

virtual bool SBCMetaValueBase::isVolatileType () const

---

function set

Sets the value of attribute attributeName for this value tovalue .

virtual void SBCMetaValueBase::set (
    const SBCMetaValue & object,
    const std::string & attributeName,
    const SBCMetaValue & value,
    const SBCMetaValue & size
) const

---

function ~SBCMetaValueBase

Destructs the value.

virtual SBCMetaValueBase::~SBCMetaValueBase () 

---

Protected Functions Documentation

function SBCMetaValueBase

Constructs a value.

SBCMetaValueBase::SBCMetaValueBase () 

---