Unicorn XML Toolkit
Version 1.00.00

Namespace Som
Class CInterfaceDef

class CInterfaceDef: public CInterface {
public:
    CInterfaceDef();
    ~CInterfaceDef();
public:
    void Create(const CString &strName, CModuleDef *pModule);
    void AddConstant(const XConstantDef &pConstant);
    void AddAttribute(const XAttributeDef &pAttribute);
    void AddOperation(const XOperationDef &pOperation);
    CString GetName();
    CString GetQualifiedName();
    int GetConstantCount();
    XConstantDef GetConstant(int nIndex);
    int GetAttributeCount();
    XAttributeDef GetAttribute(int nIndex);
    int GetOperationCount();
    XOperationDef GetOperation(int nIndex);
    };

The definition of an interface in a SOM repository.

Since:
1.00.00
Version:
1.00.00
Author:
Alexey Gokhberg
See Also:
CConstantDef, CAttributeDef, COperationDef, CModuleDef
Constructor/Destructor Summary
CInterfaceDef ();
����������Constructs the interface definition.
~CInterfaceDef ();
����������Destroys the interface definition.

Function Summary
void Create (const CString &strName, CModuleDef *pModule);
����������Creates the interface definition.
void AddConstant (const XConstantDef &pConstant);
����������Adds a constant definition to the list of constant definitions specified by the interface.
void AddAttribute (const XAttributeDef &pAttribute);
����������Adds an attribute definition to the list of attribute definitions specified by the interface.
void AddOperation (const XOperationDef &pOperation);
����������Adds an operation definition to the list of operation definitions specified by the interface.
CString GetName ();
����������Returns a name of the interface
CString GetQualifiedName ();
����������Returns a qualified name of the interface.
int GetConstantCount ();
����������Returns a number of constant definitions.
XConstantDef GetConstant (int nIndex);
����������Returns a constant definition at the specified index.
int GetAttributeCount ();
����������Returns a number of attribute definitions.
XAttributeDef GetAttribute (int nIndex);
����������Returns an attribute definition at the specified index.
int GetOperationCount ();
����������Returns a number of operation definitions.
XOperationDef GetOperation (int nIndex);
����������Returns an operation definition at the specified index.

Constructor/Destructor Detail

CInterfaceDef

CInterfaceDef();

Constructs the interface definition.

~CInterfaceDef

~CInterfaceDef();

Destroys the interface definition.

Function Detail

Create

void Create(const CString &strName, CModuleDef *pModule);

Creates the interface definition.

Parameters:
strName - the name of the interface
pModule - the definition of a module declaring this interface

AddConstant

void AddConstant(const XConstantDef &pConstant);

Adds a constant definition to the list of constant definitions specified by the interface.

Parameters:
pConstant - the constant definition to add

AddAttribute

void AddAttribute(const XAttributeDef &pAttribute);

Adds an attribute definition to the list of attribute definitions specified by the interface.

Parameters:
pAttribute - the attribute definition to add

AddOperation

void AddOperation(const XOperationDef &pOperation);

Adds an operation definition to the list of operation definitions specified by the interface.

Parameters:
pOperation - the operation definition to add

GetName

CString GetName();

Returns a name of the interface

Returns:
the name of the interface

GetQualifiedName

CString GetQualifiedName();

Returns a qualified name of the interface.

The qualified name has the format module_name::interface_name , where module_name is the name of the module which declares the interface, and interface_name is the name of the interface.

Returns:
the qualified name of the interface

GetConstantCount

int GetConstantCount();

Returns a number of constant definitions.

Returns:
the number of constant definitions

GetConstant

XConstantDef GetConstant(int nIndex);

Returns a constant definition at the specified index.

Parameters:
nIndex - the index (zero-based)
Returns:
the constant definition at the specified index

GetAttributeCount

int GetAttributeCount();

Returns a number of attribute definitions.

Returns:
the number of attribute defintions

GetAttribute

XAttributeDef GetAttribute(int nIndex);

Returns an attribute definition at the specified index.

Parameters:
nIndex - the index (zero-based)
Returns:
the attribute definition at the specified index

GetOperationCount

int GetOperationCount();

Returns a number of operation definitions.

Returns:
the number of operation definitions

GetOperation

XOperationDef GetOperation(int nIndex);

Returns an operation definition at the specified index.

Parameters:
nIndex - the index (zero-based)
Returns:
the operation definition at the specified index

Unicorn XML Toolkit
Version 1.00.00


This document was created using Unicorn DOC++.

Copyright 1999-2001 Unicorn Enterprises SA.
All Rights Reserved.