| | |
- builtins.object
-
- ADef
- Aref
- Cid
- Oid
- Tid
- Vid
class ADef(builtins.object) |
| |
Proview attribute definition
|
| |
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
- cid()
- Get the class identity for the attribute definition object.
Returns
-------
Returns the class identity as an integer value.
- elements()
- Get number of elements of the attribute.
Returns
-------
Returns the number of elements.
- flags()
- Get flags word of the attribute.
Returns
-------
Returns the flags as an integer value.
- name()
- Get the name of the attribute.
Returns
-------
Returns a string with the attribute name.
Example
-------
c = pwrwb.Cid('$PlantHier')
for adef in c.attributes():
print adef.name()
'Description'
'DefGraph'
...
- offset()
- Get offset of the attribute.
Returns
-------
Returns an integer value with the offset.
- size()
- Get size of the attribute.
Returns
-------
Returns an integer value with the size.
- typeref(...)
- offset()
--
Get TypeRef of the attribute.
Returns
-------
Returns an integer value with the TypeRef.
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
|
class Aref(builtins.object) |
| |
Proview development attribute
|
| |
Methods defined here:
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __gt__(self, value, /)
- Return self>value.
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __le__(self, value, /)
- Return self<=value.
- __lt__(self, value, /)
- Return self<value.
- __ne__(self, value, /)
- Return self!=value.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
- arefStr()
- Get attribute reference as a string.
Returns
-------
Returns a string with the attribute reference.
Example
-------
o = pwrwb.attribute('H1-Dv1.ActualValue')
print a.arefStr()
'_A0.1.200.3:334(_T0.2:0.111.1)[88.4]'
- fullName()
- Get the full name of the attribute.
Returns the full attribute name, including volume and path.
Returns
-------
Returns a string with the full attribute name.
Example
-------
a = pwrwb.attribute('H1-H2-Dv1.ActualValue')
print a.fullName()
- name()
- Get the name of the attribute.
Returns the last segment of the object and attribute name, without
the path.
Returns
-------
Returns a string with the attribute name.
Example
-------
a = pwrwb.attribute('H1-H2-Dv1.ActualValue')
print a.name()
- setValue(value, publicwrite)
- Set the value of an attribute.
Set is only permitted if a user with RtWrite or System privileges
is logged in, or if the attribute is an attribute with public write
permissions. In this case the public write argument should be set to 1.
Arguments
---------
value Arbitrary type
The value types for different attributes types should be
pwr_tEnum Integer.
pwr_tMask Integer.
pwr_tStatus Integer.
pwr_tObjid OidObject.
pwr_tAttrRef ArefObject.
pwr_tTime A string with format '17-JAN-2019 10:51:10.58'. Can be
converted from a datetime with format
'%d-%b-%Y %H:%M:%S.%f'.
publicwrite Optional Integer
1 if value is set to an attribute with public write permissions.
Example
-------
pwrwb.login('pwrp', 'somepassword')
a = pwrwb.attribute('H1-H2-Dv1.ActualValue')
a.setValue(1)
- tid()
- Get attribute type.
Returns
-------
Returns a Tid object for the type.
Example
-------
a = pwrwb.attribute('H1-Dv1.ActualValue')
t = o.tid()
print t.fullName()
- value()
- Get the value of an attribute.
Returns
-------
Returns the value of the attribute.
Return types for different attributes types are
pwr_tEnum Integer.
pwr_tMask Integer.
pwr_tStatus Integer.
pwr_tObjid OidObject.
pwr_tAttrRef ArefObject.
pwr_tTime A string with format '17-JAN-2019 10:51:10.58'. Can be
converted from a datetime with format
'%d-%b-%Y %H:%M:%S.%f'.
Example
-------
a = pwrwb.object('H1-Dv1.ActualValue')
print a.value()
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- __hash__ = None
|
class Cid(builtins.object) |
| |
Class of a development object
|
| |
Methods defined here:
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __gt__(self, value, /)
- Return self>value.
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __le__(self, value, /)
- Return self<=value.
- __lt__(self, value, /)
- Return self<value.
- __ne__(self, value, /)
- Return self!=value.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
- attrObject()
- Get the first instance of the class, including attribute objects.
Returns
-------
Returns an Aref object for the first instance of the class.
Example
-------
cid = pwrwb.Cid('Di')
a = cid.attrObject()
while a:
print a.fullName()
a = cid.nextAttrObject(a)
- attrObjects()
- Get all instances of the class, including attribute objects.
Returns
-------
Returns tuple of Aref object for all instance of the class.
Example
-------
cid = pwrwb.Cid('Di')
for a in cid.attrObjects():
print a.fullName()
- attributes()
- Get all attributes defined in the class.
Returns
-------
Returns tuple of ADef objects for all the defined attributes in
the class.
Example
-------
cid = pwrwb.Cid('$PlantHier')
for adef in cid.attributes():
print adef.name(), adef.offset(), adef.size()
- fullName()
- Get the full name of the class object.
Returns
-------
Returns a string with the class name.
Example
-------
c = pwrwb.Cid('$PlantHier')
print c.fullName()
'pwrs:Class-$PlantHier'
- name()
- Get the name of the class.
Returns
-------
Returns a string with the class name.
Example
-------
c = pwrwb.Cid('$PlantHier')
print c.name()
'$PlantHier'
- nextAttrObject(attribute)
- Get the next instance of the class, including attribute objects.
Arguments
---------
attribute Aref object
An Aref object for the previous instance.
Returns
-------
Returns an Aref object for the next instance of the class.
Example
-------
cid = pwrwb.Cid('Di')
a = cid.attrObject()
while a:
print a.fullName()
a = cid.nextAttrObject(a)
- nextObject(object)
- Get the next instance of the class.
Arguments
---------
object Oid object
An Oid object for the previous instance.
Returns
-------
Returns an Oid object for the next instance of the class.
Example
-------
cid = pwrwb.Cid('$PlantHier')
o = cid.object()
while o:
print o.fullName()
o = cid.nextObject(o)
- object()
- Get the first instance of the class.
The object() method only gets whole objects and doesn't include
attribute objects (see attrObject()).
Returns
-------
Returns an Oid object for the first instance of the class.
Example
-------
cid = pwrwb.Cid('$PlantHier')
o = cid.object()
while o:
print o.fullName()
o = cid.nextObject(o)
- objects()
- Get all instances of the class.
Returns
-------
Returns tuple of Oid object for all instance of the class.
Example
-------
cid = pwrwb.Cid('$PlantHier')
for o in cid.objects():
print o.fullName()
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- __hash__ = None
|
class Oid(builtins.object) |
| |
ProviewR development object
The Oid object represents a ProviewR object.
|
| |
Methods defined here:
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __gt__(self, value, /)
- Return self>value.
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __le__(self, value, /)
- Return self<=value.
- __lt__(self, value, /)
- Return self<value.
- __ne__(self, value, /)
- Return self!=value.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
- attribute(attributeName)
- Get an attribute within the object.
Arguments
---------
attributeName String
Name of attribute.
Returns
-------
Returns an Aref object for the attribute.
Example
-------
o = pwrwb.object('H1-Dv1')
a = o.attribute('ActualValue')
print a.value()
- child()
- Get first child of the object.
Returns
-------
Returns an Oid object for the first child.
Example
-------
o = pwrwb.object('H1-H2')
child = o.child()
while child:
print child.name()
child = child.next()
- children()
- Get all children of the object.
Returns
-------
Returns a tuple containg Oid objects for all children of the object.
Example
-------
o = pwrwb.object('H1-H2')
for child in o.children()
print child.name()
- cid()
- Get object class.
Returns
-------
Returns a Cid object for the class.
Example
-------
o = pwrwb.object('H1-Dv1')
c = o.cid()
print c.fullName()
- fullName()
- Get the full name of the object.
Returns the full object name, including volume and path.
Returns
-------
Returns a string with the full object name.
Example
-------
o = pwrwb.object('H1-H2')
print o.fullName()
- name()
- Get the name of the object.
Returns the last segment of the object name, without the path.
Returns
-------
Returns a string with the object name.
Example
-------
o = pwrwb.object('H1-H2')
print o.name()
- next()
- Get the next sibling of the object.
Returns
-------
Returns an Oid object for the sibling. If no next sibling exist, a
None object is returned.
Example
-------
o = pwrwb.object('H1-H2')
child = o.child()
while (child):
print child.name()
child = child.next()
- oidStr()
- Get object identity as a string.
Arguments
---------
format Optional String
If not supplied oix is in decimal form.
'hex' oix in hexadecimal.
'file' for hex file format.
Returns
-------
Returns a string with the object identity.
Example
-------
o = pwrwb.object('H1-Dv1')
print o.oidStr()
'_O0.1.200.3:334'
- parent()
- Get the parent of the object.
Returns
-------
Returns an Oid object for the parent.
Example
-------
o = pwrwb.object('H1-H2')
parent = o.parent()
print parent.name()
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- __hash__ = None
|
class Tid(builtins.object) |
| |
Attribute type
|
| |
Methods defined here:
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __gt__(self, value, /)
- Return self>value.
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __le__(self, value, /)
- Return self<=value.
- __lt__(self, value, /)
- Return self<value.
- __ne__(self, value, /)
- Return self!=value.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
- fullName()
- Get the full name of the type object.
Returns
-------
Returns a string with the full type name.
Example
-------
a = pwrwb.attribute('H1-H2-Dv1.ActualValue')
tid = a.tid()
print tid.fullName()
'pwrs:Type-$Boolean'
- name()
- Get the name of the type.
Returns
-------
Returns a string with the type name.
Example
-------
a = pwrwb.attribute('H1-H2-Dv1.ActualValue')
tid = a.tid()
print tid.name()
'$Boolean'
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- __hash__ = None
|
class Vid(builtins.object) |
| |
ProviewR development volume
The Vid object represents a ProviewR volume.
|
| |
Methods defined here:
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __gt__(self, value, /)
- Return self>value.
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __le__(self, value, /)
- Return self<=value.
- __lt__(self, value, /)
- Return self<value.
- __ne__(self, value, /)
- Return self!=value.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
- cid()
- Get volume class.
Returns
-------
Returns a Cid object for the class.
Example
-------
v = pwrwb.volume('VolDemo')
c = v.cid()
print c.fullName()
- fullName()
- Same as name().
- name()
- Get the name of the volume.
Returns volume name.
Returns
-------
Returns a string with the volume name.
Example
-------
v = pwrwb.volume('VolDemo')
print v.name()
- next()
- Get the next volume.
Returns
-------
Returns an vid object for the volume. If no next volume exist, a
None object is returned.
Example
-------
v = pwrwb.volume('VolDemo')
while (v):
print v.name()
v = v.next()
- root()
- Get first root object of the volume.
Returns
-------
Returns an Oid object for the root object.
Example
-------
v = pwrwb.object('VolDemo')
o = v.child()
while o:
print o.name()
o = o.next()
- roots()
- Get all root objects of the volume.
Returns
-------
Returns a tuple containg Oid objects for all root objects of the volume.
Example
-------
v = pwrwb.volume('VolDemo')
for o in v.children()
print o.name()
- vidStr(...)
- vid()
--
Get volume identity as a string.
Returns
-------
Returns a string with the volume identity.
Example
-------
v = pwrwb.volume('VolDemo')
print v.vidStr()
'_V0.1.200.3'
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- __hash__ = None
| |