Class CPLParameters
Introduction
This class implements one instance of a runtime parameter block image. Class methods permit reading and writing a parameter block image from and to powerline devices or local host files. Class properties permit direct access to the parameter block but expose only a few parameter block elements. Application that must access specific parameter block elements should inherit this class.
This class is declared in CPLParameters.hpp and defined in CPLParameters.cpp.
Properties
CPLParameters::Data
void * Data
void
Return the absolute address of the parameter block image.
CPLParameters::IsValid
bool IsValid
void
Return true if the current parameter block image appears valid. Validity is determined by comparing the parameter block length and checksum to the values stored in the parameter block header.
CPLParameters::Size
size_t Size
void
Return the size of the parameter block image last read from a powerline device or host file. This will be the sum of all bytes read and should equal the PIBLength value stored in the parameter block header. This class does not
Methods
CPLParameters::Read
signed Read
char const * filename
Read the parameter block image from the named host file.
CPLParameters::Read
signed Read
CPLChannel * channel
Read the parameter block image from the powerline device assigned to the given channel. This method will fetch the working parameter block image if the parameter block scratch buffer on the device is empty.
CPLParameters::Write
signed Write
char const * filename
Write the parameter block image to the named host file.
CPLParameters::Write
signed Write
CPLChannel * channel
Write the parameter block image to the powerline device assigned to the given channel. This methods fills or over-write the parameter block image buffer on the powerline device.
Constructors
CPLParameters
CPLChannel * channel
Initialize the instance by reading the parameter block image from the powerline device assigned by the given channel.
CPLParameters
char const * filename
Initialize the instance by reading the parameter block image from the named host file.