All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SDMRuntime Class SdaiAggrInstance

SDMRuntime.SdaiRoot
  |
  +---SdaiAggrInstance
 

Usage: you must use this class as is. You should never derive it.


public class SdaiAggrInstance

Class aggregating SDAI instances.


Method Index


o AddMember(SdaiPrimitiveH&)
Adds a SdaiPrimitive in a SdaiAggrInstance.
o DeleteAggr(SdaiAggrInstanceH)
Destroys a SdaiAggrInstance logically.
o Empty()
Empties a SdaiAggrInstance.
o GetInstanceTypeName()
Gets the type of a SdaiAggrInstance.
o GetMemberCount()
Gets the number of items in the SdaiAggrInstance, or the size if it is an array.
o IsKindOf(SdaiString&)
Tests if a SdaiAggrInstance is of a specified type.
o IsMember(SdaiPrimitiveH&)
Tests if a specified SdaiPrimitive is a member of a SdaiAggrAggrInstance.
o RemoveMember(SdaiPrimitiveH&)
Removes a SdaiPrimitive from a SdaiAggrInstance.

Methods


o AddMember
public virtual const SdaiBoolean& AddMember( const SdaiPrimitiveH& iMbr)
Adds a SdaiPrimitive in a SdaiAggrInstance.
Parameters:
iMbr
- the SdaiPrimitive to add
Returns:

Legal values
SdaiTRUE
Add succeeded
SdaiFALSE
Add failed
o DeleteAggr
public static void DeleteAggr(SdaiAggrInstanceH ioAggr)
Destroys a SdaiAggrInstance logically.
Parameters:
ioAggr
- the concerned SdaiAggrInstance
o Empty
public virtual int Empty()
Empties a SdaiAggrInstance.
o GetInstanceTypeName
public virtual const SdaiString & GetInstanceTypeName()const
Gets the type of a SdaiAggrInstance.
Returns:
The type of the instance
o GetMemberCount
public SdaiInteger GetMemberCount()const
Gets the number of items in the SdaiAggrInstance, or the size if it is an array.
o IsKindOf
public virtual const SdaiBoolean & IsKindOf( const SdaiString& iTypename) const
Tests if a SdaiAggrInstance is of a specified type.
Parameters:
iTypename
- the specified type
o IsMember
public const SdaiBoolean& IsMember( const SdaiPrimitiveH& iMbr) const
Tests if a specified SdaiPrimitive is a member of a SdaiAggrAggrInstance.
Parameters:
iMbr
- the specified SdaiPrimitive
o RemoveMember
public int RemoveMember( const SdaiPrimitiveH& iMbr)
Removes a SdaiPrimitive from a SdaiAggrInstance.
Parameters:
iMbr
- the SdaiPrimitive to remove
Returns:

Legal values
0
Remove succeeded
1
Remove failed

This object is included in the file: SdaiAggrInstance.h
If needed, your Imakefile.mk should include the module: CATSrtSimpleTypes

Copyright © 2003, Dassault Systèmes. All rights reserved.