IMS_ModuleFunctionData_Comm Class Reference

Holds static data to define a communications antena, satelite dish and similar. More...

Inheritance diagram for IMS_ModuleFunctionData_Comm:

Public Member Functions
bool	HasGui ()
	This function serves to check whether a module function has a GUI before creating it. More...
Public Member Functions inherited from IMS_ModuleFunctionData_Base
virtual bool	LoadFromFile (string configfile, IMSFILE cfg)
	Loads the data from config file. More...
FUNCTIONTYPE	GetType ()
string	GetName ()

Private Member Functions
bool	processConfigLine (vector< string > &tokens)
	Receives all lines of the config file that concern this ModuleFunction one by one. More...
bool	validateData (string configfile)
	Validates the data for completeness after loading. More...

Private Attributes
string	trackinganimname = ""
string	deployanimname = ""
string	searchanimname = ""

Friends
class	IMS_ModuleFunction_Comm

Additional Inherited Members
Protected Attributes inherited from IMS_ModuleFunctionData_Base
FUNCTIONTYPE	type
	Stores the type of the ModuleFunction.
string	name = ""
	Stores the Name of the ModuleFunction.

Detailed Description

Holds static data to define a communications antena, satelite dish and similar.

Config parameters

BEGIN_MODULEFUNCTION COMMUNICATION
   [Deploy-anim] = <string id>         //the id of the deployment animation. Optional if the antenna doesn't have a deployment animation.
   [Search_anim] = <string id>         //the id of the scanning animation (continuously rotating dish or similar). Optional if the antenna doesn't have a scanning animation.
   [Tracking_anim] = <string id>       //the id of the tracking animation used to align the antenna with a target. Optional if the antenna doesn't have such an animation.
END_MODULEFUNCTION

Note that the most difficult part of a config file for such a module will be defining the actual animations, but this is covered in the documentation for IMS_ModuleFunctionData_Animation

See also

IMS_ModuleFunction_Animation

Member Function Documentation

bool IMS_ModuleFunctionData_Comm::HasGui ( )

inlinevirtual

This function serves to check whether a module function has a GUI before creating it.

Note

If your ModuleFunction has its own GUI, overload this function and return true, as simple as that.

Returns

Always false

Reimplemented from IMS_ModuleFunctionData_Base.

bool IMS_ModuleFunctionData_Comm::processConfigLine ( vector< string > &  tokens )

privatevirtual

Receives all lines of the config file that concern this ModuleFunction one by one.

Overload this function to receive the relevant data of your module.

Parameters

tokens

a vector of strings that contains the individual parts of the line, delimited by whitespace or '='

Note

Throw runtime_error with an error message if you encounter an invalid line! The message will be loged in Orbiter.log together with the name of the config file.

Returns

true if the passed line was processed, false if not.

Implements IMS_ModuleFunctionData_Base.

bool IMS_ModuleFunctionData_Comm::validateData ( string  configfile )

privatevirtual

Validates the data for completeness after loading.

Implement this function to validate your data at the end of the loading process. Check if everything's there that needs to be, and write log messages if it isn't.

Parameters

configfile

The name of the configfile, so you can add it to your messages so config writers find their mistakes faster.

Returns

False if the modulefunction is unable to function, otherwise return true.

Note

If your Implementation returns false, The loading process will be aborted by forcing orbiter to crash, so be sure to keep your loging straight!

Implements IMS_ModuleFunctionData_Base.

---

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

• C:/Orbiter2016/Orbitersdk/IMS2/IMS_ModuleFunctionData_Comm.h
• C:/Orbiter2016/Orbitersdk/IMS2/IMS_ModuleFunctionData_Comm.cpp