OCDM_AttributeSet Class Reference

OCDM_AttributeSet class incorporates every function related to the use and manipulation of group/sets of Attributes.

#include <OCDM.h>

Inheritance diagram for OCDM_AttributeSet:

OCDM_Object List of all members.

Public Member Functions

 OCDM_AttributeSet ()
 OCDM_AttributeSet (const CDM_Object obj)
 OCDM_AttributeSet (const class OCDM_AttributeSet &obj)
 OCDM_AttributeSet (const char *name, const OCDM_AttributeValue &AttrVal)
 This is the constructor function of the OCDM_AttributeSet class.
OCDM_AttributeSetoperator= (const class OCDM_Object &obj)
 This is the default assignment operator.
 OCDM_INDEX_OPERATOR_REF (OCDM_Attribute) operator[](const long index) const
void AddAttribute (const OCDM_Attribute &Attr)
 This function will append the given Attribute (the value of the "Attribute" parameter) to the Attribute set object in use.
OCDM_BOOL AttributeExists (const char *name) const
 This function will return true if an Attribute with the specified name exists in the Attribute set.
 OCDM_REF (OCDM_Attribute) GetAttribute(const char *name) const
int RemoveAttribute (const char *name)
 This function will remove all Attributes having the provided name from the Attribute set. The number of removed Annotations will be returned.
const char * objectType (void) const

Constructor & Destructor Documentation

OCDM_AttributeSet (  ) 

OCDM_AttributeSet ( const CDM_Object  obj  ) 

OCDM_AttributeSet ( const class OCDM_AttributeSet obj  ) 

OCDM_AttributeSet ( const char *  name,
const OCDM_AttributeValue AttrVal 
)

Description:
This is the constructor function of the OCDM_AttributeSet class. It will create a new Attribute set object (of type OCDM_AttributeSet) that will contain a newly created Attribute object, created according to the values specified as parameters.
  • name: The name of the OCDM_AttributeSet object to be created.
  • Attrval: The value of the Atribute to be created.
Note:
This function is equivelant to creating an empty Attribute set object with CDM_CreateAttributeSet (void), creating a new Attribute object with CDM_CreateAttribute (char *Name, CDM_AttributeValue Value) and adding this Attribute object to the newly created Annotation set.


Member Function Documentation

class OCDM_AttributeSet& operator= ( const class OCDM_Object obj  )  [virtual]

Description: This is the default sssignment operator. Note that under
languages that do not support operator overloading (i.e. Java, Perl, Python) this operator appears as a plain method named as "set".
Arguments:
  • obj: the object to be copied.
Returns:
This method returns a reference to the current object.

Reimplemented from OCDM_Object.

OCDM_INDEX_OPERATOR_REF ( OCDM_Attribute   )  const

void AddAttribute ( const OCDM_Attribute Attr  ) 

Arguments:
  • Attr: The Attribute object to be appended to the attribute set.
Note:
In case of an Error an Exception of type OCDM_Exception will be thrown.

OCDM_BOOL AttributeExists ( const char *  name  )  const

Arguments:
  • name: The Attribute name to be found.
Note:
In case of an Error an Exception of type OCDM_Exception will be thrown.

OCDM_REF ( OCDM_Attribute   )  const

int RemoveAttribute ( const char *  name  ) 

Arguments:
Note:
In case of an Error an Exception of type OCDM_Exception will be thrown.

const char* objectType ( void   )  const [virtual]

This method returns the type of the object as a string.

Reimplemented from OCDM_Object.


Generated on Tue Jun 26 17:40:44 2007 for OCDM by  doxygen 1.5.2