Server
API Reference Guide
Product Documentation:

Rogue Wave Server
Documentation Home
List of all members | Public Member Functions
IlsDynAttributes Class Referenceabstract
Dynamic modeling API

This abstract class is the base class for the collection of
attributes of a dynamic object. More...

#include <ilserver/dynimpl.h>

Inherited by IlsDynAttributeArray, and IlsDynAttributeMap.

Public Member Functions

 IlsDynAttributes (IlsDynObject *holder)
 This constructor receives the holder object for the collection to be built.
 
virtual void addAttribute (const IlsAttributeDef &, IlsDynAttribute &)=0
 This virtual member function adds a dynamic attribute to the collection. This function should be overriden.
 
virtual int getCount () const =0
 This virtual member function returns the number of dynamic attributes stored in the collection.
 
virtual IlsDynAttribute * getDynAttribute (const IlsDynObject &holder, const IlsAttributeDef &) const =0
 This virtual member function returns a dynamic attribute, given its definition and its holder. This function should be overriden.
 
virtual IlsDynObject * getHolder () const
 This member function returns the holder of the collection. This function should be overriden.
 
virtual IlsDynAttribute * newAttribute (IlsDynObject &, const IlsAttributeDef &)
 This virtual member function is called by Server when a new attribute must be built. More...
 
virtual void rmAttribute (const IlsAttributeDef &, IlsBoolean del=IlsTrue)=0
 This virtual member function removes a dynamic attribute from the collection. More...
 

Detailed Description

This abstract class is the base class for the collection of
attributes of a dynamic object.

Library: dynmvsvr

It provides the API used by Rogue Wave Server to create or access dynamic attributes. If you choose to subclass this class, you must use the member function IlsDynObjectFactory::newAttributes() to create instances of your subclass.

See also
IlsDynAttribute, IlsDynAttributeFactory.

Member Function Documentation

◆ newAttribute()

virtual IlsDynAttribute* IlsDynAttributes::newAttribute ( IlsDynObject &  ,
const IlsAttributeDef &   
)
virtual

This virtual member function is called by Server when a new attribute must be built.

The default implementation invokes the methods of the class IlsDynAttributeFactory and calls IlsDynAttributeFactory::addAttribute().

◆ rmAttribute()

virtual void IlsDynAttributes::rmAttribute ( const IlsAttributeDef &  ,
IlsBoolean  del = IlsTrue 
)
pure virtual

This virtual member function removes a dynamic attribute from the collection.

If the argument del is IlsTrue, the dynamic attribute must be deleted. This function should be overriden.