pool::Container Class Reference

Container is an implementation of the IContainer interface. More...

#include <Container.h>

Inheritance diagram for pool::Container:

Collaboration diagram for pool::Container:

Public Member Functions
	Container (FileDescriptor &fileDescriptor, long technology, const std::string &name)
virtual	~Container ()=default
	destructor
virtual const std::string &	name () const override final
	Returns the name of this container.
virtual long	technology () const override final
	Returns the technology identifier for this container.
virtual ITokenIterator *	tokens () override
	Starts an iteration over the tokens in the container.
virtual ITechnologySpecificAttributes &	technologySpecificAttributes () override final
	Returns the object holding the technology specific attributes for a given technology domain.
template<class T>
T	attribute (const std::string &attributeName, const std::string &option="")
	Templated method to retrieve an attribute.
template<class T>
bool	setAttribute (const std::string &attributeName, const T &atttibuteValue, const std::string &option="")
	Templated method to set an attribute.

Protected Member Functions
virtual bool	attributeOfType (const std::string &attributeName, void *data, const std::type_info &typeInfo, const std::string &option) override
	The actual method returning the attribute data given a name.
virtual bool	setAttributeOfType (const std::string &attributeName, const void *data, const std::type_info &typeInfo, const std::string &option) override
	The actual method setting the attribute data given a name.

Private Attributes
std::string	m_name
	The name of the container.
FileDescriptor &	m_fileDescriptor
	Reference to file descriptor of the parent database.
long	m_technology
	The technology identifier.

Detailed Description

Container is an implementation of the IContainer interface.

Definition at line 23 of file Container.h.

Constructor & Destructor Documentation

Container()

pool::Container::Container	(	FileDescriptor &	fileDescriptor,
		long	technology,
		const std::string &	name )

Definition at line 13 of file Container.cxx.

                                                                   :
  m_name( name ),
  m_fileDescriptor( fileDescriptor ),
  m_technology( technology )
{}

~Container()

virtual pool::Container::~Container ( )

virtualdefault

destructor

Member Function Documentation

attribute()

template<class T>

T pool::ITechnologySpecificAttributes::attribute ( const std::string & attributeName, const std::string & option = "" )

inlineinherited

Templated method to retrieve an attribute.

Definition at line 25 of file ITechnologySpecificAttributes.h.

                                                                  {
      T data;
      const std::type_info& typeInfo = typeid(T);
      if ( ! this->attributeOfType( attributeName,
                                    static_cast< void* >( &data ),
                                    typeInfo,
                                    option ) ) {
        std::ostringstream error;
        error << "Failed to retrieve attribute " << attributeName << " of type " << typeInfo.name();
        throw std::runtime_error( error.str() + " (APR: \" ITechnologySpecificAttributes \" from \" PersistencySvc \")");
      }
      return data;
    }

attributeOfType()

bool pool::Container::attributeOfType ( const std::string & attributeName, void * data, const std::type_info & typeInfo, const std::string & option )

overrideprotectedvirtual

The actual method returning the attribute data given a name.

Implements pool::ITechnologySpecificAttributes.

Definition at line 29 of file Container.cxx.

{
  if( !m_fileDescriptor.dbc() ) return false;
 
  pool::DbOption containerOption( attributeName, option );
  
  DbDatabase  dbH( m_fileDescriptor.dbc()->handle() );
  DbContainer cntH( dbH.find(name()) );
  if( !cntH.isValid() and !cntH.open(dbH, name(), 0, dbH.type(), Io::READ).isSuccess() ) {
    return false;
  }
  if( !cntH.getOption(containerOption).isSuccess() ) return false;
  return containerOption.i_getValue(typeInfo, data).isSuccess();
}

name()

virtual const std::string & pool::Container::name ( ) const

inlinefinaloverridevirtual

Returns the name of this container.

Implements pool::IContainer.

Definition at line 34 of file Container.h.

{ return m_name; }

setAttribute()

template<class T>

bool pool::ITechnologySpecificAttributes::setAttribute ( const std::string & attributeName, const T & atttibuteValue, const std::string & option = "" )

inlineinherited

Templated method to set an attribute.

Definition at line 41 of file ITechnologySpecificAttributes.h.

                                                                        {
      return this->setAttributeOfType( attributeName,
                                       static_cast< const void* >( &atttibuteValue ),
                                       typeid(T),
                                       option );
    }

setAttributeOfType()

bool pool::Container::setAttributeOfType ( const std::string & attributeName, const void * data, const std::type_info & typeInfo, const std::string & option )

overrideprotectedvirtual

The actual method setting the attribute data given a name.

Implements pool::ITechnologySpecificAttributes.

Definition at line 49 of file Container.cxx.

{
  if( !m_fileDescriptor.dbc() ) return false;
 
  pool::DbOption containerOption( attributeName, option );
  if( !containerOption.i_setValue(typeInfo, const_cast<void*>( data )).isSuccess() ) return false;
  
  DbDatabase  dbH( m_fileDescriptor.dbc()->handle() );
  DbContainer cntH( dbH.find(name()) );
  if( !cntH.isValid() and !cntH.open(dbH, name(), 0, dbH.type(), Io::READ).isSuccess() ) {
    return false;
  }
  return cntH.setOption(containerOption).isSuccess();
}

technology()

virtual long pool::Container::technology ( ) const

inlinefinaloverridevirtual

Returns the technology identifier for this container.

Implements pool::IContainer.

Definition at line 37 of file Container.h.

{ return m_technology; }

technologySpecificAttributes()

virtual ITechnologySpecificAttributes & pool::Container::technologySpecificAttributes ( )

inlinefinaloverridevirtual

Returns the object holding the technology specific attributes for a given technology domain.

Implements pool::IContainer.

Definition at line 45 of file Container.h.

{ return *this; }

tokens()

pool::ITokenIterator * pool::Container::tokens ( )

overridevirtual

Starts an iteration over the tokens in the container.

Returns a token iterator whose ownership is passed to the user.

Implements pool::IContainer.

Definition at line 22 of file Container.cxx.

{
  return new pool::TokenIterator( m_fileDescriptor,
                                                  this->name() );
}

Member Data Documentation

m_fileDescriptor

FileDescriptor& pool::Container::m_fileDescriptor

private

Reference to file descriptor of the parent database.

Definition at line 67 of file Container.h.

m_name

std::string pool::Container::m_name

private

The name of the container.

Definition at line 64 of file Container.h.

m_technology

long pool::Container::m_technology

private

The technology identifier.

Definition at line 70 of file Container.h.

---

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

• Container.h
• Container.cxx