Utility Class Reference

Collection of 'class methods'. More...

Inheritance diagram for Utility:

Static Public Member Functions
_.Library.Status	Backup (_.Library.String File)
	Do a quick global save - in GOF format.
_.Library.Integer	BoatMovements (_.Library.Date StartDate, _.Library.Date EndDate, _.Library.String areaid, _.Library.String user)
	populate class of boat movements so that we can run the boat movements report
_.Library.Status	BolPollAll ()
	Scans each bollard, currently in use, and calls the CheckUsage()l method on the Address Object.
_.Library.Boolean	BolPollRunning ()
	Returns true if the Bollard polling is running already.
_.Library.String	BolPollStart ()
	Kick off the Background polling job.
_.Library.Boolean	BolPollStop ()
	Stop Bollard Polling.
_.Library.String	ComMode ()
	write the com port settings to a file
_.Library.Integer	CreateContract (_.Library.Integer pinnumber, _.Library.Integer keypad, _.Library.String contractid)
	Generate a new contract based on input from keypad. More...
_.Library.Integer	CurrentMoorings (_.Library.Date date, _.Library.Boolean showall, _.Library.String areaid, _.Library.String user, _.Library.String location, _.Library.String future)
	; This is an attempt to join tables while Cache SQL doesn't do it properly More...
_.Library.String	GetSelectMooringId (_.Library.String ipaddress)
	return the value of SelectMooringId via a class method so that we don't have to open the class in VB
_.Library.String	GetVersion ()
	get the version of clearwater mms or lite
_.Library.Integer	InitialiseComms ()
	Initialise the com port for use with the LCD display and bollards.
_.Library.Integer	KeyPadPollRunning ()
	is the key pad polling running 1 yes 0 no
_.Library.Integer	KeyPadPollStart ()
	Which polling "AllOn" or "AllOff". More...
_.Library.Boolean	KeyPadPollStop ()
	stop polling the key pads
_.Library.Numeric	LicenceCheck (_.Library.String login)
	has the licence expired?
_.Library.Numeric	PollBollard (_.Library.Numeric Address1, _.Library.Numeric Address2, _.Library.Numeric Services, _.Library.Numeric Electricity, _.Library.Numeric Water, _.Library.Numeric Telephone1, _.Library.Numeric Telephone2, _.Library.Numeric Telephone3, _.Library.Numeric Telephone4, ClearWater.Contract contract)
	; Address More...
	PurgeMessages ()
	delete all system messages older than 1 week
_.Library.Status	Restore (_.Library.String File)
	Restore from a backup.
	SetSqlSchema (_.Library.String schema)
	set the default sql schema, so that ado updates work
_.Library.Integer	Update (_.Library.String contractid)
	given a contract number set the status of the service for addresses to On
_.Library.String	UserForLockedLicensee (_.Library.String licenseeId)
	Return the user for a locked licensee - ie a the user that has open the account that another user wants to look at.

Public Attributes
	HostIP
	IP address of the pc on which the licensee will be opened. More...
	OpenLicenseeId
	ID of Licensee to be Opened. More...
	RequestUser
	The name of the user who is making a request. More...
	Revision
	More...
	SelectMooringId
	Mooring selected for new contract from browser based map interface. More...

Detailed Description

Collection of 'class methods'.

Deltanji status:

Object	ClearWater.Utility.CLS/MARINA.0
Component	CLS.ClearWater.Utility
Location	MARINA.test2
Date/Time	15-May-20 21:21
User	johnm

Member Function Documentation

CreateContract()

_.Library.Integer CreateContract ( _.Library.Integer  pinnumber, _.Library.Integer  keypad, _.Library.String  contractid  )

static

Generate a new contract based on input from keypad.

Processing removed!

CurrentMoorings()

_.Library.Integer CurrentMoorings ( _.Library.Date  date, _.Library.Boolean  showall, _.Library.String  areaid, _.Library.String  user, _.Library.String  location, _.Library.String  future  )

static

; This is an attempt to join tables while Cache SQL doesn't do it properly

; showall parameter 0 means don't get fields which aren't require - to speed it up

KeyPadPollStart()

_.Library.Integer KeyPadPollStart ( )

static

Which polling "AllOn" or "AllOff".

"KeyPad"

wait for input from keypad

1 can't open file 2 already running 3 error starting job Contect Removed!

PollBollard()

_.Library.Numeric PollBollard ( _.Library.Numeric  Address1, _.Library.Numeric  Address2, _.Library.Numeric  Services, _.Library.Numeric  Electricity, _.Library.Numeric  Water, _.Library.Numeric  Telephone1, _.Library.Numeric  Telephone2, _.Library.Numeric  Telephone3, _.Library.Numeric  Telephone4, ClearWater.Contract  contract  )

static

; Address

; Services bit 0 Elictric bit 1 Water bit 2 Tv bit 3 Phone bit 4 Security bit 5

bit 7 Reset all counts and electric meter

Member Data Documentation

HostIP

HostIP

IP address of the pc on which the licensee will be opened.

 

OpenLicenseeId

OpenLicenseeId

ID of Licensee to be Opened.

' this is set from the VFE application.

a timer then monitors to see if there is an id to open. If so then the Licensee is opened in ClearWater.  

RequestUser

RequestUser

The name of the user who is making a request.

 

Revision

Revision

 

 

SelectMooringId

SelectMooringId

Mooring selected for new contract from browser based map interface.

Is checked by a timer in frmallcoatemooring