libsbml.Date Class Reference

Inheritance diagram for libsbml.Date:

[legend]

List of all members.

---

Detailed Description

Representation of MIRIAM-compliant dates used in ModelHistory.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

A Date object stores a reasonably complete date representation, consisting of the following fields:

• year: an unsigned int representing the year.
• month: an unsigned int representing the month.
• day: an unsigned int representing the day.
• hour: an unsigned int representing the hour.
• minute: an unsigned int representing the minute.
• second: an unsigned int representing the second.
• sign: an unsigned int representing the sign of the offset (0/1 equivalent to +/-).
• hours offset: an unsigned int representing the hoursOffset.
• minute offset: an unsigned int representing the minutesOffset.

Definition at line 31765 of file libsbml.py.

Public Member Functions
def	__eq__
def	__init__
def	__ne__
def	clone
def	getDateAsString
def	getDay
def	getHour
def	getHoursOffset
def	getMinute
def	getMinutesOffset
def	getMonth
def	getSecond
def	getSignOffset
def	getYear
def	representsValidDate
def	setDateAsString
def	setDay
def	setHour
def	setHoursOffset
def	setMinute
def	setMinutesOffset
def	setMonth
def	setSecond
def	setSignOffset
def	setYear
Public Attributes
	this

---

Member Function Documentation

def libsbml.Date.__eq__	(		self,
			rhs
	)

Definition at line 32252 of file libsbml.py.

def libsbml.Date.__init__	(		self,
			args
	)

Python method signature(s):

__init__(self, unsigned int year = 2007, unsigned int month = 1, unsigned int day = 1, 
    unsigned int hour = 0, unsigned int minute = 0, 
    unsigned int second = 0, 
    unsigned int sign = 0, unsigned int hoursOffset = 0, 
    unsigned int minutesOffset = 0)    Date
__init__(self, unsigned int year = 2007, unsigned int month = 1, unsigned int day = 1, 
    unsigned int hour = 0, unsigned int minute = 0, 
    unsigned int second = 0, 
    unsigned int sign = 0, unsigned int hoursOffset = 0)    Date
__init__(self, unsigned int year = 2007, unsigned int month = 1, unsigned int day = 1, 
    unsigned int hour = 0, unsigned int minute = 0, 
    unsigned int second = 0, 
    unsigned int sign = 0)    Date
__init__(self, unsigned int year = 2007, unsigned int month = 1, unsigned int day = 1, 
    unsigned int hour = 0, unsigned int minute = 0, 
    unsigned int second = 0)    Date
__init__(self, unsigned int year = 2007, unsigned int month = 1, unsigned int day = 1, 
    unsigned int hour = 0, unsigned int minute = 0)    Date
__init__(self, unsigned int year = 2007, unsigned int month = 1, unsigned int day = 1, 
    unsigned int hour = 0)    Date
__init__(self, unsigned int year = 2007, unsigned int month = 1, unsigned int day = 1)    Date
__init__(self, unsigned int year = 2007, unsigned int month = 1)    Date
__init__(self, unsigned int year = 2007)    Date
__init__(self)    Date
__init__(self, string date)    Date
__init__(self, Date orig)    Date

Copy constructor; creates a copy of this Date.

Definition at line 31793 of file libsbml.py.

def libsbml.Date.__ne__	(		self,
			rhs
	)

Definition at line 32259 of file libsbml.py.

def libsbml.Date.clone

(

self

)

Python method signature(s):

clone(self)    Date

Returns a copy of this Date.

Returns:

a (deep) copy of this Date.

Definition at line 31832 of file libsbml.py.

def libsbml.Date.getDateAsString

(

self

)

Python method signature(s):

getDateAsString(self)    string

Returns the Date as a string.

Returns:

the date as a string.

Definition at line 31982 of file libsbml.py.

def libsbml.Date.getDay

(

self

)

Python method signature(s):

getDay(self)    unsigned int

Returns the day from this Date.

Returns:

the day from this Date.

Definition at line 31877 of file libsbml.py.

def libsbml.Date.getHour

(

self

)

Python method signature(s):

getHour(self)    unsigned int

Returns the hour from this Date.

Returns:

the hour from this Date.

Definition at line 31892 of file libsbml.py.

def libsbml.Date.getHoursOffset

(

self

)

Python method signature(s):

getHoursOffset(self)    unsigned int

Returns the hours of the offset from this Date.

Returns:

the hours of the offset from this Date.

Definition at line 31952 of file libsbml.py.

def libsbml.Date.getMinute

(

self

)

Python method signature(s):

getMinute(self)    unsigned int

Returns the minute from this Date.

Returns:

the minute from this Date.

Definition at line 31907 of file libsbml.py.

def libsbml.Date.getMinutesOffset

(

self

)

Python method signature(s):

getMinutesOffset(self)    unsigned int

Returns the minutes of the offset from this Date.

Returns:

the minutes of the offset from this Date.

Definition at line 31967 of file libsbml.py.

def libsbml.Date.getMonth

(

self

)

Python method signature(s):

getMonth(self)    unsigned int

Returns the month from this Date.

Returns:

the month from this Date.

Definition at line 31862 of file libsbml.py.

def libsbml.Date.getSecond

(

self

)

Python method signature(s):

getSecond(self)    unsigned int

Returns the seconds from this Date.

Returns:

the seconds from this Date.

Definition at line 31922 of file libsbml.py.

def libsbml.Date.getSignOffset

(

self

)

Python method signature(s):

getSignOffset(self)    unsigned int

Returns the sign of the offset from this Date.

Returns:

the sign of the offset from this Date.

Definition at line 31937 of file libsbml.py.

def libsbml.Date.getYear

(

self

)

Python method signature(s):

getYear(self)    unsigned int

Returns the year from this Date.

Returns:

the year from this Date.

Definition at line 31847 of file libsbml.py.

def libsbml.Date.representsValidDate

(

self

)

Python method signature(s):

representsValidDate(self)    bool

Sets the value of the date string checking appropriateness.

Parameters:

date

a string representing the date.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Note:

the string should be in W3CDTF format YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00) where TZD is the time zone designator.

Definition at line 32225 of file libsbml.py.

def libsbml.Date.setDateAsString	(		self,
			args
	)

Python method signature(s):

setDateAsString(self, string date)    int

Sets the value of the date string checking appropriateness.

Parameters:

date

a string representing the date.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Note:

the string should be in W3CDTF format YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00) where TZD is the time zone designator.

Definition at line 32198 of file libsbml.py.

def libsbml.Date.setDay	(		self,
			args
	)

Python method signature(s):

setDay(self, unsigned int day)    int

Sets the value of the day checking appropriateness.

Parameters:

day

an unsigned int representing the day to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32041 of file libsbml.py.

def libsbml.Date.setHour	(		self,
			args
	)

Python method signature(s):

setHour(self, unsigned int hour)    int

Sets the value of the hour checking appropriateness.

Parameters:

hour

an unsigned int representing the hour to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32063 of file libsbml.py.

def libsbml.Date.setHoursOffset	(		self,
			args
	)

Python method signature(s):

setHoursOffset(self, unsigned int hoursOffset)    int

Sets the value of the offset hour checking appropriateness.

Parameters:

hoursOffset

an unsigned int representing the hours of the offset to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32152 of file libsbml.py.

def libsbml.Date.setMinute	(		self,
			args
	)

Python method signature(s):

setMinute(self, unsigned int minute)    int

Sets the value of the minute checking appropriateness.

Parameters:

minute

an unsigned int representing the minute to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32085 of file libsbml.py.

def libsbml.Date.setMinutesOffset	(		self,
			args
	)

Python method signature(s):

setMinutesOffset(self, unsigned int minutesOffset)    int

Sets the value of the offset minutes checking appropriateness.

Parameters:

minutesOffset

an unsigned int representing the minutes of the offset to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32175 of file libsbml.py.

def libsbml.Date.setMonth	(		self,
			args
	)

Python method signature(s):

setMonth(self, unsigned int month)    int

Sets the value of the month checking appropriateness.

Parameters:

month

an unsigned int representing the month to set

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32019 of file libsbml.py.

def libsbml.Date.setSecond	(		self,
			args
	)

Python method signature(s):

setSecond(self, unsigned int second)    int

Sets the value of the second checking appropriateness.

Parameters:

second

an unsigned int representing the second to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32107 of file libsbml.py.

def libsbml.Date.setSignOffset	(		self,
			args
	)

Python method signature(s):

setSignOffset(self, unsigned int sign)    int

Sets the value of the offset sign checking appropriateness.

Parameters:

sign

an unsigned int representing the sign of the offset to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 32129 of file libsbml.py.

def libsbml.Date.setYear	(		self,
			args
	)

Python method signature(s):

setYear(self, unsigned int year)    int

Sets the value of the year checking appropriateness.

Parameters:

year

an unsigned int representing the year to set.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Definition at line 31997 of file libsbml.py.

---

Member Data Documentation

libsbml.Date.this

Definition at line 31831 of file libsbml.py.