# WOK
TKWOK
EDL

# EDL_API Class Reference

`#include <EDL_API.hxx>`

## Public Member Functions

Standard_EXPORT | EDL_API ()
Standard_EXPORT EDL_Error | Openlib (const Standard_CString aName) const
| Open a shared library named <aname> The name must not be the name of the file but the significant part : ex.: for library libTest.so the name must be Test .
Standard_EXPORT EDL_Error | Call (const Standard_CString aLibName, const Standard_CString aFunction, const Handle(TColStd_HSequenceOfHAsciiString)&anArgList) const
| Call a function <afunction> from library <alibname> with the arguments list <anarglist> The name of the library is the same than Openlib .
Standard_EXPORT void | Closelib (const Standard_CString aName) const
| Close the library named <aname> The name is the same than Openlib .
Standard_EXPORT void | AddTemplate (const Standard_CString aName, const Handle(TColStd_HSequenceOfHAsciiString)&aDefinition, const Handle(TColStd_HSequenceOfHAsciiString)&aVarList) const
| Add a template named <aname> with <adefinition> as definition .
Standard_EXPORT void | Apply (const Standard_CString aResult, const Standard_CString aName) const
| Evaluate a template named <aname> with the variables list <avarlist> and set the result in a variable named <aresult> .
Standard_EXPORT void | RemoveTemplate (const Standard_CString aName) const
| Remove a template .
Standard_EXPORT EDL_Template & | GetTemplate (const Standard_CString aName) const
Standard_EXPORT void | AddVariable (const Standard_CString aName, const Standard_CString aValue) const
| Create a variable <aname> or modifie it s value .
Standard_EXPORT void | AddVariable (const Standard_CString aName, const Standard_Integer aValue) const
| Create a variable <aname> or modifie it s value .
Standard_EXPORT void | AddVariable (const Standard_CString aName, const Standard_Real aValue) const
| Create a variable <aname> or modifie it s value .
Standard_EXPORT void | AddVariable (const Standard_CString aName, const Standard_Character aValue) const
| Create a variable <aname> or modifie it s value .
Standard_EXPORT EDL_Variable & | GetVariable (const Standard_CString aName) const
| Returns the value of the variable named <aname>. .
Standard_EXPORT Handle_TCollection_HAsciiString | GetVariableValue (const Standard_CString aName) const
| Returns the value of the variable named <aname>. .
Standard_EXPORT void | RemoveVariable (const Standard_CString aName) const
| Remove a variable named <aname>. .
Standard_EXPORT Standard_Boolean | IsDefined (const Standard_CString aName) const
| Return Standard_True if a variable or template named <aname> is defined .

## Constructor & Destructor Documentation

Standard_EXPORT EDL_API::EDL_API | ( |  | ) |

## Member Function Documentation

Standard_EXPORT void EDL_API::AddTemplate | ( | const Standard_CString | aName,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aDefinition,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | aVarList
| ) | const

Standard_EXPORT void EDL_API::AddVariable | ( | const Standard_CString | aName,
|  | const Standard_Character | aValue
| ) | const

Standard_EXPORT void EDL_API::AddVariable | ( | const Standard_CString | aName,
|  | const Standard_Real | aValue
| ) | const

Standard_EXPORT void EDL_API::AddVariable | ( | const Standard_CString | aName,
|  | const Standard_Integer | aValue
| ) | const

Standard_EXPORT void EDL_API::AddVariable | ( | const Standard_CString | aName,
|  | const Standard_CString | aValue
| ) | const

Standard_EXPORT void EDL_API::Apply | ( | const Standard_CString | aResult,
|  | const Standard_CString | aName
| ) | const

Standard_EXPORT EDL_Error EDL_API::Call | ( | const Standard_CString | aLibName,
|  | const Standard_CString | aFunction,
|  | const Handle(TColStd_HSequenceOfHAsciiString)& | anArgList
| ) | const

Standard_EXPORT void EDL_API::Closelib | ( | const Standard_CString | aName | ) | const

Standard_EXPORT EDL_Template& EDL_API::GetTemplate | ( | const Standard_CString | aName | ) | const

Standard_EXPORT EDL_Variable& EDL_API::GetVariable | ( | const Standard_CString | aName | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString EDL_API::GetVariableValue | ( | const Standard_CString | aName | ) | const

Standard_EXPORT Standard_Boolean EDL_API::IsDefined | ( | const Standard_CString | aName | ) | const

Standard_EXPORT EDL_Error EDL_API::Openlib | ( | const Standard_CString | aName | ) | const

Standard_EXPORT void EDL_API::RemoveTemplate | ( | const Standard_CString | aName | ) | const

Standard_EXPORT void EDL_API::RemoveVariable | ( | const Standard_CString | aName | ) | const

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

- EDL_API.hxx