PFSParameter Class

PFSParameter Class

A PFSParameter object refers to one single parameter of a Keyword.

Every parameter contains one type of value in it. It is the users responsibility to call the get value function matching the type of the parameter. If the parameter is an integer, and ToDouble() is called, an exception is thrown.

Inheritance Hierarchy

SystemObject
DHI.PFSPFSParameter

Namespace: DHI.PFS
Assembly: DHI.PFS (in DHI.PFS.dll) Version: 16.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class PFSParameter

Public Class PFSParameter

public ref class PFSParameter

type PFSParameter =  class end

The PFSParameter type exposes the following members.

Constructors

	Name	Description
	PFSParameter	Initialize a PFSParameter with the given pfs(Node?) pointer.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInstanceNo	Obsolete. Internal method, for testing/debugging only
	GetSyntaxClass	Obsolete. Internal method, for testing/debugging only
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsBool	Check if this parameter is a boolean parameter
	IsClob	Check if this parameter is a Blob parameter
	IsDouble	Check if this parameter is a double parameter
	IsFilename	Check if this parameter is a filename parameter
	IsInt	Check if this parameter is an integer parameter
	IsSingle	Check if this parameter is a single parameter
	IsString	Check if this parameter is a string parameter
	IsUndefined	Check if this parameter is an undefined parameter
	ModifyBoolParameter	Modify the value of this parameter, if it is bool type
	ModifyDoubleParameter	Modify the value of this parameter, if it is double type
	ModifyFileNameParameter	Modify the value of this parameter, if it is File Name type
	ModifyIntParameter	Modify the value of this parameter, if it is int type
	ModifyStringParameter	Modify the value of this parameter, if it is string type
	ToBoolean	Get the Boolean value of the parameter
	ToClob	Get the Clob object from the parameter. If this parameter is not a Clob parameter, an exception is thrown.
	ToDouble	Get the double value of the parameter If this parameter is not a double parameter, an exception is thrown.
	ToFileName	Get the file name value of the parameter. The returned string is the value as entered in the PFS file, i.e. path can be relative If this parameter is not a file name parameter, an exception is thrown.
	ToFileNamePath	Get a string with the filename and path. The returned string will contain the full path to the file. In case the file name string is relative, the path of the pfs file is used as base path to create a full path string. If this parameter is not a file name parameter, an exception is thrown.
	ToInt	Get the integer value of the parameter If this parameter is not an integer parameter, an exception is thrown.
	ToResultFileName	Get the string or filename value as result-filename. A convenience method that for a string returns ToString and for a filename returns ToFileName
	ToResultFileNamePath	Get the result file name path. The result file name path for relative file name strings depends on whether the underlying pfs parameter is a filename parameter or a string parameter. For a filename parameter, the result file folder is the folder of the pfs file, and a relative file name string is relative to the pfs file location. For a string parameter, the result file folder is taken into consideration when creating the path. The result file folder is either the default "pfsFile.pfs - Result Files\", the project defined output folder or the custom defined output folder. The result file name path is always absolute.
	ToSingle	The the single (float) value of the parameter If this parameter is not a single/double parameter, an exception is thrown.
	ToString	Get the string value of the parameter. If this parameter is not a string parameter, an exception is thrown. (Overrides ObjectToString.)

Top

Reference

DHI.PFS Namespace