Class for struct type. More...

#include <TypeCode.hxx>

Inheritance diagram for YACS::ENGINE::TypeCodeStruct:

[legend]

Collaboration diagram for YACS::ENGINE::TypeCodeStruct:

[legend]

Public Member Functions
	TypeCodeStruct (const char repositoryId, const char name)
	Create a struct type with a given name and a given id. More...

TypeCode *	clone () const

void	putReprAtPlace (char pt, const char val, bool deepCpy) const

void	destroyZippedAny (char *data) const

AnyPtr	getOrBuildAnyFromZippedData (char *data) const

const char *	id () const

const char *	name () const

const char *	shortName () const

virtual unsigned	getSizeInByteOfAnyReprInSeq () const

const TypeCode *	contentType () const

virtual int	isA (const char *repositoryId) const
	Check if this TypeCode is derived from a TypeCode with a given id. More...

virtual int	isA (const TypeCode *tc) const
	Check if this TypeCode is derived from a given TypeCode. More...

virtual int	isAdaptable (const TypeCode *tc) const
	Check if this TypeCode is adaptable to a given TypeCode (tc) More...

virtual int	isEquivalent (const TypeCode *tc) const
	Check if this TypeCode can be used in place of tc. More...

virtual void	addMember (const std::string &name, TypeCode *tc)
	The only non const method. More...

const TypeCode *	getMember (const std::string &name, unsigned &offset) const
	Get typecode of struct member given its name. More...

int	memberCount () const

const char *	memberName (int index) const

TypeCode *	memberType (int index) const

Public Member Functions inherited from YACS::ENGINE::TypeCode
	TypeCode (DynType kind)

DynType	kind () const

const char *	getKindRepr () const

const TypeCode *	subContentType (int lev) const

virtual std::string	getPrintStr () const

Public Member Functions inherited from YACS::ENGINE::RefCounter
unsigned int	getRefCnt () const

void	incrRef () const

bool	decrRef () const

Protected Member Functions
virtual	~TypeCodeStruct ()

	TypeCodeStruct (const TypeCodeStruct &tc)

Protected Member Functions inherited from YACS::ENGINE::TypeCodeComposed
	TypeCodeComposed (const TypeCodeComposed &other)

	TypeCodeComposed (DynType kind, const char repositoryId, const char name)

Protected Member Functions inherited from YACS::ENGINE::TypeCode
	TypeCode (const TypeCode &tc)

TypeCode &	operator= (const TypeCode &tc)

virtual	~TypeCode ()

Protected Member Functions inherited from YACS::ENGINE::RefCounter
	RefCounter ()

	RefCounter (const RefCounter &other)

virtual	~RefCounter ()

Private Attributes
std::vector< std::pair< std::string, TypeCode * > >	_members

Friends
class	StructAny

Additional Inherited Members
Static Public Member Functions inherited from YACS::ENGINE::TypeCode
static const char *	getKindRepr (DynType kind)

static TypeCode *	interfaceTc (const char id, const char name)
	static factory of object reference type given an id and a name More...

static TypeCode *	interfaceTc (const char id, const char name, const std::list< TypeCodeObjref * > &ltc)
	static factory of object reference type given an id, a name and a list of base types More...

static TypeCode *	sequenceTc (const char id, const char name, TypeCode *content)
	static factory of sequence type given an id, a name and a content type More...

static TypeCode *	structTc (const char id, const char name)
	static factory of struct type given an id and a name More...

Static Public Attributes inherited from YACS::ENGINE::RefCounter
static unsigned int	_totalCnt =0

Protected Attributes inherited from YACS::ENGINE::TypeCodeComposed
const std::string	_name

const std::string	_repoId

std::string	_shortName

Protected Attributes inherited from YACS::ENGINE::TypeCode
const DynType	_kind

Protected Attributes inherited from YACS::ENGINE::RefCounter
unsigned int	_cnt

Static Protected Attributes inherited from YACS::ENGINE::TypeCode
static const char *	KIND_STR_REPR [] ={ "None", "double", "int", "string", "bool", "Objref", "Sequence", "Array","Struct" }

Detailed Description

Class for struct type.

Definition at line 227 of file TypeCode.hxx.

Constructor & Destructor Documentation

◆ TypeCodeStruct() [1/2]

TypeCodeStruct::TypeCodeStruct	(	const char *	repositoryId,
		const char *	name
	)

Create a struct type with a given name and a given id.

Parameters

repositoryId	: the given id
name	: the given name

Definition at line 644 of file TypeCode.cxx.

                                                  : TypeCodeComposed(Struct,repositoryId,name)
 {
 }

Referenced by clone().

◆ ~TypeCodeStruct()

TypeCodeStruct::~TypeCodeStruct ( )

protectedvirtual

Definition at line 649 of file TypeCode.cxx.

 {
   for(vector< pair<string,TypeCode*> >::iterator iter=_members.begin();iter!=_members.end();iter++)
     (*iter).second->decrRef();
 }

References _members.

◆ TypeCodeStruct() [2/2]

TypeCodeStruct::TypeCodeStruct ( const TypeCodeStruct & tc )

protected

Definition at line 660 of file TypeCode.cxx.

                                                       :TypeCodeComposed(tc),_members(tc._members)
 {
   for(vector< std::pair<std::string,TypeCode*> >::iterator iter=_members.begin();iter!=_members.end();iter++)
     (*iter).second->incrRef();
 }

References _members, and YACS::ENGINE::RefCounter::incrRef().

Member Function Documentation

◆ addMember()

void TypeCodeStruct::addMember	(	const std::string &	name,
		TypeCode *	tc
	)

virtual

The only non const method.

Definition at line 781 of file TypeCode.cxx.

 {
   DEBTRACE(name << " " << tc->name());
   std::vector< std::pair<std::string,TypeCode*> >::const_iterator iter;
   for(iter=_members.begin();iter != _members.end(); iter++)
     {
       if((*iter).first == name)
         throw Exception("Struct member " + name + " already defined");
     }
   _members.push_back(std::pair<std::string,TypeCode*>(name,tc));
   tc->incrRef();
 }

References _members, DEBTRACE, YACS::ENGINE::RefCounter::incrRef(), YACS::ENGINE::TypeCode::name(), and name().

Referenced by YACS::ENGINE::Runtime::Runtime().

◆ clone()

TypeCode * TypeCodeStruct::clone ( ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 655 of file TypeCode.cxx.

 {
   return new TypeCodeStruct(*this);
 }

References TypeCodeStruct().

◆ contentType()

const TypeCode * TypeCodeStruct::contentType ( ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 704 of file TypeCode.cxx.

 {
   const char what[]="Content type is specified by giving a key.";
   throw Exception(what);
 }

◆ destroyZippedAny()

void TypeCodeStruct::destroyZippedAny ( char * data ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 671 of file TypeCode.cxx.

 {
   StructAny::destroyReprAtPlace(data,this);
 }

References YACS::ENGINE::StructAny::destroyReprAtPlace().

◆ getMember()

const TypeCode * TypeCodeStruct::getMember	(	const std::string &	name,
		unsigned &	offset
	)		const

Get typecode of struct member given its name.

If name is not an existing key, 0 is returned.

Parameters

name	: the member name
offset	: Out parameter, that specified the location of start of data discriminated by name key.

Returns: the member TypeCode

Definition at line 801 of file TypeCode.cxx.

 {
   std::vector< std::pair<std::string,TypeCode*> >::const_iterator iter;
   offset=0;
   for(iter=_members.begin();iter != _members.end(); iter++)
     {
       if((*iter).first==name)
         return (*iter).second;
       offset+=(*iter).second->getSizeInByteOfAnyReprInSeq();
     }
   return 0;
 }

References _members, YACS::ENGINE::TypeCode::getSizeInByteOfAnyReprInSeq(), and name().

Referenced by YACS::ENGINE::StructAny::setEltAtRank().

◆ getOrBuildAnyFromZippedData()

AnyPtr TypeCodeStruct::getOrBuildAnyFromZippedData ( char * data ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 676 of file TypeCode.cxx.

 {
   return StructAny::getOrBuildFromData(data,this);
 }

References YACS::ENGINE::StructAny::getOrBuildFromData().

◆ getSizeInByteOfAnyReprInSeq()

unsigned TypeCodeStruct::getSizeInByteOfAnyReprInSeq ( ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 696 of file TypeCode.cxx.

 {
   unsigned ret=0;
   for(vector< pair<string,TypeCode*> >::const_iterator iter=_members.begin();iter!=_members.end();iter++)
     ret+=(*iter).second->getSizeInByteOfAnyReprInSeq();
   return ret;
 }

References _members.

◆ id()

const char * TypeCodeStruct::id ( ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 681 of file TypeCode.cxx.

 {
   return _repoId.c_str();
 };

References YACS::ENGINE::TypeCodeComposed::_repoId.

◆ isA() [1/2]

int TypeCodeStruct::isA ( const char * id ) const

virtual

Check if this TypeCode is derived from a TypeCode with a given id.

Parameters

id	: a given id

Returns: 1 if true, 0 if false

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 715 of file TypeCode.cxx.

 {
   if(_repoId == id)return 1;
   return 0;
 }

References YACS::ENGINE::TypeCodeComposed::_repoId.

Referenced by isA().

◆ isA() [2/2]

int TypeCodeStruct::isA ( const TypeCode * tc ) const

virtual

Check if this TypeCode is derived from a given TypeCode.

Parameters

tc	: the given TypeCode

Returns: 1 if true, 0 if false

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 726 of file TypeCode.cxx.

 {
   if(_kind != tc->kind()) return 0;
   if(_repoId == tc->id())return 1;
   int nMember=memberCount();
   if(nMember != ((TypeCodeStruct*)tc)->memberCount())return 0;
   for(int i=0;i<nMember;i++)
     {
        const char * name=memberName(i);
        if(strcmp(memberName(i),((TypeCodeStruct*)tc)->memberName(i)) != 0)return 0;
        if(!memberType(i)->isA(((TypeCodeStruct*)tc)->memberType(i)))return 0;
     }
   return 1;
 }

References YACS::ENGINE::TypeCode::_kind, YACS::ENGINE::TypeCodeComposed::_repoId, yacsorb.CORBAEngineTest::i, YACS::ENGINE::TypeCode::id(), isA(), YACS::ENGINE::TypeCode::kind(), memberCount(), memberName(), memberType(), and name().

◆ isAdaptable()

int TypeCodeStruct::isAdaptable ( const TypeCode * tc ) const

virtual

Check if this TypeCode is adaptable to a given TypeCode (tc)

Parameters

tc	: the given TypeCode

Returns: 1 if true, 0 if false

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 746 of file TypeCode.cxx.

 {
   if (_kind != tc->kind()) return 0;
   if (_repoId == tc->id()) return 1;
   int nMember = memberCount();
   if (nMember != ((TypeCodeStruct*)tc)->memberCount()) return 0;
   for (int i=0 ; i<nMember ; i++)
     {
       const char * name = memberName(i);
       if (strcmp(memberName(i), ((TypeCodeStruct*)tc)->memberName(i)) != 0) return 0;
       if (!memberType(i)->isAdaptable(((TypeCodeStruct*)tc)->memberType(i))) return 0;
     }
   return 1;
 }

References YACS::ENGINE::TypeCode::_kind, YACS::ENGINE::TypeCodeComposed::_repoId, yacsorb.CORBAEngineTest::i, YACS::ENGINE::TypeCode::id(), YACS::ENGINE::TypeCode::kind(), memberCount(), memberName(), memberType(), and name().

◆ isEquivalent()

int TypeCodeStruct::isEquivalent ( const TypeCode * tc ) const

virtual

Check if this TypeCode can be used in place of tc.

this TypeCode is equivalent to tc if they have the same kind

Parameters

tc	: the TypeCode to compare

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 767 of file TypeCode.cxx.

 {
   if(_kind != tc->kind()) return 0;
   int nMember=memberCount();
   if(nMember != ((TypeCodeStruct*)tc)->memberCount())return 0;
   for(int i=0;i<nMember;i++)
     {
        const char * name=memberName(i);
        if(strcmp(memberName(i),((TypeCodeStruct*)tc)->memberName(i)) != 0)return 0;
        if(!memberType(i)->isEquivalent(((TypeCodeStruct*)tc)->memberType(i)))return 0;
     }
   return 1;
 }

References YACS::ENGINE::TypeCode::_kind, yacsorb.CORBAEngineTest::i, YACS::ENGINE::TypeCode::kind(), memberCount(), memberName(), memberType(), and name().

◆ memberCount()

int TypeCodeStruct::memberCount ( ) const

Definition at line 814 of file TypeCode.cxx.

 {
   return _members.size();
 }

References _members.

Referenced by YACS::ENGINE::checkStruct< PYTHONImpl, PyObject *, void * >(), YACS::ENGINE::convertToYacsStruct< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertFromYacsStruct< CORBAImpl, CORBA::Any * >::convert(), YACS::ENGINE::convertToYacsStruct< XMLImpl, xmlDocPtr, xmlNodePtr, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertToYacsStruct< NEUTRALImpl, YACS::ENGINE::Any *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::VisitorSaveSchema::dumpTypeCode(), YACS::ENGINE::getCorbaTCStruct(), isA(), isAdaptable(), and isEquivalent().

◆ memberName()

const char * TypeCodeStruct::memberName ( int index ) const

Definition at line 819 of file TypeCode.cxx.

 {
   if(index > _members.size())
     {
       stringstream msg;
       msg << "Struct size less than " << index;
       msg << " : " << __FILE__ << ":" << __LINE__;
       throw Exception(msg.str());
     }
   return _members[index].first.c_str();
 }

References _members.

Referenced by YACS::ENGINE::checkStruct< PYTHONImpl, PyObject *, void * >(), YACS::ENGINE::convertToYacsStruct< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertFromYacsStruct< CORBAImpl, CORBA::Any * >::convert(), YACS::ENGINE::convertToYacsStruct< XMLImpl, xmlDocPtr, xmlNodePtr, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertToYacsStruct< NEUTRALImpl, YACS::ENGINE::Any *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::VisitorSaveSchema::dumpTypeCode(), YACS::ENGINE::getCorbaTCStruct(), isA(), isAdaptable(), and isEquivalent().

◆ memberType()

TypeCode * TypeCodeStruct::memberType ( int index ) const

Definition at line 831 of file TypeCode.cxx.

 {
   if(index > _members.size())
     {
       stringstream msg;
       msg << "Struct size less than " << index;
       msg << " : " << __FILE__ << ":" << __LINE__;
       throw Exception(msg.str());
     }
   return _members[index].second;
 }

References _members.

Referenced by YACS::ENGINE::checkStruct< PYTHONImpl, PyObject *, void * >(), YACS::ENGINE::convertToYacsStruct< CORBAImpl, CORBA::Any *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertToYacsStruct< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertToYacsStruct< XMLImpl, xmlDocPtr, xmlNodePtr, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertToYacsStruct< NEUTRALImpl, YACS::ENGINE::Any *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::VisitorSaveSchema::dumpTypeCode(), YACS::ENGINE::getCorbaTCStruct(), isA(), isAdaptable(), and isEquivalent().

◆ name()

const char * TypeCodeStruct::name ( ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 686 of file TypeCode.cxx.

 {
   return _name.c_str();
 }

References YACS::ENGINE::TypeCodeComposed::_name.

Referenced by addMember(), getMember(), isA(), isAdaptable(), and isEquivalent().

◆ putReprAtPlace()

void TypeCodeStruct::putReprAtPlace	(	char *	pt,
		const char *	val,
		bool	deepCpy
	)		const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 666 of file TypeCode.cxx.

 {
   StructAny::putReprAtPlace(pt,val,this,deepCpy);
 }

References YACS::ENGINE::StructAny::putReprAtPlace().

◆ shortName()

const char * TypeCodeStruct::shortName ( ) const

virtual

Reimplemented from YACS::ENGINE::TypeCode.

Definition at line 691 of file TypeCode.cxx.

 {
   return _shortName.c_str();
 }

References YACS::ENGINE::TypeCodeComposed::_shortName.

Friends And Related Function Documentation

◆ StructAny

friend class StructAny

friend

Definition at line 229 of file TypeCode.hxx.

Member Data Documentation

◆ _members

std::vector< std::pair<std::string,TypeCode*> > YACS::ENGINE::TypeCodeStruct::_members

private

Definition at line 257 of file TypeCode.hxx.

Referenced by addMember(), YACS::ENGINE::StructAny::destroyReprAtPlace(), getMember(), getSizeInByteOfAnyReprInSeq(), memberCount(), memberName(), memberType(), YACS::ENGINE::StructAny::operator==(), YACS::ENGINE::StructAny::operator[](), YACS::ENGINE::StructAny::putMyReprAtPlace(), YACS::ENGINE::StructAny::putReprAtPlace(), YACS::ENGINE::StructAny::StructAny(), TypeCodeStruct(), YACS::ENGINE::StructAny::~StructAny(), and ~TypeCodeStruct().

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

src/engine/TypeCode.hxx
src/engine/TypeCode.cxx

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TypeCodeStruct() [1/2]

◆ ~TypeCodeStruct()

◆ TypeCodeStruct() [2/2]

Member Function Documentation

◆ addMember()

◆ clone()

◆ contentType()

◆ destroyZippedAny()

◆ getMember()

◆ getOrBuildAnyFromZippedData()

◆ getSizeInByteOfAnyReprInSeq()

◆ id()

◆ isA() [1/2]

◆ isA() [2/2]

◆ isAdaptable()

◆ isEquivalent()

◆ memberCount()

◆ memberName()

◆ memberType()

◆ name()

◆ putReprAtPlace()

◆ shortName()

Friends And Related Function Documentation

◆ StructAny

Member Data Documentation

◆ _members