Version: 13.0

    Show / Hide Table of Contents

    Class EnvironmentSummary

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    EnvironmentSummary
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.cacheRpds
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, (T1, T2)<Type, Object>[])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T1, T2>(String, (T1, T2)<Type, Object>, T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.isInvalid
    APIBase.DocumentationUrl()
    APIBase.ToString()
    APIBase.RunPython<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String)
    APIBase.RunPython<T>(String, String)
    APIBase.CreateObjRef(Type)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
    Namespace: SMT.MastaAPI.Utility
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class EnvironmentSummary : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    BuildDate

    Declaration
    public string BuildDate { get; }
    Property Value
    Type Description
    System.String

    BuildDateAndAge

    Declaration
    public string BuildDateAndAge { get; }
    Property Value
    Type Description
    System.String

    CommandLine

    The command line (with arguments) that was used to start this process

    Declaration
    public string CommandLine { get; }
    Property Value
    Type Description
    System.String

    CoreFeatureCodeInUse

    Declaration
    public string CoreFeatureCodeInUse { get; }
    Property Value
    Type Description
    System.String

    CoreFeatureExpiry

    Declaration
    public string CoreFeatureExpiry { get; }
    Property Value
    Type Description
    System.String

    CurrentCulture

    Declaration
    public NumberFormatInfoSummary CurrentCulture { get; }
    Property Value
    Type Description
    NumberFormatInfoSummary

    CurrentCultureSystemLocale

    The culture (locale) defines the way that numbers and dates are formatted.

    Declaration
    public string CurrentCultureSystemLocale { get; }
    Property Value
    Type Description
    System.String

    CurrentNETVersion

    Declaration
    public string CurrentNETVersion { get; }
    Property Value
    Type Description
    System.String

    CurrentUICultureSystemLocale

    The user interface culture (locale) affects the way that strings and images are displayed to the user.

    Declaration
    public string CurrentUICultureSystemLocale { get; }
    Property Value
    Type Description
    System.String

    DateTimeISO8601

    This represents the date and the time in a format in a standardised format (e.g. "2014-09-18T17:19:17").

    Declaration
    public string DateTimeISO8601 { get; }
    Property Value
    Type Description
    System.String

    DateTimeLocalFormat

    This represents the date and the time in a format in the format specific to this machine.

    Declaration
    public string DateTimeLocalFormat { get; }
    Property Value
    Type Description
    System.String

    DispatcherInformation

    Declaration
    public string DispatcherInformation { get; }
    Property Value
    Type Description
    System.String

    Dispatchers

    Declaration
    public ReadOnlyCollection<DispatcherHelper> Dispatchers { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ReadOnlyCollection<DispatcherHelper>

    EntryAssembly

    Declaration
    public string EntryAssembly { get; }
    Property Value
    Type Description
    System.String

    ExecutableDirectory

    The directory that the executing code is running from

    Declaration
    public string ExecutableDirectory { get; }
    Property Value
    Type Description
    System.String

    ExecutableDirectoryIsNetworkPath

    The directory that the executing code is running from is a network directory and therefore may be susceptible to network interruptions

    Declaration
    public bool ExecutableDirectoryIsNetworkPath { get; }
    Property Value
    Type Description
    System.Boolean

    InstalledVideoControllers

    The video controllers present on the system. Note that only one of these will be in use if there are more than one.

    Declaration
    public string InstalledVideoControllers { get; }
    Property Value
    Type Description
    System.String

    Is64BitOperatingSystem

    Declaration
    public bool Is64BitOperatingSystem { get; }
    Property Value
    Type Description
    System.Boolean

    LicenceKey

    Declaration
    public string LicenceKey { get; }
    Property Value
    Type Description
    System.String

    MachineName

    Declaration
    public string MachineName { get; }
    Property Value
    Type Description
    System.String

    MASTAVersion

    Declaration
    public string MASTAVersion { get; }
    Property Value
    Type Description
    System.String

    OpenGLRenderer

    Name of the renderer

    Declaration
    public string OpenGLRenderer { get; }
    Property Value
    Type Description
    System.String

    OpenGLVendor

    The company responsible for the GL implementation

    Declaration
    public string OpenGLVendor { get; }
    Property Value
    Type Description
    System.String

    OpenGLVersion

    Declaration
    public string OpenGLVersion { get; }
    Property Value
    Type Description
    System.String

    OperatingSystem

    Declaration
    public string OperatingSystem { get; }
    Property Value
    Type Description
    System.String

    Prerequisites

    Declaration
    public string Prerequisites { get; }
    Property Value
    Type Description
    System.String

    Processor

    Declaration
    public string Processor { get; }
    Property Value
    Type Description
    System.String

    ProcessRenderMode

    The process render mode is 'Software Only' if hardware rendering has been disabled. If the process render mode is 'Default' hardware acceleration will be used if possible.

    Declaration
    public string ProcessRenderMode { get; }
    Property Value
    Type Description
    System.String

    RAM

    Declaration
    public string RAM { get; }
    Property Value
    Type Description
    System.String

    RemoteDesktopInformation

    Uses functionality from Windows to detect if the use of remote desktop was detected either at startup, or now.

    Declaration
    public string RemoteDesktopInformation { get; }
    Property Value
    Type Description
    System.String

    ReportNames

    Declaration
    public IReadOnlyList<string> ReportNames { get; }
    Property Value
    Type Description
    System.Collections.Generic.IReadOnlyList<System.String>

    StartDateTimeAndAge

    This represents the date and the time that the current process started.

    Declaration
    public string StartDateTimeAndAge { get; }
    Property Value
    Type Description
    System.String

    UserName

    Declaration
    public string UserName { get; }
    Property Value
    Type Description
    System.String

    VideoControllerInUse

    The video controller currently being used by the application.

    Declaration
    public string VideoControllerInUse { get; }
    Property Value
    Type Description
    System.String

    Methods

    Copy()

    Declaration
    public void Copy()

    GetActiveReportWithEncodedImages()

    Declaration
    public string GetActiveReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetDefaultReportWithEncodedImages()

    Declaration
    public string GetDefaultReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetNamedReportWithEncodedImages(String)

    Declaration
    public string GetNamedReportWithEncodedImages(string reportName)
    Parameters
    Type Name Description
    System.String reportName
    Returns
    Type Description
    System.String

    OutputActiveReportAsTextTo(String)

    Declaration
    public void OutputActiveReportAsTextTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputActiveReportTo(String)

    Declaration
    public void OutputActiveReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputDefaultReportTo(String)

    Declaration
    public void OutputDefaultReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputNamedReportAsMastaReport(String, String)

    Declaration
    public void OutputNamedReportAsMastaReport(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportAsTextTo(String, String)

    Declaration
    public void OutputNamedReportAsTextTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportTo(String, String)

    Declaration
    public void OutputNamedReportTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    Implements

    System.IEquatable<T>

    Extension Methods

    UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)
    UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)
    In This Article
    • Fields
      • _parent
    • Properties
      • BuildDate
      • BuildDateAndAge
      • CommandLine
      • CoreFeatureCodeInUse
      • CoreFeatureExpiry
      • CurrentCulture
      • CurrentCultureSystemLocale
      • CurrentNETVersion
      • CurrentUICultureSystemLocale
      • DateTimeISO8601
      • DateTimeLocalFormat
      • DispatcherInformation
      • Dispatchers
      • EntryAssembly
      • ExecutableDirectory
      • ExecutableDirectoryIsNetworkPath
      • InstalledVideoControllers
      • Is64BitOperatingSystem
      • LicenceKey
      • MachineName
      • MASTAVersion
      • OpenGLRenderer
      • OpenGLVendor
      • OpenGLVersion
      • OperatingSystem
      • Prerequisites
      • Processor
      • ProcessRenderMode
      • RAM
      • RemoteDesktopInformation
      • ReportNames
      • StartDateTimeAndAge
      • UserName
      • VideoControllerInUse
    • Methods
      • Copy()
      • GetActiveReportWithEncodedImages()
      • GetDefaultReportWithEncodedImages()
      • GetNamedReportWithEncodedImages(String)
      • OutputActiveReportAsTextTo(String)
      • OutputActiveReportTo(String)
      • OutputDefaultReportTo(String)
      • OutputNamedReportAsMastaReport(String, String)
      • OutputNamedReportAsTextTo(String, String)
      • OutputNamedReportTo(String, String)
    • Implements
    • Extension Methods
    Back to top