PFSClob Class

PFSClob Class

Clob is short of Character Large Object.

A Clob can be used to store a multitude of parameters in a single PFS parameter e.g. storing vectors/matrices of coordinates. This can save space for the PFS file and improve performance of reading and handling the PFS file.

Reading data from a Clob works as iterating over a list of parameters. Calling one of the Get methods will return the "current" parameter and forward the iterator to the next parameter in the Clob.

The structure of the clob must be known beforehand, i.e. the number of Clob values and the order the different types of values in must match the order of methods called for retrieving the values. If that is not the case, an exception is thrown, i.e. if the next value in the Clob is a double, and the GetString method is called, an exception is thrown.

Inheritance Hierarchy

SystemObject
DHI.PFSPFSClob

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

Syntax

C++

Copy

public class PFSClob

Public Class PFSClob

public ref class PFSClob

type PFSClob =  class end

The PFSClob type exposes the following members.

Constructors

	Name	Description
	PFSClob	Internal constructor

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetBool	Read boolean from Clob If next Clob value is not a boolean, an exception is thrown.
	GetDouble	Read double from Clob If next Clob value is not a double, an exception is thrown.
	GetFilename	Read file name string from Clob If next Clob value is not a file name string, an exception is thrown.
	GetFloat	Read float from Clob If next Clob value is not a float, an exception is thrown.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInt	Read integer from Clob If next Clob value is not an integer, an exception is thrown.
	GetItem	Get the next Clob parameter as a PFSParameter, where you can query it for the type of parameter data.
	GetString	Read string from Clob If next Clob value is not a string, an exception is thrown.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsEnd	Returns true of the Clob has no more parameters
	Reset	Reset reading of parameters from Clob
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

DHI.PFS Namespace