All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SDMRuntime Class SdaiAppInstance

SDMRuntime.SdaiRoot
  |
  +---SDMRuntime.SdaiEntityInstance
    |
    +---SdaiAppInstance
 

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


public class SdaiAppInstance

Class for SDAI application schema instances.


Method Index


o CreateAggrInstance(SdaiString&)
Creates a empty attribute of type aggregate.
o Delete(SdaiAppInstanceH)
Destroys a SdaiAppInstance.
o GetAttr(SdaiString&)
Gets the value of an attribute.
o GetInstanceType()
Gets the name of the type of an instance.
o IsInstanceOf(SdaiString&)
Tests if an instance is an instance of specified type.
o IsKindOf(SdaiString&)
Tests if an instance is of a specified type or one of the subtypes of this type.
o PutAttr(SdaiString&,SdaiPrimitiveH&)
Assigns a value to an attribute.
o TestAttr(SdaiString&)
Tests if an attibute has a valid value.
o UnsetAttr(SdaiString&)
Erases the value of an attribute.
o ValidateWhereRule(SdaiString&)
Checks the WHERE rule of the receiver.

Methods


o CreateAggrInstance
public SdaiAggrInstanceH CreateAggrInstance( const SdaiString& attName)
Creates a empty attribute of type aggregate.
Parameters:
attName
- the name of the attribute to create
Returns:
- the attibute created
o Delete
public static void Delete(SdaiAppInstanceH appInst)
Destroys a SdaiAppInstance.
Parameters:
appInst
- the concerned SdaiAppInstance
o GetAttr
public const SdaiPrimitiveH & GetAttr( const SdaiString& attName)const
Gets the value of an attribute.
Parameters:
attName
- the name of the attribute JNI 05/03/02 GetAttr calls are always in "current context", if a driver context view is needed (this is usually only needed by the driver itself), then use AttrValueAccess.
o GetInstanceType
public virtual const SdaiNamedTypeH GetInstanceType()const
Gets the name of the type of an instance.
Returns:
- the name of the type
o IsInstanceOf
public virtual const SdaiBoolean & IsInstanceOf( const SdaiString& iString)const
Tests if an instance is an instance of specified type.
Parameters:
iString
- the type specified
o IsKindOf
public virtual const SdaiBoolean & IsKindOf( const SdaiString& typeName)const
Tests if an instance is of a specified type or one of the subtypes of this type.
Parameters:
typeName
- the type specified
o PutAttr
public void PutAttr( const SdaiString& attrName,
const SdaiPrimitiveH& attrVal)
Assigns a value to an attribute.
Parameters:
attName
- the name of the attribute
attrVal
- the value of the attribute
o TestAttr
public const SdaiBoolean & TestAttr( const SdaiString& att_name)const
Tests if an attibute has a valid value.
Parameters:
att_name
- the name of the attribute
o UnsetAttr
public virtual void UnsetAttr( const SdaiString& attName)
Erases the value of an attribute.
Parameters:
attName
- the name of the attribute
o ValidateWhereRule
public virtual const SdaiLogical & ValidateWhereRule( const SdaiString& ruleName)const
Checks the WHERE rule of the receiver.
Parameters:
ruleName
- the name of the rule
Returns:

Legal values
SdaiTRUE
Rule is verified
SdaiFALSE
Rule is not verified
sdaiUNKNOWN
Rule can not be verify

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

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