DtBeamAntennaPatternRecord Class Reference

Instances of DtBeamAntennaPatternRecord are beam antenna pattern records used in conjunction with DtRadioTransmitterStateRepository (TSR). More...

Inheritance diagram for DtBeamAntennaPatternRecord:

Collaboration diagram for DtBeamAntennaPatternRecord:

Public Member Functions
	DtBeamAntennaPatternRecord ()
	default constructor
	DtBeamAntennaPatternRecord (const DtBeamAntennaPatternRecord &orig)
	copy constructor
	DtBeamAntennaPatternRecord (const DtNetBeamAntennaPatternRecord &net)
	copy constructor using Network representation
virtual	~DtBeamAntennaPatternRecord ()
	destructor
DtBeamAntennaPatternRecord &	operator= (const DtBeamAntennaPatternRecord &orig)
	assignment operator
	DtBeamAntennaPatternRecord (const DtAntennaPatternRecord &orig)
	Initialize from DtAntennaPatternRecord.
virtual void	setAngles (const DtTaitBryan &angles)
	Set/Get the beam direction.
virtual const DtTaitBryan &	angles () const
virtual void	setBeamwidth (DtFloat32 azimuth, DtFloat32 elevation)
	Set/Get the azimuth bandwidth and elevation.
virtual DtFloat32	azimuthBeamwidth () const
	Get the azimuth beam bandwidth.
virtual DtFloat32	elevationBeamwidth () const
	Get the elevation beam width.
virtual void	setReferenceSystem (const DtReferenceSys sys)
	Set/Get the beam reference system.
virtual DtReferenceSys	referenceSystem () const
virtual void	setElectricField (DtFloat32 z, DtFloat32 x)
	Set electric field.
virtual DtFloat32	electricFieldZ () const
	Get electric field Z.
virtual DtFloat32	electricFieldX () const
	Get electric field X.
virtual void	setPhase (DtFloat32 phase)
	Set/Get the phase.
virtual DtFloat32	phase () const
virtual void	printData () const
	Print the class data.
virtual void	printDataToStream (std::ostream &stream) const
virtual DtAntennaPatternRecord *	clone () const
	Returns a clone of the instance.
virtual void	setFromNet (const void *net, int size)
	Set from network representation.
virtual const void *	netRep (int *size=NULL) const
	Returns network representation, fills size with size of netRep.
virtual int	netSize () const
	Returns size of network representation.
virtual void	setFromNetBeam (const DtNetBeamAntennaPatternRecord &net)
	Set from network representation.
virtual void	setFromNet (const DtNetBeamAntennaPatternRecord &net)
	Also sets from network representation.
virtual const DtNetBeamAntennaPatternRecord &	netBeam () const
	Returns network representation.
virtual const DtNetBeamAntennaPatternRecord &	networkRepresentation () const
	Also returns network representation.
Public Member Functions inherited from DtAntennaPatternRecord
	DtAntennaPatternRecord ()
	default constructor
	DtAntennaPatternRecord (const DtAntennaPatternRecord &orig)
	copy constructor
virtual	~DtAntennaPatternRecord ()
	destructor
DtAntennaPatternRecord &	operator= (const DtAntennaPatternRecord &orig)
	assignment operator
bool	operator== (const DtAntennaPatternRecord &orig) const
	equality operator
bool	operator!= (const DtAntennaPatternRecord &orig) const
	inequality operator

Protected Attributes
DtTaitBryan	myBeamDirection
DtFloat32	myAzimuthBandwidth
DtFloat32	myElevationBeamwidth
DtReferenceSys	myReferenceSystem
DtFloat32	myEz
DtFloat32	myEx
DtFloat32	myPhase
DtNetBeamAntennaPatternRecord	myNetBeam
Protected Attributes inherited from DtAntennaPatternRecord
char *	myNetRep
int	myNetSize

Detailed Description

Instances of DtBeamAntennaPatternRecord are beam antenna pattern records used in conjunction with DtRadioTransmitterStateRepository (TSR).

A DtAntennaPatternRecord obtained using the TSR's antennaPattern() inspector can be used to initialize a DtBeamAntennaPatternRecord, whose inspectors you can then use to view the data (assuming the AntennaPattern Record really contained BeamAntennaPattern data. Similarly, a DtBeamAntennaPatternRecord can be filled out and passed to TSR's setAntennaPattern.

Constructor & Destructor Documentation

DtBeamAntennaPatternRecord::DtBeamAntennaPatternRecord

(

)

default constructor

DtBeamAntennaPatternRecord::DtBeamAntennaPatternRecord

(

const DtBeamAntennaPatternRecord &

orig

)

copy constructor

DtBeamAntennaPatternRecord::DtBeamAntennaPatternRecord

(

const DtNetBeamAntennaPatternRecord &

net

)

copy constructor using Network representation

virtual DtBeamAntennaPatternRecord::~DtBeamAntennaPatternRecord ( )

virtual

destructor

DtBeamAntennaPatternRecord::DtBeamAntennaPatternRecord

(

const DtAntennaPatternRecord &

orig

)

Initialize from DtAntennaPatternRecord.

Member Function Documentation

virtual const DtTaitBryan& DtBeamAntennaPatternRecord::angles ( ) const

virtual

virtual DtFloat32 DtBeamAntennaPatternRecord::azimuthBeamwidth ( ) const

virtual

Get the azimuth beam bandwidth.

virtual DtAntennaPatternRecord* DtBeamAntennaPatternRecord::clone ( ) const

virtual

Returns a clone of the instance.

Reimplemented from DtAntennaPatternRecord.

virtual DtFloat32 DtBeamAntennaPatternRecord::electricFieldX ( ) const

virtual

Get electric field X.

virtual DtFloat32 DtBeamAntennaPatternRecord::electricFieldZ ( ) const

virtual

Get electric field Z.

virtual DtFloat32 DtBeamAntennaPatternRecord::elevationBeamwidth ( ) const

virtual

Get the elevation beam width.

virtual const DtNetBeamAntennaPatternRecord& DtBeamAntennaPatternRecord::netBeam ( ) const

virtual

Returns network representation.

Referenced by networkRepresentation().

virtual const void* DtBeamAntennaPatternRecord::netRep ( int *  size = NULL ) const

virtual

Returns network representation, fills size with size of netRep.

Reimplemented from DtAntennaPatternRecord.

virtual int DtBeamAntennaPatternRecord::netSize ( ) const

virtual

Returns size of network representation.

Reimplemented from DtAntennaPatternRecord.

const DtNetBeamAntennaPatternRecord & DtBeamAntennaPatternRecord::networkRepresentation ( ) const

inlinevirtual

Also returns network representation.

This function is here for backwards compatibility with pre-3.3 releases.

References netBeam().

DtBeamAntennaPatternRecord& DtBeamAntennaPatternRecord::operator=

(

const DtBeamAntennaPatternRecord &

orig

)

assignment operator

virtual DtFloat32 DtBeamAntennaPatternRecord::phase ( ) const

virtual

virtual void DtBeamAntennaPatternRecord::printData ( ) const

virtual

Print the class data.

Reimplemented from DtAntennaPatternRecord.

virtual void DtBeamAntennaPatternRecord::printDataToStream ( std::ostream &  stream ) const

virtual

Reimplemented from DtAntennaPatternRecord.

virtual DtReferenceSys DtBeamAntennaPatternRecord::referenceSystem ( ) const

virtual

virtual void DtBeamAntennaPatternRecord::setAngles ( const DtTaitBryan &  angles )

virtual

Set/Get the beam direction.

virtual void DtBeamAntennaPatternRecord::setBeamwidth ( DtFloat32  azimuth, DtFloat32  elevation  )

virtual

Set/Get the azimuth bandwidth and elevation.

virtual void DtBeamAntennaPatternRecord::setElectricField ( DtFloat32  z, DtFloat32  x  )

virtual

Set electric field.

virtual void DtBeamAntennaPatternRecord::setFromNet ( const void *  net, int  size  )

virtual

Set from network representation.

Reimplemented from DtAntennaPatternRecord.

void DtBeamAntennaPatternRecord::setFromNet ( const DtNetBeamAntennaPatternRecord &  net )

inlinevirtual

Also sets from network representation.

This function is here for backwards compatibility with pre-3.3 releases.

References setFromNetBeam().

virtual void DtBeamAntennaPatternRecord::setFromNetBeam ( const DtNetBeamAntennaPatternRecord &  net )

virtual

Set from network representation.

Referenced by setFromNet().

virtual void DtBeamAntennaPatternRecord::setPhase ( DtFloat32  phase )

virtual

Set/Get the phase.

virtual void DtBeamAntennaPatternRecord::setReferenceSystem ( const DtReferenceSys  sys )

virtual

Set/Get the beam reference system.

Member Data Documentation

DtFloat32 DtBeamAntennaPatternRecord::myAzimuthBandwidth

protected

DtTaitBryan DtBeamAntennaPatternRecord::myBeamDirection

protected

DtFloat32 DtBeamAntennaPatternRecord::myElevationBeamwidth

protected

DtFloat32 DtBeamAntennaPatternRecord::myEx

protected

DtFloat32 DtBeamAntennaPatternRecord::myEz

protected

DtNetBeamAntennaPatternRecord DtBeamAntennaPatternRecord::myNetBeam

protected

DtFloat32 DtBeamAntennaPatternRecord::myPhase

protected

DtReferenceSys DtBeamAntennaPatternRecord::myReferenceSystem

protected

---

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

• beamAntennaPatternRecord.h