YIG PLL CAN module device class. More...

#include <carma/antenna/ovro/canbus/YigPll.h>

Inheritance diagram for carma::antenna::ovro::YigPll:

Public Types
enum	LockResult { YIG_LOCKED, YIG_UNLOCKED, YIG_TIMEDOUT }
	Indicates the result of the lockYigFrequency command. More...

typedef enum carma::antenna::ovro::YigPll::LockResult	LockResultType
	Indicates the result of the lockYigFrequency command. More...

Public Member Functions
void	extractTuneTable ()
	Extract the tune table. More...

std::map < carma::canbus::msgType, std::string >	getHalfSecMonitors () const
	Retrieve a map of this devices half second monitor points. More...

std::map < carma::canbus::msgType, std::string >	getSlowMonitors () const
	Return a map of this devices slow monitor points. More...

void	processMsg (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data, bool sim)
	Process a CAN message addressed from the YigPll module. More...

void	setDampingResistance (unsigned short damping)
	Set damping resistance - Engineering only. More...

LockResultType	setYigFrequencyAndLock (double freqInGhz)
	Set the YIG lock frequency and lock. More...

void	setYigFrequencyAndLockNoBlock (double freqInGhz)
	Set the YIG lock frequency and lock. More...

void	setYigFrequencyWithoutLock (double freqInGhz)
	Set the Yig frequency but don't lock - Engineering only. More...

carma::canbus::Message	simulateMsg (carma::canbus::msgType mid)
	Produce a simulated CAN message for a given msgType. More...

void	toggleSweep (bool on)
	Toggle sweep - Engineering only. More...

void	updateFrameData ()
	Update Frame Data. More...

	YigPll (carma::canbus::nodeType node, carma::canbus::CanOutput &io, carma::monitor::OvroSubsystem &mon)
	Constructor. More...

	~YigPll ()
	Destructor. More...

Public Member Functions inherited from carma::canbus::devices::XacDevice
bool	isOnline ()
	Is Device ONLINE? More...

void	reset ()
	Reset the can module via CORBA using Device::softReset() method. More...

virtual void	setState (deviceStateType state)
	Set the state of the device. More...

void	startChannelOneFastSampling (unsigned short fastItem)
	Start fast sampling on channel one with the requested data item. More...

void	startChannelTwoFastSampling (unsigned short fastItem)
	Start fast sampling on channel two with the requested data item. More...

void	stopChannelOneFastSampling ()
	Stop fast sampling on channel one. More...

void	stopChannelTwoFastSampling ()
	Stop fast sampling on channel two. More...

	XacDevice (carma::canbus::apiType api, carma::canbus::nodeType node, carma::canbus::CanOutput &canOutput)
	Constructor. More...

virtual	~XacDevice ()
	Destructor. More...

Public Member Functions inherited from carma::canbus::Device
carma::canbus::Message	createDummyMsg () const
	Create a dummy CAN message. More...

carma::canbus::Message	createMsgToAllNodes (msgType messageId) const
	Create a CAN message addressed to all nodes of this type. More...

carma::canbus::Message	createMsgToHost (msgType messageId) const
	Create a CAN message addressed from this Device to the host. More...

carma::canbus::Message	createMsgToNode (msgType messageId) const
	Create a CAN message addressed to this device from the host. More...

	Device (apiType api, nodeType node, CanOutput &io)
	Device constructor. More...

apiType	getApi () const
	Return api code of device. More...

char	getApiVersion () const
	Get API Version of this Device. More...

boardType	getBoardType () const
	Return board type id of device. More...

busIdType	getBusId () const
	Return bus Id that node resides on. More...

virtual MsgIdInfoMap	getControls () const
	Return a map of devices controls. More...

keyType	getKey () const
	Create a key unique to this api and node. More...

double	getLastRxTime () const
	Get Last RX Time for device. More...

unsigned int	getNlatePackets () const
	Get number of late packets. More...

nodeType	getNode () const
	Return node location code of device. More...

serialNumberType	getSerialNumber () const
	Return serial number of device. More...

deviceStateType	getState () const
	Status access routine. More...

void	reset ()
	Perform a software reset of module. More...

void	setBoardType (boardType bt)
	Set board type of device. More...

void	setBusId (busIdType busId)
	Set busId of device. More...

virtual void	setLastRxTime (double rxMjd)
	Set latest rx time. More...

void	setSerialNumber (serialNumberType sn)
	Set serial number of device. More...

void	startChannelOneFastSampling (unsigned short fastItem)
	Start fast sampling the specified data item on channel 1. More...

void	startChannelTwoFastSampling (unsigned short fastItem)
	Start fast sampling the specified data item on channel 2. More...

void	stopChannelOneFastSampling ()
	Stop fast sampling on channel 1 This routine will stop fast sampling on channel 1 regardless of whether this node is fast sampling the channel or not! In other words the request goes out globally. More...

void	stopChannelTwoFastSampling ()
	Stop fast sampling on channel 2 This routine will stop fast sampling on channel 2 regardless of whether this node is fast sampling the channel or not! In other words the request goes out globally. More...

virtual	~Device ()
	Device destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from carma::canbus::Device
static keyType	createKey (apiType api, nodeType node)

Static Public Attributes inherited from carma::canbus::devices::XacDevice
static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_1 = 0x120

static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_2 = 0x121

static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_3 = 0x122

static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_4 = 0x123

static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_5 = 0x124

Protected Member Functions inherited from carma::canbus::devices::XacDevice
virtual void	initialize ()
	Initialization hook. More...

void	processSystemMonitorPacket (carma::canbus::msgType mid, carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process a system monitor packet. More...

void	processSystemMonitorPacket1 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 1 This routine processes standard system monitor packet 1 and places the data into the input Xac reference. More...

void	processSystemMonitorPacket2 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 2. More...

void	processSystemMonitorPacket3 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 3. More...

void	processSystemMonitorPacket4 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 4. More...

void	processSystemMonitorPacket5 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 5. More...

carma::canbus::Message	simSystemMonitorPacket (carma::canbus::msgType mid)
	Simulate system monitor packet. More...

carma::canbus::Message	simSystemMonitorPacket1 ()
	Simulate System Monitor Packet 1. More...

carma::canbus::Message	simSystemMonitorPacket2 ()
	Simulate System Monitor Packet 2. More...

carma::canbus::Message	simSystemMonitorPacket3 ()
	Simulate System Monitor Packet 3. More...

carma::canbus::Message	simSystemMonitorPacket4 ()
	Simulate System Monitor Packet 4. More...

carma::canbus::Message	simSystemMonitorPacket5 ()
	Simulate System Monitor Packet 5. More...

Protected Member Functions inherited from carma::canbus::Device
void	incrementLatePacketCount ()
	Increment the late packet count by 1. More...

bool	isPacketLate (double window=100.0)
	Determine if the last packet sent from this device was late. More...

void	resetLatePacketCount ()
	Reset the late packet count to 0. More...

void	setApiVersion (char api)
	Set API Version. More...

Static Protected Member Functions inherited from carma::canbus::devices::XacDevice
static bool	isSystemMonitorPacket (carma::canbus::msgType)
	Check that input message type is a system monitor packet. More...

Protected Attributes inherited from carma::canbus::Device
const apiType	api_

CanOutput &	io_
	Reference to CanOutput object. More...

const keyType	key_

const nodeType	node_

Static Protected Attributes inherited from carma::canbus::Device
static const msgType	RESET = 0x0000
	Software reset message id. More...

static const msgType	START_CHANNEL_1_FAST_SAMPLING = 0x0004
	Begin channel 1 fast sampling message id. More...

static const msgType	START_CHANNEL_2_FAST_SAMPLING = 0x0005
	Begin channel 2 fast sampling message id. More...

static const msgType	STOP_CHANNEL_1_FAST_SAMPLING = 0x0002
	Stop channel 1 fast sampling message id. More...

static const msgType	STOP_CHANNEL_2_FAST_SAMPLING = 0x0003

Detailed Description

YIG PLL CAN module device class.

Definition at line 33 of file YigPll.h.

Member Typedef Documentation

typedef enum carma::antenna::ovro::YigPll::LockResult carma::antenna::ovro::YigPll::LockResultType

Indicates the result of the lockYigFrequency command.

Member Enumeration Documentation

enum carma::antenna::ovro::YigPll::LockResult

Indicates the result of the lockYigFrequency command.

Enumerator
YIG_LOCKED	Yig locked successfully.
YIG_UNLOCKED	Yig did not lock (error)
YIG_TIMEDOUT	lockYigFrequency command timed out (error)

Definition at line 107 of file YigPll.h.

Constructor & Destructor Documentation

carma::antenna::ovro::YigPll::YigPll	(	carma::canbus::nodeType	node,
		carma::canbus::CanOutput &	io,
		carma::monitor::OvroSubsystem &	mon
	)

Constructor.

Parameters

node	Location id of this instance (node location id).
io	Reference to CanOutput class.
mon	Reference to OvroSubsystem instance.

carma::antenna::ovro::YigPll::~YigPll ( )

Destructor.

Member Function Documentation

void carma::antenna::ovro::YigPll::extractTuneTable ( )

Extract the tune table.

This command instructs the module to extract the tuning table from the 1-wire device and save it to ram.

std::map<carma::canbus::msgType, std::string> carma::antenna::ovro::YigPll::getHalfSecMonitors ( ) const

virtual

Retrieve a map of this devices half second monitor points.

The monitor points returned from this routine will be simulated if the device is in the OFFLINE state.

Returns: Map with descriptions of the device's half second monitor points keyed by message id.

Implements carma::canbus::Device.

std::map<carma::canbus::msgType, std::string> carma::antenna::ovro::YigPll::getSlowMonitors ( ) const

virtual

Return a map of this devices slow monitor points.

These monitor points will be simulated every 5 seconds if the device is in the OFFLINE state.

Returns: Map with descriptions of the device's slow (5 second) monitor points keyed by message id.

Reimplemented from carma::canbus::devices::XacDevice.

void carma::antenna::ovro::YigPll::processMsg	(	carma::canbus::msgType	mid,
		std::vector< carma::canbus::byteType > &	data,
		bool	sim
	)

virtual

Process a CAN message addressed from the YigPll module.

This routine is responsible for processing all CAN messages addressed to this device. It is essentially a callback routine.

Parameters

mid	the 10bit message id (carma::canbus::msgType).
data	reference to the byte vector containing the raw data.
sim	True if message is simulated, false normally.

See Also: carma::canbus::Device::processMsg

Implements carma::canbus::Device.

void carma::antenna::ovro::YigPll::setDampingResistance ( unsigned short damping )

Set damping resistance - Engineering only.

Sets PLL damping factor.

Parameters

damping Damping factor in Ohms.

LockResultType carma::antenna::ovro::YigPll::setYigFrequencyAndLock ( double freqInGhz )

Set the YIG lock frequency and lock.

This command atomically sets the YIG output frequency, starts the lock sequence and waits for lock to complete. It returns only after the YIG locks, fails to lock or times out.

Parameters

freqInGhz YIG frequency value in GHz.

Returns: lock result.

See Also: setYigFrequency

void carma::antenna::ovro::YigPll::setYigFrequencyAndLockNoBlock ( double freqInGhz )

Set the YIG lock frequency and lock.

This method does not block while waiting for lock to complete.

Parameters

freqInGhz YIG lock frequency in GHz.

See Also: setYigFrequencyAndLock; setYigFrequencyWithoutLock

void carma::antenna::ovro::YigPll::setYigFrequencyWithoutLock ( double freqInGhz )

Set the Yig frequency but don't lock - Engineering only.

Sets the YIG output frequency. The module will NOT try to phase lock.

Parameters

freqInGhz Yig output frequency in GHz

See Also: setYigFrequencyAndLock

carma::canbus::Message carma::antenna::ovro::YigPll::simulateMsg ( carma::canbus::msgType mid )

virtual

Produce a simulated CAN message for a given msgType.

This routine creates a Message with simulated data for an input message id. The returned message is automatically placed in the CAN message queue for retrieval and processing by the Master class. It thus can be used to test the processMsg method above as well as to place real (albeit simulated) data into the monitor stream.

Parameters

mid	10 bit message id (carma::canbus::msgType).

Implements carma::canbus::Device.

void carma::antenna::ovro::YigPll::toggleSweep ( bool on )

Toggle sweep - Engineering only.

Turns the sweep on or off. This is an engineering command. The default sweep mode is on.

Parameters

on	Turn sweep on if true, off if false.

void carma::antenna::ovro::YigPll::updateFrameData ( )

virtual

Update Frame Data.

This method is called (or called back) every 1/2 second in order to allow this class to update monitor data on the frame timescale. Note that this method is called regardless of the modules STATE or the number of messages the device is receiving.

Reimplemented from carma::canbus::Device.

The documentation for this class was generated from the following file:

carma/antenna/ovro/canbus/YigPll.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation