diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/python/ccm.FourPartName-class.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/python/ccm.FourPartName-class.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,640 @@ + + + + + ccm.FourPartName + + + + + + + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ + Package ccm :: + Class FourPartName + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FourPartName

source code

+
+object --+
+         |
+        FourPartName
+
+ +
+This class handle four part name parsing and validation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + ifpn)
+ Create a FourPartName object based on a ifpn string.		 + source code + +
+ +
+   + + + + + + +
__getname(self)
+ Returns the name of the object.		 + source code + +
+ +
+   + + + + + + +
__getversion(self)
+ Returns the version of the object.		 + source code + +
+ +
+   + + + + + + +
__gettype(self)
+ Returns the type of the object.		 + source code + +
+ +
+   + + + + + + +
__getinstance(self)
+ Returns the instance of the object.		 + source code + +
+ +
+   + + + + + + +
__getobjectname(self)
+ Returns the objectname of the object.		 + source code + +
+ +
+   + + + + + + +
__str__(self)
+ Returns the string representation of the object.		 + source code + +
+ +
+   + + + + + + +
__repr__(self)
+ Returns the string representation of the python object.		 + source code + +
+ +
+   + + + + + + +
is_same_family(self, + ccmobject)
+ Returns True if the ccmobject is part of the same family (=same name, type and version) as self.		 + source code + +
+ +
+   + + + + + + +
__getfamily(self) + source code + +
+ +
+   + + + + + + +
__eq__(self, + ccmobject)
+ Returns True if object four parts name are identical.		 + source code + +
+ +
+   + + + + + + +
__ne__(self, + ccmobject)
+ Returns True if object four parts name are different.		 + source code + +
+ +
+   + + + + + + +
name(self)
+ Returns the name of the object.		 + source code + +
+ +
+   + + + + + + +
version(self)
+ Returns the version of the object.		 + source code + +
+ +
+   + + + + + + +
type(self)
+ Returns the type of the object.		 + source code + +
+ +
+   + + + + + + +
instance(self)
+ Returns the instance of the object.		 + source code + +
+ +
+   + + + + + + +
objectname(self)
+ Returns the objectname of the object.		 + source code + +
+ +
+   + + + + + + +
family(self) + source code + +
+ +
+

Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __setattr__ +

+
+ + + + + + + + + + + + +
+ + + + + +
Static Methods[hide private]
+
+   + + + + + + +
is_valid(fpn)
+ Check if a given string represents a valid four part name.		 + source code + +
+ +
+   + + + + + + +
convert(fpn)
+ Update a CCM output string to a valid four part name.		 + source code + +
+ +
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + ifpn) +
(Constructor) +

+ 		source code  +
+ +

Create a FourPartName object based on a ifpn string.

+

The string have to match the following patterns: +- name-version:type:instance +- name:version:releasedef:instance +- Task database#id +- Folder database#id

+

Anything else is considered as old release string format.

+
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

__str__(self) +
(Informal representation operator) +

+ 		source code  +
+ + Returns the string representation of the object. +
+
Overrides: + object.__str__ +
+
+
+
+ +
+ +
+ + +
+

__repr__(self) +
(Representation operator) +

+ 		source code  +
+ + Returns the string representation of the python object. +
+
Overrides: + object.__repr__ +
+
+
+
+ +
+ +
+ + +
+

convert(fpn) +
Static Method +

+ 		source code  +
+ + Update a CCM output string to a valid four part name. This is due to the f$*@ing inconsistent +output of CM/Synergy that will probably never get fixed as it would require they hire humains +and not apes to core their CLI. +
+
+
+
+
+ + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 + + http://epydoc.sourceforge.net +
+ + + + +