pyOlog.OlogClient.OlogClient Class Reference

List of all members.

Public Member Functions
def	__init__
def	log
def	createLogbook
def	createTag
def	createProperty
def	find
def	listAttachments
def	listTags
def	listLogbooks
def	listProperties
def	delete

---

Detailed Description

classdocs

Definition at line 20 of file OlogClient.py.

---

Constructor & Destructor Documentation

def pyOlog.OlogClient.OlogClient.__init__	(		self,
			url = None,
			username = None,
			password = None
	)

Constructor

Definition at line 31 of file OlogClient.py.

---

Member Function Documentation

def pyOlog.OlogClient.OlogClient.createLogbook	(		self,
			logbook
	)

Create Logbook

Definition at line 80 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.createProperty	(		self,
			property
	)

Create Property

Definition at line 102 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.createTag	(		self,
			tag
	)

Create Tag

Definition at line 91 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.delete	(		self,
			kwds
	)

Method to delete a logEntry, logbook, property, tag
delete(logEntryId = int)
>>> delete(logEntryId=1234)

delete(logbookName = String)
>>> delete(logbookName = 'logbookName')

delete(tagName = String)
>>> delete(tagName = 'myTag')
# tagName = tag name of the tag to be deleted (it will be removed from all logEntries)

delete(propertyName = String)
>>> delete(propertyName = 'position')
# propertyName = property name of property to be deleted (it will be removed from all logEntries)

Definition at line 216 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.find	(		self,
			kwds
	)

Search for logEntries based on one or many search criteria
>> find(search='*Timing*')
find logentries with the text Timing in the description

>> find(tag='magnets')
find log entries with the a tag named 'magnets'

>> find(logbook='controls')
find log entries in the logbook named 'controls'

>> find(property='context')
find log entires with property named 'context'

>> find(start=str(time.time() - 3600)
find the log entries made in the last hour
>> find(start=123243434, end=123244434)
find all the log entries made between the epoc times 123243434 and 123244434

Searching using multiple criteria
>>find(logbook='contorls', tag='magnets')
find all the log entries in logbook 'controls' AND with tag named 'magnets'

Definition at line 114 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.listAttachments	(		self,
			logEntryId
	)

Search for attachments on logentry _id_

Definition at line 151 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.listLogbooks

(

self

)

List all logbooks

Definition at line 187 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.listProperties

(

self

)

List all Properties and their attributes

Definition at line 201 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.listTags

(

self

)

List all tags.

Definition at line 173 of file OlogClient.py.

def pyOlog.OlogClient.OlogClient.log	(		self,
			logEntry
	)

create a logEntry

Definition at line 58 of file OlogClient.py.

---

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

• /scratch/jenkins/workspace/Olog-Publish/modules/pyOlog/pyOlog/OlogClient.py