class CDSLibComponentPointers

This class encapsulates a STL vector of pointers to CDSLibComponent objects.

Public Methods

CDSLibComponentPointers()

Constructor

CDSLibComponentPointers(const CDSLibComponentPointers &ComponentPointers, const CDSLibComponent* pContainer)

Copy-constructor.

virtual ~CDSLibComponentPointers()

Destructor

const CDSLibComponent* operator [] (unsigned int uIndex) const

Returns a pointer of the vector using the [] operator.

bool AllArrange()

Calls AllArrange in everyone of the objects pointed by the vector.

virtual void AllGenerateCode(const std::string &strTemplatesPath, CCodeSection* pCodeSection) const

Calls AllGenerateCode with the same arguments in everyone of the objects pointed by the vector.

virtual bool AllRepeatedValue(const CDSLibComponent* , const std::string &, const std::string &) const

THE REPEATED-VALUES CHECK IS NOT PERFORMED YET IN DSLib v2 AND MAY BE REMOVED

void AllReportMessages(CMessages* pMessagesReport)

Calls AllReportErrors with the same argument in everyone of the objects pointed by the vector.

void Clear()

Clear the vector of pointers, without destroying the pointed objects

bool Contains(const CDSLibComponent* pComponent) const

Returns if the vector contains the pointer passed as argument.

virtual void DeleteObjects()

Calls DeleteObjects in everyone of the objects pointed by the vector and then deletes them

virtual unsigned int DescendantsOf(const std::string & strClass) const

Calls DescendantOf with the same argument in everyone of the objects pointed by the vector, and returns how many of these calls returned true

int Index( const CDSLibComponent* Pointer* / ) const

Returns the position of a pointer in the vector.

unsigned int Length() const

Returns the number of pointers in the vector

void PushBack(CDSLibComponent* )

Adds a new pointer to the end of the vector

const CDSLibComponent* Search( const std::string &, Identifier of the searched object* / const std::string & Class or base class of the searched object*/ ) const

Searchs in the vector for a pointer to an object of a specific class or base class and identifier.

const m_TDSLibComponentPointers& DSLibComponentPointers() const

Returns the vector of pointers

Public Members

typedef std::vector<CDSLibComponent*> m_TDSLibComponentPointers

Type for the vector of pointers to CDSLibComponent objects

Protected Methods

m_TDSLibComponentPointers& DSLibComponentPointers()

Returns the vector of pointers

Documentation

This class encapsulates a STL vector of pointers to CDSLibComponent objects. It is used to store lists of components, like the contained components of DSLib objects. STL containers can't be extended because they don't have virtual destructors.

typedef std::vector<CDSLibComponent*> m_TDSLibComponentPointers

Type for the vector of pointers to CDSLibComponent objects

CDSLibComponentPointers()

Constructor

CDSLibComponentPointers(const CDSLibComponentPointers &ComponentPointers, const CDSLibComponent* pContainer)

Copy-constructor. The components in the vector are copied using their Clone() method.

Parameters:

pDSLibComponent - Object to copy from
pContainer - Container for this new object

virtual ~CDSLibComponentPointers()

Destructor

const CDSLibComponent* operator [] (unsigned int uIndex) const

Returns a pointer of the vector using the [] operator.

Parameters:

uIndex - Position of the pointer in the vector

bool AllArrange()

Calls AllArrange in everyone of the objects pointed by the vector. Stops and returns "false" when one of the calls returns false. Returns "true" otherwise.

virtual void AllGenerateCode(const std::string &strTemplatesPath, CCodeSection* pCodeSection) const

Calls AllGenerateCode with the same arguments in everyone of the objects pointed by the vector.

Parameters:

strTemplatesPath - Path to the template files to be parsed
pCodeSection - Code section to be generated

virtual bool AllRepeatedValue(const CDSLibComponent* , const std::string &, const std::string &) const

THE REPEATED-VALUES CHECK IS NOT PERFORMED YET IN DSLib v2 AND MAY BE REMOVED

void AllReportMessages(CMessages* pMessagesReport)

Calls AllReportErrors with the same argument in everyone of the objects pointed by the vector.

Parameters:

pMessagesReport -

void Clear()

Clear the vector of pointers, without destroying the pointed objects

bool Contains(const CDSLibComponent* pComponent) const

Returns if the vector contains the pointer passed as argument.

Parameters:

pComponent - Pointer to look for

virtual void DeleteObjects()

Calls DeleteObjects in everyone of the objects pointed by the vector and then deletes them

virtual unsigned int DescendantsOf(const std::string & strClass) const

Calls DescendantOf with the same argument in everyone of the objects pointed by the vector, and returns how many of these calls returned true

int Index( const CDSLibComponent* Pointer* / ) const

Returns the position of a pointer in the vector. If the pointer is not in the vector, returns -1

unsigned int Length() const

Returns the number of pointers in the vector

void PushBack(CDSLibComponent* )

Adds a new pointer to the end of the vector

const CDSLibComponent* Search( const std::string &, Identifier of the searched object* / const std::string & Class or base class of the searched object*/ ) const

Searchs in the vector for a pointer to an object of a specific class or base class and identifier. Returns the pointer if it's found, NULL otherwise

const m_TDSLibComponentPointers& DSLibComponentPointers() const

Returns the vector of pointers

m_TDSLibComponentPointers& DSLibComponentPointers()

Returns the vector of pointers

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java