# WOK
TKWOK
MS

# MS Class Reference

Meta Schema Package for MDTV Dev. Tools.
.

`#include <MS.hxx>`

## Public Member Functions

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)

## Static Public Member Functions

static Standard_EXPORT Handle_TCollection_HAsciiString | GetPersistentRootName ()
static Standard_EXPORT Handle_TCollection_HAsciiString | GetStorableRootName ()
static Standard_EXPORT Handle_TCollection_HAsciiString | GetTransientRootName ()
static Standard_EXPORT Handle_TCollection_HAsciiString | GetPackageRootName ()
static Standard_EXPORT Handle_TCollection_HAsciiString | GetVArrayRootName ()
| Warning this method is obsolete .
static Standard_EXPORT Handle_TCollection_HAsciiString | BuildFullName (const Handle(TCollection_HAsciiString)&aGEName, const Handle(TCollection_HAsciiString)&aEName)
| build a full name from a global entity name and an entity name
static Standard_EXPORT Handle_TCollection_HAsciiString | BuildComplexName (const Handle(TCollection_HAsciiString)&MyName, const Handle(TCollection_HAsciiString)&aEName, const Handle(TCollection_HAsciiString)&aGEName)
| build a complex name for nested classes <myname> : the name of the containing class <aename> : the name of the nested class <agename> : the name of the generic class
static Standard_EXPORT Handle_TCollection_HAsciiString | GetEntityNameFromMethodName (const Handle(TCollection_HAsciiString)&methodName)
static Standard_EXPORT Handle_MS_Method | GetMethodFromFriendName (const Handle(MS_MetaSchema)&aMeta, const Handle(TCollection_HAsciiString)&methodName)
| find a method with a short name. short names are those that comes from the interface or friend method's list
static Standard_EXPORT Standard_Boolean | IsExportedType (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Type)&aType)
| Checks if a basic type is exportable (used by IsExportableMethod and IsExportableClass). .
static Standard_EXPORT Standard_Boolean | IsExportableMethod (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Method)&aMethod)
| for interface, engine or stubs extractor some types cannot be exported like pointer or imported so this function returns False if one of these type is used by the method <amethod>
static Standard_EXPORT Standard_Boolean | IsExportableClass (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Class)&aClass, const Standard_Boolean mustCheckField, const Standard_Boolean mustCheckMethods)
| as <isexportablemethod>, but this method checks if the class is not generic and checks methods. If <mustcheckfield> == Standard_True -> fields are checked. If <mustcheckmethods> == Standard_True -> methods are checked.
static Standard_EXPORT void | DispatchUsedType (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Type)&aType, const Handle(TColStd_HSequenceOfHAsciiString)&aList, const Handle(TColStd_HSequenceOfHAsciiString)&aIncList, const Standard_Boolean notusedwithref)
| we test the type and dispatch it in the different lists <afulllist> : list of all the type used <alist> : list of complete types used <aincp> : list of incomplete types used <notusedwithref> : type are assumed to be used with reference if TRUE
static Standard_EXPORT void | MethodUsedTypes (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Method)&aMethod, const Handle(TColStd_HSequenceOfHAsciiString)&aList, const Handle(TColStd_HSequenceOfHAsciiString)&aIncList)
| sort the method used types : <afulllist> : list of all the type used <alist> : list of complete types used <aincp> : list of incomplete types used
static Standard_EXPORT void | ClassUsedTypes (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Class)&aClass, const Handle(TColStd_HSequenceOfHAsciiString)&aList, const Handle(TColStd_HSequenceOfHAsciiString)&aIncList)
| sort the class used types : <afulllist> : list of all the type used <alist> : list of complete types used <aincp> : list of incomplete types used
static Standard_EXPORT void | StubClassesToExtract (const Handle(MS_MetaSchema)&aMeta, const Handle(TColStd_HSequenceOfHAsciiString)&aListOfInterClasses, WOKTools_MapOfHAsciiString &CompleteMap, WOKTools_MapOfHAsciiString &IncompleteMap, WOKTools_MapOfHAsciiString &SemiCompleteMap)
static Standard_EXPORT void | StubPackagesToExtract (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Interface)&Inter, WOKTools_MapOfHAsciiString &CompleteMap, WOKTools_MapOfHAsciiString &IncompleteMap, WOKTools_MapOfHAsciiString &SemiCompleteMap)
static Standard_EXPORT void | StubMethodsToExtract (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Interface)&Inter, const Handle(MS_HSequenceOfExternMet)&SeqOfExternMet, const Handle(MS_HSequenceOfMemberMet)&SeqOfMemberMet, WOKTools_MapOfHAsciiString &CompleteMap, WOKTools_MapOfHAsciiString &IncompleteMap, WOKTools_MapOfHAsciiString &SemiCompleteMap)
static Standard_EXPORT void | StubMethodTypesToExtract (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Method)&met, WOKTools_MapOfHAsciiString &CompleteMap, WOKTools_MapOfHAsciiString &IncompleteMap, WOKTools_MapOfHAsciiString &SemiCompleteMap)
static Standard_EXPORT void | StubMethodsTypesToExtract (const Handle(MS_MetaSchema)&aMeta, const Handle(MS_Common)&com, WOKTools_MapOfHAsciiString &CompleteMap, WOKTools_MapOfHAsciiString &IncompleteMap, WOKTools_MapOfHAsciiString &SemiCompleteMap)
static Standard_EXPORT Handle_MS_InstClass | BuildInstClass (const Handle(MS_Class)&aClass, const Handle(TCollection_HAsciiString)&aName, const Handle(TCollection_HAsciiString)&aPackage, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqGen, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqType)
| Transform an InstClass to a StdClass (for instantiation phase) Don't use this method if you are not the MS's writer .
static Standard_EXPORT Handle_MS_StdClass | BuildStdClass (const Handle(MS_Class)&aClass, const Handle(TCollection_HAsciiString)&aName, const Handle(TCollection_HAsciiString)&aPackage, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqGen, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqType)
| Tranform a StdClass with generic parameter in a full StdClass Don't use this method if you are not the MS's writer .
static Standard_EXPORT Handle_MS_MemberMet | BuildStdMethod (const Handle(MS_MemberMet)&aMethod, const Handle(MS_Class)&aClass, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqGen, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqType)
| Transform a method with generic parameter in a normal method Don't use this method if you are not the MS's writer .
static Standard_EXPORT Handle_MS_Param | BuildStdParam (const Handle(MS_Param)&aParam, const Handle(MS_Method)&aMethod, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqGen, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqType)
static Standard_EXPORT Handle_MS_Field | BuildStdField (const Handle(MS_Field)&aField, const Handle(MS_Class)&aClass, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqGen, const Handle(TColStd_HSequenceOfHAsciiString)&aSeqType)
static Standard_EXPORT void | AddOnce (const Handle(TColStd_HSequenceOfHAsciiString)&aSeq, const Handle(TCollection_HAsciiString)&Item)
| to add an item only once in a sequence WARNING : cursed code (use with care)

## Member Function Documentation

static Standard_EXPORT void MS::AddOnce | ( | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeq,
|  | const Handle(TCollection_HAsciiString)& | Item
| ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::BuildComplexName | ( | const Handle(TCollection_HAsciiString)& | MyName,
|  | const Handle(TCollection_HAsciiString)& | aEName,
|  | const Handle(TCollection_HAsciiString)& | aGEName
| ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::BuildFullName | ( | const Handle(TCollection_HAsciiString)& | aGEName,
|  | const Handle(TCollection_HAsciiString)& | aEName
| ) | `[static]`

static Standard_EXPORT Handle_MS_InstClass MS::BuildInstClass | ( | const Handle(MS_Class)& | aClass,
|  | const Handle(TCollection_HAsciiString)& | aName,
|  | const Handle(TCollection_HAsciiString)& | aPackage,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqGen,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqType
| ) | `[static]`

static Standard_EXPORT Handle_MS_StdClass MS::BuildStdClass | ( | const Handle(MS_Class)& | aClass,
|  | const Handle(TCollection_HAsciiString)& | aName,
|  | const Handle(TCollection_HAsciiString)& | aPackage,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqGen,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqType
| ) | `[static]`

static Standard_EXPORT Handle_MS_Field MS::BuildStdField | ( | const Handle(MS_Field)& | aField,
|  | const Handle(MS_Class)& | aClass,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqGen,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqType
| ) | `[static]`

static Standard_EXPORT Handle_MS_MemberMet MS::BuildStdMethod | ( | const Handle(MS_MemberMet)& | aMethod,
|  | const Handle(MS_Class)& | aClass,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqGen,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqType
| ) | `[static]`

static Standard_EXPORT Handle_MS_Param MS::BuildStdParam | ( | const Handle(MS_Param)& | aParam,
|  | const Handle(MS_Method)& | aMethod,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqGen,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aSeqType
| ) | `[static]`

static Standard_EXPORT void MS::ClassUsedTypes | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Class)& | aClass,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aList,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aIncList
| ) | `[static]`

static Standard_EXPORT void MS::DispatchUsedType | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Type)& | aType,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aList,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aIncList,
|  | const Standard_Boolean | notusedwithref
| ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::GetEntityNameFromMethodName | ( | const Handle(TCollection_HAsciiString)& | methodName | ) | `[static]`

static Standard_EXPORT Handle_MS_Method MS::GetMethodFromFriendName | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(TCollection_HAsciiString)& | methodName
| ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::GetPackageRootName | ( |  | ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::GetPersistentRootName | ( |  | ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::GetStorableRootName | ( |  | ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::GetTransientRootName | ( |  | ) | `[static]`

static Standard_EXPORT Handle_TCollection_HAsciiString MS::GetVArrayRootName | ( |  | ) | `[static]`

static Standard_EXPORT Standard_Boolean MS::IsExportableClass | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Class)& | aClass,
|  | const Standard_Boolean | mustCheckField,
|  | const Standard_Boolean | mustCheckMethods
| ) | `[static]`

static Standard_EXPORT Standard_Boolean MS::IsExportableMethod | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Method)& | aMethod
| ) | `[static]`

static Standard_EXPORT Standard_Boolean MS::IsExportedType | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Type)& | aType
| ) | `[static]`

static Standard_EXPORT void MS::MethodUsedTypes | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Method)& | aMethod,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aList,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aIncList
| ) | `[static]`

void MS::operator delete | ( | void * | anAddress | ) | `[inline]`

void* MS::operator new | ( | size_t | size | ) | `[inline]`

void* MS::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

static Standard_EXPORT void MS::StubClassesToExtract | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aListOfInterClasses,
|  | WOKTools_MapOfHAsciiString & | CompleteMap,
|  | WOKTools_MapOfHAsciiString & | IncompleteMap,
|  | WOKTools_MapOfHAsciiString & | SemiCompleteMap
| ) | `[static]`

static Standard_EXPORT void MS::StubMethodsToExtract | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Interface)& | Inter,
|  | const Handle(MS_HSequenceOfExternMet)& | SeqOfExternMet,
|  | const Handle(MS_HSequenceOfMemberMet)& | SeqOfMemberMet,
|  | WOKTools_MapOfHAsciiString & | CompleteMap,
|  | WOKTools_MapOfHAsciiString & | IncompleteMap,
|  | WOKTools_MapOfHAsciiString & | SemiCompleteMap
| ) | `[static]`

static Standard_EXPORT void MS::StubMethodsTypesToExtract | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Common)& | com,
|  | WOKTools_MapOfHAsciiString & | CompleteMap,
|  | WOKTools_MapOfHAsciiString & | IncompleteMap,
|  | WOKTools_MapOfHAsciiString & | SemiCompleteMap
| ) | `[static]`

static Standard_EXPORT void MS::StubMethodTypesToExtract | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Method)& | met,
|  | WOKTools_MapOfHAsciiString & | CompleteMap,
|  | WOKTools_MapOfHAsciiString & | IncompleteMap,
|  | WOKTools_MapOfHAsciiString & | SemiCompleteMap
| ) | `[static]`

static Standard_EXPORT void MS::StubPackagesToExtract | ( | const Handle(MS_MetaSchema)& | aMeta,
|  | const Handle(MS_Interface)& | Inter,
|  | WOKTools_MapOfHAsciiString & | CompleteMap,
|  | WOKTools_MapOfHAsciiString & | IncompleteMap,
|  | WOKTools_MapOfHAsciiString & | SemiCompleteMap
| ) | `[static]`

The documentation for this class was generated from the following file:

- MS.hxx