DCField¶

class DCField¶

Bases: DCPackerInterface, DCKeywordList

A single field of a Distributed Class, either atomic or molecular.

Inheritance diagram

digraph inheritance44927110e6 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "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=""]; }

DCField.ai_format_update()¶

DCField.ai_format_update_msg_type()¶

DCField.as_atomic_field()¶

Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL.

DCField.as_field()¶

DCField.as_molecular_field()¶

Returns the same field pointer converted to a molecular field pointer, if this is in fact a molecular field; otherwise, returns NULL.

DCField.as_parameter()¶

DCField.client_format_update()¶

DCField.format_data()¶: Given a blob that represents the packed data for this field, returns a string formatting it for human consumption. Returns empty string if there is an error.

DCField.get_class()¶: Returns the DCClass pointer for the class that contains this field.

DCField.get_default_value()¶: Returns the default value for this field. If a default value has been explicitly set (e.g. has_default_value() returns true), returns that value; otherwise, returns an implicit default for the field.

DCField.get_number()¶: Returns a unique index number associated with this field. This is defined implicitly when the .dc file(s) are read.

DCField.has_default_value()¶: Returns true if a default value has been explicitly established for this field, false otherwise.

DCField.is_airecv()¶: Returns true if the “airecv” flag is set for this field, false otherwise.

DCField.is_bogus_field()¶: Returns true if the field has been flagged as a bogus field. This is set for fields that are generated by the parser as placeholder for missing fields, as when reading a partial file; it should not occur in a normal valid dc file.

DCField.is_broadcast()¶: Returns true if the “broadcast” flag is set for this field, false otherwise.

DCField.is_clrecv()¶: Returns true if the “clrecv” flag is set for this field, false otherwise.

DCField.is_clsend()¶: Returns true if the “clsend” flag is set for this field, false otherwise.

DCField.is_db()¶: Returns true if the “db” flag is set for this field, false otherwise.

DCField.is_ownrecv()¶: Returns true if the “ownrecv” flag is set for this field, false otherwise.

DCField.is_ownsend()¶: Returns true if the “ownsend” flag is set for this field, false otherwise.

DCField.is_ram()¶: Returns true if the “ram” flag is set for this field, false otherwise.

DCField.is_required()¶: Returns true if the “required” flag is set for this field, false otherwise.

DCField.output()¶: Write a string representation of this instance to <out>.

DCField.pack_args()¶

DCField.parse_string()¶: Given a human-formatted string (for instance, as returned by format_data(), above) that represents the value of this field, parse the string and return the corresponding packed data. Returns empty string if there is an error.

DCField.receive_update()¶

DCField.unpack_args()¶

DCField.validate_ranges()¶: Verifies that all of the packed values in the field data are within the specified ranges and that there are no extra bytes on the end of the record. Returns true if all fields are valid, false otherwise.

DCField.write()¶: Write a string representation of this instance to <out>.