tcsSTATE Class Reference

See man page tcsSTATE(4)

#include <tcsSTATE.h>

Inheritance diagram for tcsSTATE:

Public Member Functions
	tcsSTATE (const dbSYMADDRESS dbPoint, fndNAME_MAP *newNameMap=NULL)
virtual	~tcsSTATE ()
virtual vltLOGICAL	IsOnline ()
Static Protected Attributes
static fndNAME_AND_INDEX	defStateNames []
static fndNAME_MAP	defStateNameMap

Detailed Description

See man page tcsSTATE(4)

Manpage of tcsSTATE

tcsSTATE

Section: Devices and Network Interfaces (4)
Updated: 2012-04-23 10:08
Index Return to man pages list

NAME

tcsSTATE - process state handling class.

SYNOPSIS


#include <tcsSTATE>
tcsSTATE tcsState(dbPoint, fndNAME_MAP *newNameMap = NULL);

PARENT CLASS


evhDB_TASK

DESCRIPTION


This class provides reading and writing of the process state on database,
as well as value to name translation.

PUBLIC METHODS


tcsSTATE(dbSYMADDRESS dbPoint, fndNAME_MAP *newNameMap = NULL);
  The constructor creates an object to access the database
  attribute of the state, expected to be the <dbPoint>.state attribute.
  If NULL is passed the standard evh states and state names are used.

vltLOGICAL IsOnline();
  Returns ccsTRUE if the current state is an ONLINE sub-state, i.e.
  IDLE or BUSY.

PROTECTED DATA MEMBERS


static fndNAME_AND_INDEX defStateNames[];
static fndNAME_MAP       defStateNameMap;
  Static objects to handle mapping of standard TCS state names and ids

ON LINE DATABASE


The support point on the database must be a (sub-) class of evhDB_TASK:

    point evhDB_TASK  "myControlInstance"

This document was created by man2html, using the manual pages.
Time: 10:08:47 GMT, April 23, 2012

Definition at line 30 of file tcsSTATE.h.

Constructor & Destructor Documentation

tcsSTATE::tcsSTATE	(	const dbSYMADDRESS	dbPoint,
		fndNAME_MAP *	newNameMap = `NULL`
	)

tcsSTATE::~tcsSTATE ( ) [virtual]

Definition at line 107 of file tcsSTATE.C.

Member Function Documentation

vltLOGICAL tcsSTATE::IsOnline ( ) [virtual]

Definition at line 113 of file tcsSTATE.C.

Member Data Documentation

fndNAME_MAP tcsSTATE::defStateNameMap [static, protected]

Definition at line 41 of file tcsSTATE.h.

fndNAME_AND_INDEX tcsSTATE::defStateNames[] [static, protected]

Definition at line 40 of file tcsSTATE.h.

The documentation for this class was generated from the following files:

VLT Software Documentation