M1M3 Support System
Loading...
Searching...
No Matches
Public Member Functions | List of all members
LSST::M1M3::SS::RaisingLoweringInfo Class Reference

Manipulates RaisingLoweringInfo event fields. More...

#include <RaisingLoweringInfo.h>

Inheritance diagram for LSST::M1M3::SS::RaisingLoweringInfo:
Inheritance graph
[legend]
Collaboration diagram for LSST::M1M3::SS::RaisingLoweringInfo:
Collaboration graph
[legend]

Public Member Functions

 RaisingLoweringInfo (token)
 
void sendUpdates (bool force=false)
 Sends updates to RaisingLoweringInfo structure.
 
float supportRatio ()
 Returns ratio of mirror mass supported.
 
void setTimeTimeout (double new_timeTimeout)
 
void incSupportPercentage ()
 Increases mirrror support percentage by RaiseIncrementPercentage setting value.
 
void decSupportPercentage ()
 Decrements mirror support percentage by LowerDecrementPercentage setting value.
 
void zeroSupportPercentage ()
 Sets support percentage to 0%.
 
void fillSupportPercentage ()
 Sets support percentage to 100%.
 
bool supportPercentageFilled ()
 Is mirror support percentage equal or more than 100%?
 
bool supportPercentageZeroed ()
 Is mirror support percentage less or equal to 0?
 
void setHPWait (size_t hpIndex, bool newWait)
 Sets waitHardpoint field, triggers updates if needed.
 
void setFAXWait (size_t faXIndex, bool newWait)
 
void setFAYWait (size_t faYIndex, bool newWait)
 
void setFAZWait (size_t faZIndex, bool newWait)
 
void setWaitAirPressure (bool newWait)
 Sets waitAirPressure field.
 

Detailed Description

Manipulates RaisingLoweringInfo event fields.

Member Function Documentation

◆ sendUpdates()

void RaisingLoweringInfo::sendUpdates ( bool force = false)

Sends updates to RaisingLoweringInfo structure.

Parameters
forceif true, send updates even when _updated flag is not set
Here is the caller graph for this function:

◆ setWaitAirPressure()

void RaisingLoweringInfo::setWaitAirPressure ( bool newWait)

Sets waitAirPressure field.

Sends update if the value changed.

Parameters
newWaitnew waitAirPressure value.

◆ supportPercentageFilled()

bool RaisingLoweringInfo::supportPercentageFilled ( )

Is mirror support percentage equal or more than 100%?

Returns
true if the mirror is fully supported by target force actuator values.
Here is the caller graph for this function:

◆ supportPercentageZeroed()

bool RaisingLoweringInfo::supportPercentageZeroed ( )

Is mirror support percentage less or equal to 0?

Returns
true if mirror the mirror is not supported by target force actuator values.
Here is the caller graph for this function:

◆ supportRatio()

float LSST::M1M3::SS::RaisingLoweringInfo::supportRatio ( )
inline

Returns ratio of mirror mass supported.

Returns
Mirror supported ration (in 0-1 range, 1 mirror weight fully supported by force actuators)

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