MyClass.MyClass Class Reference

MyClass is a class to act an an example of our stye and formating guide. More...

Public Member Functions
	__init__ (self, ObjName)
	Constructor for the MyClass object.
	Create (self, BaseObj)
	Create() for the MyClass object.
	Open (self)
	Performs opening of file and communcations and takes no input.
	Close (self)
	Close(self) Performs closing of files and communcations and takes no input.
	Read (self)
	Read().
	Write (self)
	Write() performs writing to files and communcations.
	testObject (self, modName)
	This function performs mod tests.

Public Attributes
	ObjName = ObjName
	ObjName contains the name of this object.
	bobj = BaseObj
	bobj contains the global object.
	cfg = self.bobj.cfg.config
	log = self.bobj.log
int	dlvl = 50

Detailed Description

MyClass is a class to act an an example of our stye and formating guide.

Constructor & Destructor Documentation

__init__()

MyClass.MyClass.__init__	(		self,
			ObjName )

Constructor for the MyClass object.

Parameters

ObjName

– (string) Saves the name of the object.

Member Function Documentation

Close()

MyClass.MyClass.Close

(

self

)

Close(self) Performs closing of files and communcations and takes no input.

Parameters

self	The object pointer.

Create()

MyClass.MyClass.Create	(		self,
			BaseObj )

Create() for the MyClass object.

Parameters

BaseObj

– (FPIBGBase) this is the global class that contains the log and config file facilities.

Open()

MyClass.MyClass.Open

(

self

)

Performs opening of file and communcations and takes no input.

Any data this function needs is assigned to class members in the Create function

Parameters

self	The object pointer.

Read()

MyClass.MyClass.Read

(

self

)

Read().

Performs reading of files and communcations.

Parameters

self	The object pointer.

testObject()

MyClass.MyClass.testObject	(		self,
			modName )

This function performs mod tests.

It is not only a test function but provides an example of how you class works to other developers. The first test should be as shown here, that is to test access to logging and configuration.

Parameters

modName

(string) the module name of the test.

Write()

MyClass.MyClass.Write

(

self

)

Write() performs writing to files and communcations.

Parameters

self	The object pointer.

Member Data Documentation

bobj

MyClass.MyClass.bobj = BaseObj

bobj contains the global object.

cfg

MyClass.MyClass.cfg = self.bobj.cfg.config

dlvl

int MyClass.MyClass.dlvl = 50

log

MyClass.MyClass.log = self.bobj.log

ObjName

MyClass.MyClass.ObjName = ObjName

ObjName contains the name of this object.

---

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

• python/shared/MyClass.py