acmecse.helpers.ACMEIntEnum.ACMEIntEnum

class documentation

class ACMEIntEnum(IntEnum):

Known subclasses: acmecse.etc.ResponseStatusCodes.ResponseStatusCode, acmecse.etc.Types.Announced, acmecse.etc.Types.AnnounceSyncType, acmecse.etc.Types.AuthorizationResult, acmecse.etc.Types.BasicType, acmecse.etc.Types.BatteryStatus, acmecse.etc.Types.BeaconCriteria, acmecse.etc.Types.BindingType, acmecse.etc.Types.Cardinality, acmecse.etc.Types.ConsistencyStrategy, acmecse.etc.Types.ContentSerializationType, acmecse.etc.Types.CSEStatus, acmecse.etc.Types.CSEType, acmecse.etc.Types.DesiredIdentifierResultType, acmecse.etc.Types.EvalCriteriaOperator, acmecse.etc.Types.EvalMode, acmecse.etc.Types.EventCategory, acmecse.etc.Types.EventEvaluationMode, acmecse.etc.Types.FilterOperation, acmecse.etc.Types.FilterUsage, acmecse.etc.Types.GeofenceEventCriteria, acmecse.etc.Types.GeometryType, acmecse.etc.Types.GeoSpatialFunctionType, acmecse.etc.Types.IdentifierScope, acmecse.etc.Types.LocationInformationType, acmecse.etc.Types.LocationSource, acmecse.etc.Types.LocationUpdateEventCriteria, acmecse.etc.Types.LogicalOperator, acmecse.etc.Types.LogLevel, acmecse.etc.Types.NotificationContentType, acmecse.etc.Types.NotificationEventType, acmecse.etc.Types.NotificationTargetPolicyAction, acmecse.etc.Types.Operation, acmecse.etc.Types.OriginatorType, acmecse.etc.Types.Permission, acmecse.etc.Types.ProcessControl, acmecse.etc.Types.ProcessState, acmecse.etc.Types.RequestOptionality, acmecse.etc.Types.RequestStatus, acmecse.etc.Types.RequestType, acmecse.etc.Types.ResourceTypes, acmecse.etc.Types.ResponseType, acmecse.etc.Types.ResultContentType, acmecse.etc.Types.SemanticFormat, acmecse.etc.Types.Status, acmecse.etc.Types.TimeWindowType, acmecse.etc.Types.TreeMode, acmecse.etc.Types.TriggerStatus, acmecse.etc.Types.WifiConnectionStatus

View In Hierarchy

A base class for many oneM2M related enum types in the ACME CSE. It provides additional halper methods to simplify working with IntEnum classes.

Class Method has Check whether the enum type has an entry with either the given int value or string name.
Class Method to Return an enum value by its name.
Method __int__ Get the integer value of an enum.
Method __repr__ Stringify an enum.
Method __str__ Stringify an enum.
@classmethod
def has(cls, value: int | str | list[int | str] | tuple[int | str]) -> bool:

Check whether the enum type has an entry with either the given int value or string name.

Parameters
value:int | str | list[int | str] | tuple[int | str]value can also be a tuple of values to test. In this case, all the values in the tuple must exist.
Returns
boolTrue if the value exists.
@classmethod
def to(cls, name: str | tuple[str], insensitive: bool | None = False) -> Any:
overridden in acmecse.etc.Types.BasicType, acmecse.etc.Types.Cardinality

Return an enum value by its name.

Parameters
name:str | tuple[str]String or a tuple of strings with names.
insensitive:bool | NoneOptional boolean indicating whether names should be treated case-sensitive or not.
Returns
AnyA valid enum value, a list of enum values if name is a tupple of strings (according to the order in the tuple), or None in case of an error.
def __int__(self) -> int:

Get the integer value of an enum.

Returns
intThe value of an enum value.
def __repr__(self) -> str:

Stringify an enum.

Returns
strThe name of an enum value.
def __str__(self) -> str:
overridden in acmecse.etc.Types.ResourceTypes, acmecse.etc.Types.TreeMode

Stringify an enum.

Returns
strThe name of an enum value.