# WOK
TKWOK
WOKBuilder

# WOKBuilder_MSchema Class Reference

Encapsulates MS_MetaSchema
Provides WOK interface with WOK and MetaSchema
Handles the WOK file nominating conventions (PK_Class.cdl ...)
.

`#include <WOKBuilder_MSchema.hxx>`

## Public Member Functions

Standard_EXPORT | WOKBuilder_MSchema ()
const Handle_MS_MetaSchema & | MetaSchema () const
| Returns the MS Handle of MetaSchema WOKBuilder private purpose .
Standard_EXPORT Standard_Boolean | IsDefined (const Handle(TCollection_HAsciiString)&anentity) const
| Tests if a global entity or a type is defined and complete in MSchema .
Standard_EXPORT void | RemoveEntity (const Handle(TCollection_HAsciiString)&anentity)
| Removes a global entity from MS_MetaSchema .
Standard_EXPORT void | RemoveType (const Handle(TCollection_HAsciiString)&atype)
| Removes a type from MS_MetaSchema .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | GetEntityTypes (const Handle(TCollection_HAsciiString)&anentity) const
| Returns the type .
Standard_EXPORT void | RemoveAutoTypes () const
| Removes all Automatically generated Types (instanciations) .
Standard_EXPORT Handle_TCollection_HAsciiString | AssociatedFile (const Handle(TCollection_HAsciiString)&anentity) const
| Returns the file defining entity .
Standard_EXPORT Handle_TCollection_HAsciiString | AssociatedEntity (const Handle(TCollection_HAsciiString)&atype) const
| Returns the GlobalEntity defining type .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | TypeSourceFiles (const Handle(TCollection_HAsciiString)&atype) const
| Returns source Files Issued From CDL .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableParts (const Handle(TCollection_HAsciiString)&anexecutable) const
| Returns the sequence of parts of a Executable GlobalEntity .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableFiles (const Handle(TCollection_HAsciiString)&anexecutable) const
| Returns the sequence of all source files of an executable .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableFiles (const Handle(TCollection_HAsciiString)&anexecutable, const Handle(TCollection_HAsciiString)&anexecpart) const
| Returns the sequence of source files of a part .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableModules (const Handle(TCollection_HAsciiString)&anexecutable) const
| Returns the sequence of all modules (basenames) of an executable .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableModules (const Handle(TCollection_HAsciiString)&anexecutable, const Handle(TCollection_HAsciiString)&anexecpart) const
| Returns the sequence of modules (basenames) of a part .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableLibraries (const Handle(TCollection_HAsciiString)&anexecutable) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableLibraries (const Handle(TCollection_HAsciiString)&anexecutable, const Handle(TCollection_HAsciiString)&anexecpart) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableExternals (const Handle(TCollection_HAsciiString)&anexecutable) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ExecutableExternals (const Handle(TCollection_HAsciiString)&anexecutable, const Handle(TCollection_HAsciiString)&anexecpart) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | ComponentParts (const Handle(TCollection_HAsciiString)&anexecutable) const
| Returns the sequence of parts of a Executable GlobalEntity .
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | SchemaClasses (const Handle(TCollection_HAsciiString)&aschema) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | SortedSchemaClasses (const Handle(TCollection_HAsciiString)&aschema) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | SchemaDescrMissingClasses (const Handle(TCollection_HAsciiString)&aschema) const
Standard_EXPORT Standard_Boolean | IsActionDefined (const WOKBuilder_MSActionID &anid) const
Standard_EXPORT void | AddAction (const WOKBuilder_MSActionID &anid) const
Standard_EXPORT WOKBuilder_MSActionID | GetStoredActionID (const WOKBuilder_MSActionID &anid) const
Standard_EXPORT Handle_WOKBuilder_MSAction | GetAction (const WOKBuilder_MSActionID &anid)
| Gets an action or creates it .
Standard_EXPORT void | ChangeActionToFailed (const WOKBuilder_MSActionID &anid)
Standard_EXPORT void | ChangeAddAction (const WOKBuilder_MSActionID &anid, const Handle(WOKBuilder_Specification)&thefile)
| Adds Action to the map if it does not exists Updates Date if it exists .
Standard_EXPORT WOKBuilder_MSActionStatus | GetActionStatus (const WOKBuilder_MSActionID &anaction)
| Get the status of an action on the MetaSchema .
Standard_EXPORT void | RemoveAction (const WOKBuilder_MSActionID &anaction)
| Removes an action from the map/ .
Standard_EXPORT void | Clear ()
| Empties MetaSchema and Action Map .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Member Functions

Standard_EXPORT Handle_TCollection_HAsciiString | ExecFileName (const Handle(MS_ExecFile)&anexecfile) const

## Private Attributes

Handle_MS_MetaSchema | myschema
WOKBuilder_DataMapOfMSActionIDOfMSAction | myactions
WOKBuilder_DataMapOfHAsciiStringOfMSEntity | myentities

## Constructor & Destructor Documentation

Standard_EXPORT WOKBuilder_MSchema::WOKBuilder_MSchema | ( |  | ) |

## Member Function Documentation

Standard_EXPORT void WOKBuilder_MSchema::AddAction | ( | const WOKBuilder_MSActionID & | anid | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString WOKBuilder_MSchema::AssociatedEntity | ( | const Handle(TCollection_HAsciiString)& | atype | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString WOKBuilder_MSchema::AssociatedFile | ( | const Handle(TCollection_HAsciiString)& | anentity | ) | const

Standard_EXPORT void WOKBuilder_MSchema::ChangeActionToFailed | ( | const WOKBuilder_MSActionID & | anid | ) |

Standard_EXPORT void WOKBuilder_MSchema::ChangeAddAction | ( | const WOKBuilder_MSActionID & | anid,
|  | const Handle(WOKBuilder_Specification)& | thefile
| ) |

Standard_EXPORT void WOKBuilder_MSchema::Clear | ( |  | ) |

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ComponentParts | ( | const Handle(TCollection_HAsciiString)& | anexecutable | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString WOKBuilder_MSchema::ExecFileName | ( | const Handle(MS_ExecFile)& | anexecfile | ) | const`[private]`

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableExternals | ( | const Handle(TCollection_HAsciiString)& | anexecutable,
|  | const Handle(TCollection_HAsciiString)& | anexecpart
| ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableExternals | ( | const Handle(TCollection_HAsciiString)& | anexecutable | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableFiles | ( | const Handle(TCollection_HAsciiString)& | anexecutable,
|  | const Handle(TCollection_HAsciiString)& | anexecpart
| ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableFiles | ( | const Handle(TCollection_HAsciiString)& | anexecutable | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableLibraries | ( | const Handle(TCollection_HAsciiString)& | anexecutable,
|  | const Handle(TCollection_HAsciiString)& | anexecpart
| ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableLibraries | ( | const Handle(TCollection_HAsciiString)& | anexecutable | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableModules | ( | const Handle(TCollection_HAsciiString)& | anexecutable,
|  | const Handle(TCollection_HAsciiString)& | anexecpart
| ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableModules | ( | const Handle(TCollection_HAsciiString)& | anexecutable | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::ExecutableParts | ( | const Handle(TCollection_HAsciiString)& | anexecutable | ) | const

Standard_EXPORT Handle_WOKBuilder_MSAction WOKBuilder_MSchema::GetAction | ( | const WOKBuilder_MSActionID & | anid | ) |

Standard_EXPORT WOKBuilder_MSActionStatus WOKBuilder_MSchema::GetActionStatus | ( | const WOKBuilder_MSActionID & | anaction | ) |

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::GetEntityTypes | ( | const Handle(TCollection_HAsciiString)& | anentity | ) | const

Standard_EXPORT WOKBuilder_MSActionID WOKBuilder_MSchema::GetStoredActionID | ( | const WOKBuilder_MSActionID & | anid | ) | const

Standard_EXPORT const WOKBuilder_MSchema::Handle | ( | Standard_Type |  | ) | const

Standard_EXPORT Standard_Boolean WOKBuilder_MSchema::IsActionDefined | ( | const WOKBuilder_MSActionID & | anid | ) | const

Standard_EXPORT Standard_Boolean WOKBuilder_MSchema::IsDefined | ( | const Handle(TCollection_HAsciiString)& | anentity | ) | const

const Handle_MS_MetaSchema& WOKBuilder_MSchema::MetaSchema | ( |  | ) | const

Standard_EXPORT void WOKBuilder_MSchema::RemoveAction | ( | const WOKBuilder_MSActionID & | anaction | ) |

Standard_EXPORT void WOKBuilder_MSchema::RemoveAutoTypes | ( |  | ) | const

Standard_EXPORT void WOKBuilder_MSchema::RemoveEntity | ( | const Handle(TCollection_HAsciiString)& | anentity | ) |

Standard_EXPORT void WOKBuilder_MSchema::RemoveType | ( | const Handle(TCollection_HAsciiString)& | atype | ) |

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::SchemaClasses | ( | const Handle(TCollection_HAsciiString)& | aschema | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::SchemaDescrMissingClasses | ( | const Handle(TCollection_HAsciiString)& | aschema | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::SortedSchemaClasses | ( | const Handle(TCollection_HAsciiString)& | aschema | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKBuilder_MSchema::TypeSourceFiles | ( | const Handle(TCollection_HAsciiString)& | atype | ) | const

## Field Documentation

WOKBuilder_DataMapOfMSActionIDOfMSAction WOKBuilder_MSchema::myactions `[private]`

WOKBuilder_DataMapOfHAsciiStringOfMSEntity WOKBuilder_MSchema::myentities `[private]`

Handle_MS_MetaSchema WOKBuilder_MSchema::myschema `[private]`

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

- WOKBuilder_MSchema.hxx