Class GetProtocolInfoResponseMessage

Namespace: Skyline.DataMiner.Net.Messages

Assembly: SLNetTypes.dll

Represents information for a single protocol

public class GetProtocolInfoResponseMessage : ResponseMessage

Inheritance: object

DMSMessage

ResponseMessage

GetProtocolInfoResponseMessage

Extension Methods: TypeExtensions.ChangeType<T>(object)

Constructors

GetProtocolInfoResponseMessage(): Initializes a new instance of the GetProtocolInfoResponseMessage class.

GetProtocolInfoResponseMessage(GetProtocolInfoResponseMessage): Initializes a new instance of the GetProtocolInfoResponseMessage class.

Fields

AdvancedTypes: The extra port types/names "type1:name1;type2:name2".

ConfigurationOptions: The configuration options.

DefaultPage: The default page.

Description: The protocol description.

DisplayType: The display type.

DisplayWideColumnPages: The wide column pages.

ElementType: The element type.

ExtraPortsConfigOptions: The extra port config options.

Information: Name of the information template to use.

MainConnectionName: The main connection name.

Name: The protocol name.

PageOptions: The page options.

PageOrder: The page order.

Parameters: The protocol parameters.

TreeControls: The tree control definitions.

Trending: The trending.

Type: The protocol type.

Vendor: The vendor.

Version: The protocol version.

Properties

AdvancedSecurity: Gets or sets the advanced security.

AllParameters: Gets or sets all parameters.

AppType: Gets or sets the application type.

BaseParameters: Gets or sets all base protocol parameters.

BaseProtocolType: Gets or sets the name of the element type for which this protocol is a base protocol, if this protocol is a base protocol.

Compliancies: Gets or sets the compliancies.

DefinesRCA: Gets or sets a value indicating whether this protocol defines RCA.

DisableViewRefresh: Gets or sets a value indicating whether "view" type tables in this protocol cannot be automatically refreshed by the client.

ExportedTableRawInfo: Gets or sets the raw version of the data exposed by ExportedTables.

ExportedTables: Gets the list of exported tables.

ForceDefaultAlarming: Gets a value indicating whether the forceDefaultAlarming option is used.

FunctionGUID: Gets or sets the function GUID.

HasConnectivityInterfaces: Gets or sets a value indicating whether this protocol has connectivity interfaces.

HasExposers: Gets or sets a value indicating whether this protocol has exposers.

HasHelp: Gets or sets a value indicating whether this protocol object has help available.

HasInformationTemplateApplied: Gets or sets a value indicating whether this protocol object has the information.xml template information applied to it.

HasNoElementPrefix: Gets or sets a value indicating whether this protocol has no element prefix.

HasParametersForElementConnections: Gets a value indicating whether the protocol has at least one parameter that can be used as a virtual source or destination (element connections).

HasVdx: Gets or sets a value indicating whether this protocol object has a VDX available.

HasViewImpactColumn: Gets or sets a value indicating whether this protocol has a view impact column.

HasVisio: Gets or sets a value indicating whether this protocol object has a VDX or VSDX available.

HasVsdx: Gets or sets a value indicating whether this protocol object has a VSDX available.

Icon: Gets or sets the icon info (XAML code).

InternalLicenses: Gets the internal licenses this protocol has.

IsAggregatorProtocol: Gets a value indicating whether this protocol is an aggregator protocol.

IsApp: Gets a value indicating whether this protocol is an application.

IsBaseProtocol: Gets or sets a value indicating whether the protocol is a base protocol.

IsDveMainElement: Gets or sets a value indicating whether the protocol defines exported protocols, making it a main element for DVE children.

IsExportedProtocol: Gets or sets a value indicating whether this protocol is exported.

IsIndexing: Gets or sets a value indicating whether this protocol contains at least one active parameter that will be indexed as DynamicData.

IsMatrixElement: Gets or sets a value indicating whether the protocol defines matrix parameters.

IsPartitionedTrendingEnabled: Gets or sets a value indicating whether this protocol needs to enable partitioning on the trend tables.

IsProduction: Gets or sets a value indicating whether this protocol is a production protocol.

IsSigned: Gets or sets a value indicating whether this protocol has a signature.

IsUnicodeType: Gets or sets a value indicating whether the protocol table keys are in Unicode.

MaxProtocolRCA: If the protocol defines internal RCA chains (RCA/Protocol/Link), the maximum depth. Otherwise, -1.

Pages: Page information.

ParameterGroups: Gets or sets the parameter groups.

ParentProtocolName: Gets or sets the name of the parent protocol for which the protocol was exported. (For exported protocols.)

ProcessAutomationInfo: Gets or sets the Process Automation info.

ProtocolFunctions: The list of available protocol functions.

ProtocolType: Gets or sets the protocol type.

ProtocolTypes: Gets the protocol types.

Provider: Gets or sets the provider.

Relations: Gets or sets the table relations specified in the protocol.

SearchControls: Gets or sets the search control definitions.

SignVendor: Gets or sets the vendor that signed this protocol.

Topologies: Gets or sets the topologies.

TopologyAllChains: Gets all topology chains (combination of TopologyChains and SearchChains) in the order defined in the protocol.xml.

TopologyChains: Gets or sets the topology chains.

TopologyChainsFilter: Gets or sets the topology chains filter.

TopologySearchChains: Gets or sets the search chains that have been defined.

UniqueCacheKey: Gets or sets the unique cache ID.

VersionHistory: Gets or sets the protocol version history.

Methods

AddCompliancyPair(string, string): Adds the specified compliancy pair.

AddInternalLicense(InternalLicenseType): Adds the internal license for the specified license type.

ApplyUserLevel(int): Applies the specified user level.

FilterParameters(ParameterFilterOptions): Filters and/or sorts a collection of parameters, given a combination of selection options. E.g. returns a collection with only the analog parameters if options is set to ParameterFilterOptions.AnalogOnly.

FilterParameters(ParameterFilterOptions, Predicate<ParameterInfo>): Filters and/or sorts a collection of parameters, given a combination of selection options. E.g. returns a collection with only the analog parameters if options is set to ParameterFilterOptions.AnalogOnly.

FindAssociatedColumnParameter(int, int): Finds the associated column parameter info for the specified column parameter.

FindAssociatedColumnParameter(ParameterInfo, int): Finds the associated column parameter info for the specified column parameter.

FindAssociatedDisplayKeyColumn(ParameterInfo): Finds the associated display key column parameter for the specified table parameter.

FindAssociatedPrimaryKeyColumn(ParameterInfo): Finds the associated primary key column parameter for the specified table parameter.

FindAssociatedReadParameter(ParameterInfo): Finds the read parameter that is associated with the specified write parameter. If no such parameter is found, returns null.

FindAssociatedTableParameter(int): Retrieves the associated table parameter info for the specified column parameter.

FindAssociatedTableParameter(ParameterInfo): Finds the table parameter that is associated with the specified column parameter.

FindAssociatedTableParameterID(int): Finds the associated table parameter ID for the specified column parameter.

FindAssociatedWriteParameter(ParameterInfo): Finds the write parameter that is associated with the specified read parameter. If no such parameter is found, returns null.

FindChildTables(ProtocolTopologyCell): Finds the child tables for the specified cell.

FindChildTables(string, ProtocolTopologyCell): Finds the child tables for the specified cell.

FindChildTables(string, int): Finds the child tables for the specified cell.

FindPageNames(): Returns all page names that are used by parameters in the protocol.

FindPages(): Returns information about which pages have been defined in the protocol, and which parameters are on each of these pages.

FindParameter(int): Returns the ParameterInfo object for the parameter with the given ID. When no parameter is found, returns null.

FindParameter(string): Returns the ParameterInfo object for the parameter with the given description. When no parameter is found, returns null.

FindParameter(string, bool): Finds the specified parameter.

FindParametersByMask(string): Finds the parameter by the specified mask.

FindParametersByMask(string, bool): Finds the parameter by the specified mask.

FindParentTables(string, ProtocolTopologyCell): Finds the parent tables for the specified cell.

FindParentTables(string, int): Finds the parent tables for the specified cell.

FindTopologyCell(string, int): Finds the topology cell for the specified name and table ID.

GetAllParameters(): Gets all parameters.

GetCompliancy(CompliancyKey): Retrieves the compliancy pair for the specified key.

GetExportProtocolCsv(): Retrieves a CSV for the protocol parameters.

GetInternalLicense(InternalLicenseType): Retrieves the internal license for the specified license type.

GetParameterDisplayValue(int, ParameterValue): Converts the given parameter value into a format that is ready for display.

GetParameterDisplayValue(int, ParameterValue, CultureInfo, bool): Converts the given parameter value into a format that is ready for display.

GetParameterDisplayValue(int, string, bool, bool): Converts the given raw value into a format ready for display.

GetParameterDisplayValue(int, string, CultureInfo, bool, bool, bool): Converts the given raw value into a format ready for display.

GetParameterName(int): Returns the name of a specified parameter.

GetParameterName(int, string): Gets the name of the specified parameter.

GetParameterUIDisplayValue(int, ParameterValue): Gets the string that should be used to display the value in the UI. This will enable number grouping, using the DataMinerNumberCulture. This will group digits per 3 with a short space.

GetTopologyDataFor(string): Gets the topology data for the specified name.

GetUIParameterDisplayValue(int, string, bool, bool): Converts the given raw value into a format ready for display in the UI, with number group separator.

HasExposerFor(string): Determines whether this protocol has an exposer for the specified name.

IsBaseProtocolParameter(int): Returns a value that indicates whether the specified parameter is a base protocol parameter.

IsProtocolType(ProtocolType): Checks the main type and advanced types if it matches the specified value.

IsVirtualFunction(): Returns a value indication of whether this protocol is a virtual function.

LinkParametersToProtocol(): Links all of the child parameter info objects to this object.

ProtocolTypeToString(ProtocolType): Converts the ProtocolType enum to its string representation.

ToProtocolType(string): Converts the specified type to ProtocolType.

Propose changes