Class in Zendir.Classes | Inherits from Antenna
Declaration
class Transmitter;Description
This class handles the transmitting of data from some data source and can send out the data to a LinkedBlock that can communicate it over the ether. This requires a connection to some form of receiver.
Properties
| Declared | Description |
|---|---|
| BytesTransmitted | A counter for the number of bytes transmitted over the network. This is thesum of the bytes in the outgoing buffer over time. |
| CanTransmit | A flag that can be overwritten by a power module preventingthe transmission from occurring. |
| ForceTransmit | A flag that when enabled will force a transmission of a message |
| IsTransmitting | A flag for if the transmitter is attempting to transmit data |
| LineLoss | Line Loss from transmitter to antenna |
| NextUplinkTime | The time when the next message can be uplinked |
| NumOutPackets | The number of out messages in the telemetry buffer |
| NumPacketsLoaded | The number of in messages in the transmitter buffer |
| PacketSize | The number of bytes in each packet that is fixed within the packetlist for the data. |
| UplinkedMessage | A flag that specified if a message was uplinked |
| Inherited | Description |
|---|---|
| AntennaGain | Antenna Gain of the transmission |
| Bandwidth | The bandwidth of the targeted frequency |
| Behaviours | A collection of behaviours attached to this object. |
| BitRate | The bit rate of the data being processed. This is either theamount of data that can be transmitted per second or received persecond. |
| CenterOfMassB_B | The center of mass of the component in respect to the bodyframe (B) of the component. This is isolated from any childrenand exists in isolation. |
| CenterOfMassDot_LB_B | The center of mass time-derivative of the component within itsown local coordinates. This does not include any of the sub-componentsand exists in isolation. |
| CenterOfMassDotB_B | The center of mass time-derivative of the component relative tothe body frame (B). This does not include any of the sub-componentsand exists in isolation. |
| CenterOfMassL_L | The center of mass of the component within its own localcoordinates. This does not include any of the sub-components andexists in isolation. |
| CenterOfMassPrime_LB_B | The center of mass general-derivative of the component within itsown local coordinates. This does not include any of the sub-componentsand exists in isolation. |
| CenterOfMassPrimeB_B | [m/s] The center of mass general-derivative of the component relativeto the body frame (B). This does not include any of the sub-componentsand exists in isolation. |
| Children | A collection of children attached to this object. |
| DCM_BN | The rotational DCM matrix between the body frame (B) at the topof this component chain and the inertial frame (N). |
| DCM_LB | The rotational DCM matrix between the component frame of thisobject (L) relative to the body frame (B). |
| DCM_LN | The DCM rotational matrix of the component relative to theinertial origin (N) of the world. |
| DCM_LP | The DCM matrix of the component in the parent’s frame (P), takenfrom the Component Transform (PL). |
| DivergenceAngle | Divergence angle of the antenna |
| Frequency | The targeted frequency for the antenna |
| IsEnabled | Is true if the object is currently enabled. |
| LocalForward | The direction of the transform frame’s forward vector, which is along the Y axis. |
| LocalRight | The direction of the transform frame’s right vector, which is along the X axis. |
| LocalUp | The direction of the transform frame’s up vector, which is along the Z axis. |
| Mass | The component mass defined in the object. This is independentof any parent or children objects and exists in isolation. |
| MassDot | The component mass time-derivative defined in the object. Thisis independent of any parent or children objects and exists in isolation. |
| Models | A collection of models attached to this object. |
| ModelType | Analysis type for the antenna dish |
| MomentOfInertia_LB | The moment of inertia of the component, measured at thelocal center of mass, represented with its own local coordinates.This does not include any of the sub-components and exists inisolation. |
| MomentOfInertiaB_B | The moment of inertia of this component, measured inthe body frame relative to the parented body. This is independentof any children and exists in isolation. |
| MomentOfInertiaPrime_LB | The derivative of the moment of inertia of the component,measured at the local center of mass, represented with its own localcoordinates. This does not include any of the sub-components andexists in isolation. |
| MomentOfInertiaPrimeB_B | The derivative of the moment of inertia of the component,represented in the body frame (B). This is independent and exists inisolation. |
| Name | The display name or tag of this object. |
| NumConnections | Returns the number of connections that are currently valid on the antenna |
| NumLinks | Returns the number of valid links that the antenna have connected |
| OpticalLoss | Optical Loss of the transmission |
| Out_AntennaConfigMsg | The antenna configuration message that contains the dataabout the antenna. |
| Out_ComponentMassMsg | The component mass message defines the set of mass properties andstates of the system within this component locally. This is independentof any parent or children properties or objects. |
| Out_TransformMsg | This defines the base transform message that stores the state of the transform of this object. |
| Parent | The currently attached parent object (if any). |
| PointingLoss | Pointing loss of the transmission |
| Position | [m] The position of the object relative to the parent or to world origin, if no parent exists. |
| Position_BN_N | The position of the body (the root parent B) in theinertial frame relative to the inertial point (N). |
| Position_LB_B | The position of the component relative to the rootobject of this hierarchy. This is in the inertial frameand if the component is the root object, then there willbe no position. |
| Position_LN_N | The position of the inertial world space. This position isderived from the world’s transform (N). |
| Position_LP_P | The position of the object relative to the parented object (P).If there is no parent object, then this will be in the inertialframe. |
| Power | Power of the transmission |
| Root | The root object in the parent chain. |
| Rotation | [-] The rotation of the object relative to the parent or to the world origin, if no parent exists. |
| Thermal | A reference to the thermal model that is attached to this object.This will allow the object to have thermal properties and be ableto be used in thermal simulations. |
| TransmissionType | The transmission type for the antenna. This will define whattype of connection is required. |
Methods
| Declared | Description |
|---|---|
| TransmitBytes | Attempts to transmit a byte array across the network. The data will be convertedto packets in the correct order and transmitted over the network. The key is usedto have an identification of the data, which can provide additional context aboutthe information that is sent, but can be completely optional. |
| TransmitJSON | Attempts to transmit a JSON object across the network. The data will be convertedto packets in the correct order and transmitted over the network. The key is usedto have an identification of the data, which can provide additional context aboutthe information that is sent, but can be completely optional. |
| TransmitMessage | Attempts to transmit a message across the network. The data will be convertedto packets in the correct order and transmitted over the network. The key is usedto have an identification of the data, which can provide additional context aboutthe information that is sent, but can be completely optional. By default, if nokey is present, the key will be the name of the message type. |
| TransmitString | Attempts to transmit a string across the network. The data will be convertedto packets in the correct order and transmitted over the network. The key is usedto have an identification of the data, which can provide additional context aboutthe information that is sent, but can be completely optional. |
| TransmitTimedMessage | Attempts to transmit a message across the network. The data will be convertedto packets in the correct order and transmitted over the network. The key is usedto have an identification of the data, which can provide additional context aboutthe information that is sent, but can be completely optional. By default, if nokey is present, the key will be the name of the message type. This contains anadditional option for a custom time to transmit the message, if it was sent fromanother source. |
| Inherited | Description |
|---|---|
| AddObject | Returns a new simulation object with the specified type. |
| Attach | Attempts to attach this object to a new parent. This will only work if the current object is no parented to anyother object. |
| ConfigureEMLookupTable | Loads the EM signature properties from a CSV table. This will read a CSV fileand will interpolate the data to create a lookup table for the EM signature. |
| ContainsModelWithID | Returns true if an attached model satisfies the specified ID. |
| ContainsModelWithType | Returns true if an attached model satisfies the specified type. |
| Destroy | Removes the current object from the simulation. |
| Detach | This is an action to detach the current object from its parent, if it exists and move it to another object or tojust exist within the simulation. |
| FindBehavioursWithType | Returns all attached behaviours that satisfies the specified type. |
| FindBehaviourWithID | Returns an attached behaviour that satisfies the specified ID. |
| FindBehaviourWithType | Returns an attached behaviour that satisfies the specified type. |
| FindChildrenWithType | Returns all attached children that satisfies the specified type. |
| FindChildWithID | Returns an attached child that satisfies the specified ID. |
| FindChildWithType | Returns an attached child that satisfies the specified type. |
| FindModelsWithType | Returns all attached models that satisfies the specified type. |
| FindModelWithID | Returns an attached model that satisfies the specified ID. |
| FindModelWithType | Returns an attached model that satisfies the specified type. |
| FindParentWithID | Returns an attached parent that satisfies the specified ID. |
| FindParentWithType | Returns an attached parent that satisfies the specified type. |
| FindRootWithID | Returns a root object that satisfies the specified ID. |
| FindRootWithType | Returns a root object that satisfies the specified type. |
| GetLoadedSignaturePattern | Gets the currently loaded RF pattern and returns the datain degrees as an array from 0 to 360. |
| GetModel | Returns a valid assigned model with the specified type. |
| GetWorldTransform | Returns the world transform of the object which is relative to the parent. If no parent exists, this will be thetransform of the object in world space. |
| ReadBodyTransform | This method will reset the dirty flag on the mass so thatit has been read successfully and is valid. |
| UpdateMassProperties | Updates the mass properties of the current physical object ata particular time. |
| UpdatePointingLoss | Updates the pointing loss of the antenna based on the angle ofthe component. |