BasisTechnology::RLP::Environment Class Reference

The RLP Environment class.

#include <bt_rlp_managed.h>

List of all members.

Public Member Functions

virtual ContextCreateContextFromFile (String^ context_spec_file)=0
 Create a new context, using a file to define the operations.
virtual ContextCreateContextFromXML (String^ context_xml_definition)=0
 Create a new context, using an XML string to define the operations.
virtual String^ GetProcessorReport ()=0
 Get a report of the processors defined in this environment.
virtual BT_RLP_Environment * GetUnmanagedEnvironment ()=0
 Retrieve the underlying, unmanaged, environment.
virtual System::Boolean HasLicenseForLanguage (LanguageID lid, System::UInt32 functionality)=0
 Determines if a license exists for the language and functionality.
virtual System::Boolean HasLicenseForNamedFeature (String^ feature, System::UInt32 functionality)=0
 Determines if a license exists for the feature and functionality.
virtual System::Boolean HasLicenses ()=0
 Determines if there are language and feature licenses in the environment.
virtual void InitializeFromFile (String^ environment_spec_file)=0
 Initialize the environment from an XML file.
virtual void InitializeFromXML (String^ environment_xml_definition)=0
 Initialize the environment from an XML String.
virtual ~Environment ()

Static Public Member Functions

static EnvironmentCreate ()
 Create a new enviroment.
static String^ RootDirectory ()
 Query the BT_ROOT/rlp directory.
static void SetLogCallback (LogCallback^ callback)
 Set the callback delegate for logging strings.
static void SetLogLevel (String^ logLevelSpec)
 Set the logging level.
static void SetRootDirectory (String^ rootDirectory)
 Set the BT_ROOT/rlp directory, globally.


Constructor & Destructor Documentation

virtual BasisTechnology::RLP::Environment::~Environment (  )  [virtual]


Member Function Documentation

static Environment ^ BasisTechnology::RLP::Environment::Create (  )  [static]

virtual Context ^ BasisTechnology::RLP::Environment::CreateContextFromFile ( String^   context_spec_file  )  [pure virtual]

Parameters:
context_spec_file the context definition file pathname.

virtual Context ^ BasisTechnology::RLP::Environment::CreateContextFromXML ( String^   context_xml_definition  )  [pure virtual]

Parameters:
context_xml_definition the context definition in XML.

virtual String ^ BasisTechnology::RLP::Environment::GetProcessorReport (  )  [pure virtual]

Returns:
the report string. The format is ProcName0|Description0|ProcName1|Description1|...|ProcNameN|DescriptionN||

virtual BT_RLP_Environment* BasisTechnology::RLP::Environment::GetUnmanagedEnvironment (  )  [pure virtual]

This function is useful for other managed extensions that need to call the RLP API from the unmanaged side of the code.

virtual System::Boolean BasisTechnology::RLP::Environment::HasLicenseForLanguage ( LanguageID  lid,
System::UInt32  functionality 
) [pure virtual]

virtual System::Boolean BasisTechnology::RLP::Environment::HasLicenseForNamedFeature ( String^   feature,
System::UInt32  functionality 
) [pure virtual]

virtual System::Boolean BasisTechnology::RLP::Environment::HasLicenses (  )  [pure virtual]

virtual void BasisTechnology::RLP::Environment::InitializeFromFile ( String^   environment_spec_file  )  [pure virtual]

Parameters:
environment_spec_file the environment definition file.

virtual void BasisTechnology::RLP::Environment::InitializeFromXML ( String^   environment_xml_definition  )  [pure virtual]

Parameters:
environment_xml_definition the environment definition string.

static String ^ BasisTechnology::RLP::Environment::RootDirectory (  )  [static]

Returns:
The setting of the RLP root directory.

static void BasisTechnology::RLP::Environment::SetLogCallback ( LogCallback^   callback  )  [static]

Parameters:
callback the delegate to call for each logged string.

static void BasisTechnology::RLP::Environment::SetLogLevel ( String^   logLevelSpec  )  [static]

Parameters:
logLevelSpec list of logging types separated by commands, e.g. "error,warning"

static void BasisTechnology::RLP::Environment::SetRootDirectory ( String^   rootDirectory  )  [static]

Call this only before creating an environment.

Parameters:
rootDirectory the setting of the RLP root directory.


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

Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.