Contents

class xr_def_iter_flags

Flag class: properties for an xr_definition_iterator .

xr_def_iter_flags Members

Constructors none
Static Method from_integer()
Methods __and__(), __cmp__(), __eq__(), __ge__(), __gt__(), __hash__(), __invert__(), __le__(), __lt__(), __ne__(), __or__(), __repr__(), __str__(), as_integer(), name()
Attributes DROP_LIBMODEL_DEFS, NONE

xr_def_iter_flags Details

class cs.xr_def_iter_flags

Flag class: properties for an xr_definition_iterator .

static from_integer(_inner)

Construct an instance from an integer representation.

Parameters:_inner (int) – The integer representation, as returned by xr_def_iter_flags.as_integer().
Return type:xr_def_iter_flags
Raises:result.ERROR_INVALID_ARGUMENT if _inner is not a valid integer representation for a xr_def_iter_flags instance.

Invariant: For xr_def_iter_flags x, xr_def_iter_flags.from_integer(x.as_integer()) == x

>>> xdi = xr_def_iter_flags.DROP_LIBMODEL_DEFS.as_integer()
>>> xdi
1
>>> xr_def_iter_flags.from_integer(xdi)
<cs.xr_def_iter_flags drop_libmodel_defs>
__and__(b)

AND operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – AND operand.
Return type:xr_def_iter_flags
Returns:A xr_def_iter_flags object containing all flags that are in both self and b. 
>>> xr_def_iter_flags.DROP_LIBMODEL_DEFS & xr_def_iter_flags.NONE
<cs.xr_def_iter_flags none>
__cmp__(other)

Comparison function for xr_def_iter_flags , with respect to a stable overall ordering.

Parameters:other (xr_def_iter_flags) – The xr_def_iter_flags object to compare against.
Return type:int
Returns:An integer N such that:
  • N==0 if the two objects compare equal
  • N<0 if self < other
  • N>0 if self > other
 
>>> xr_def_iter_flags.NONE.__cmp__(xr_def_iter_flags.NONE)
0
__eq__(b)

Equality operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – The xr_def_iter_flags object to compare against.
Return type:bool
Returns:True if self and b compare equal, False otherwise. 
>>> xr_def_iter_flags.DROP_LIBMODEL_DEFS == xr_def_iter_flags.DROP_LIBMODEL_DEFS
True
__ge__(b)

Greater-than-or-equal operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – The xr_def_iter_flags object to compare against.
Return type:bool
Returns:True if self >= b , False otherwise. 
>>> xr_def_iter_flags.NONE >= xr_def_iter_flags.DROP_LIBMODEL_DEFS
False
__gt__(b)

Greater-than operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – The xr_def_iter_flags object to compare against.
Return type:bool
Returns:True if self > b , False otherwise. 
>>> xr_def_iter_flags.NONE > xr_def_iter_flags.NONE
False
__hash__()

Hash function for xr_def_iter_flags .

Return type:int 
>>> hash(xr_def_iter_flags.DROP_LIBMODEL_DEFS)
1
__invert__()

Complementation operator.

Return type:xr_def_iter_flags
Returns:A xr_def_iter_flags object containing the flags that are NOT contained in self. 
>>> ~xr_def_iter_flags.NONE
<cs.xr_def_iter_flags drop_libmodel_defs>
__le__(b)

Less-than-or-equal operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – The xr_def_iter_flags object to compare against.
Return type:bool
Returns:True if self <= b , False otherwise. 
>>> xr_def_iter_flags.DROP_LIBMODEL_DEFS <= xr_def_iter_flags.NONE
False
__lt__(b)

Less-than operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – The xr_def_iter_flags object to compare against.
Return type:bool
Returns:True if self < b , False otherwise. 
>>> xr_def_iter_flags.DROP_LIBMODEL_DEFS < xr_def_iter_flags.NONE
False
__ne__(b)

Inequality operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – The xr_def_iter_flags object to compare against.
Return type:bool
Returns:False if self and b compare equal, True otherwise. 
>>> xr_def_iter_flags.DROP_LIBMODEL_DEFS != xr_def_iter_flags.NONE
True
__or__(b)

OR operator for xr_def_iter_flags .

Parameters:b (xr_def_iter_flags) – OR operand.
Return type:xr_def_iter_flags
Returns:A xr_def_iter_flags object containing all flags that are in at least one of self, b. 
>>> xr_def_iter_flags.NONE | xr_def_iter_flags.DROP_LIBMODEL_DEFS
<cs.xr_def_iter_flags drop_libmodel_defs>
__repr__()

Get a representation of a xr_def_iter_flags object that includes information useful for debugging.

Return type:str
Returns:The string representation. 
>>> repr(xr_def_iter_flags.NONE)
'<cs.xr_def_iter_flags none>'
__str__()

Get a simple string representation of a xr_def_iter_flags object.

Return type:str
Returns:The string representation. 
>>> str(xr_def_iter_flags.DROP_LIBMODEL_DEFS)
'drop_libmodel_defs'
as_integer()

Get an integer representation of self.

Return type:int
Returns:An integer suitable for use with xr_def_iter_flags.from_integer().

Invariant: For xr_def_iter_flags x, xr_def_iter_flags.from_integer(x.as_integer()) == x

>>> xdi = xr_def_iter_flags.DROP_LIBMODEL_DEFS.as_integer()
>>> xdi
1L
>>> xr_def_iter_flags.from_integer(xdi)
<cs.xr_def_iter_flags drop_libmodel_defs>
name()

Get the name of a xr_def_iter_flags object.

Return type:str 
>>> xr_def_iter_flags.DROP_LIBMODEL_DEFS.name()
'drop_libmodel_defs'
DROP_LIBMODEL_DEFS

Singleton set containing the “drop libmodel defs” flag: if a definition is in a library model, don’t include it in the iteration.

>>> xr_def_iter_flags.DROP_LIBMODEL_DEFS
<cs.xr_def_iter_flags drop_libmodel_defs>
NONE

Empty set: contains no flags.

>>> xr_def_iter_flags.NONE
<cs.xr_def_iter_flags none>