openc2lib.types.base.array

 1from openc2lib.types.base.openc2_type import Openc2Type
 2
 3class Array(Openc2Type, list):
 4	""" OpenC2 Array
 5
 6		Implements OpenC2 Array:
 7		>An ordered list of unnamed fields with positionally-defined semantics. 
 8		Each field has a position, label, and type.
 9
10		However, position does not matter in this implementation.
11
12		Derived classes must provide a `fieldtypes` dictionary that associate each field name
13		to its class. This is strictly required in order to instantiate the object at
14		deserialization time. However, no check is performed when new items are inserted.
15	"""
16	fieldtypes = None
17	""" Field types
18
19		A `dictionary` which keys are field names and which values are the corresponding classes.
20		Must be provided by any derived class.
21	"""
22
23	def todict(self, e):
24		""" Converts to dictionary 
25		
26			It is used to convert this object to an intermediary representation during 
27			serialization. It takes an `Encoder` argument that is used to recursively
28			serialize inner data and structures (the `Encoder` provides standard methods
29			for converting base types to dictionaries).. 
30
31			:param e: The `Encoder` that is being used.
32			:return: A dictionary compliants to the Language Specification's serialization
33			rules.
34		"""
35		lis = []
36		for i in self:
37			lis.append = e.todict(i)
38		return lis
39
40	def fromdict(cls, dic, e):
41		""" !!! WARNING !!!
42			Currently not implemented because there are no examples of usage of this
43			type (only Array/net, which is not clear)
44		"""
45		raise Exception("Function not implemented")