DCAtomicField¶

class DCAtomicField¶

Bases: DCField

A single atomic field of a Distributed Class, as read from a .dc file. This defines an interface to the Distributed Class, and is always implemented as a remote procedure method.

Inheritance diagram

digraph inheritanceae8e21c762 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DCAtomicField" [URL="acron.direct.DCAtomicField.html#acron.direct.DCAtomicField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DCField" -> "DCAtomicField" [arrowsize=0.75,style=""]; "DCField" [URL="acron.direct.DCField.html#acron.direct.DCField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DCPackerInterface" -> "DCField" [arrowsize=0.75,style=""]; "DCKeywordList" -> "DCField" [arrowsize=0.75,style=""]; "DCKeywordList" [URL="acron.direct.DCKeywordList.html#acron.direct.DCKeywordList",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "DCKeywordList" [arrowsize=0.75,style=""]; "DCPackerInterface" [URL="acron.direct.DCPackerInterface.html#acron.direct.DCPackerInterface",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "DCPackerInterface" [arrowsize=0.75,style=""]; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; }

DCAtomicField.get_element()¶: Returns the parameter object describing the nth element.

DCAtomicField.get_element_default()¶

These five methods are deprecated and will be removed soon.

Returns the pre-formatted default value associated with the nth element of the field. This is only valid if has_element_default() returns true, in which case this string represents the bytes that should be assigned to the field as a default value.

If the element is an array-type element, the returned value will include the two-byte length preceding the array data.

Deprecated: use get_element() instead.

DCAtomicField.get_element_divisor()¶

Returns the divisor associated with the nth element of the field. This implements an implicit fixed-point system; floating-point values are to be multiplied by this value before encoding into a packet, and divided by this number after decoding.

This method is deprecated; use get_element()->get_divisor() instead.

DCAtomicField.get_element_name()¶

Returns the name of the nth element of the field. This name is strictly for documentary purposes; it does not generally affect operation. If a name is not specified, this will be the empty string.

Deprecated: use get_element()->get_name() instead.

DCAtomicField.get_element_type()¶: Returns the numeric type of the nth element of the field. This method is deprecated; use get_element() instead.

DCAtomicField.get_num_elements()¶: Returns the number of elements (parameters) of the atomic field.

DCAtomicField.has_element_default()¶

Returns true if the nth element of the field has a default value specified, false otherwise.

Deprecated: use get_element() instead.