Record Class Particle

java.lang.Object

java.lang.Record

gaiasky.scene.record.Particle

Record Components:

id - The particle identifier.

names - The name array.

x - X component of position vector at epoch.

y - Y component of position vector at epoch.

z - Z component of position vector at epoch.

extra - Map with extra attributes.

All Implemented Interfaces:

IParticleRecord

public record Particle(long id, String[] names, double x, double y, double z, com.badlogic.gdx.utils.ObjectMap<UCD,Object> extra)
extends Record
implements IParticleRecord

Record class to store particles of all kinds.

Field Summary

Fields inherited from interface IParticleRecord

aux3d1, aux3d2

Modifier and Type	Field	Description
static final TLV3D	aux3d1
static final TLV3D	aux3d2

Constructor Summary

Constructors

Constructor	Description
Particle(long id, String[] names, double x, double y, double z)	Constructor for particles or stars.
Particle(long id, String[] names, double x, double y, double z, com.badlogic.gdx.utils.ObjectMap<UCD,Object> extra)	Creates an instance of a Particle record class.

Method Summary

Modifier and Type	Method	Description
float	absMag()
float	appMag()
float	color()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
com.badlogic.gdx.utils.ObjectMap<UCD,Object>	extra()	Returns the value of the extra record component.
com.badlogic.gdx.utils.ObjectMap.Keys<UCD>	extraKeys()
com.badlogic.gdx.utils.ObjectMap<UCD,Object>	getExtra()	Gets the extra attributes map.
Object	getExtra(UCD ucd)	Gets the extra data filed with the given UCD.
Object	getExtra(String name)	Gets the extra data filed with the given name.
double	getExtraNumber(UCD ucd)	Gets the extra data filed with the given UCD, as a double number.
double	getExtraNumber(String name)	Gets the extra data filed with the given name, as a double number.
ParticleType	getType()	Returns the particle record type.
boolean	hasColor()
boolean	hasExtra()
boolean	hasExtra(UCD ucd)
boolean	hasExtra(String name)
final int	hashCode()	Returns a hash code value for this object.
boolean	hasName(String candidate)
boolean	hasName(String candidate, boolean matchCase)
boolean	hasProperMotion()
boolean	hasSize()
long	id()	Returns the value of the id record component.
String[]	names()	Returns the value of the names record component.
String	namesConcat()
double	radius()
double[]	rgb()
void	setExtraAttributes(com.badlogic.gdx.utils.ObjectMap<UCD,Object> e)
float	size()
final String	toString()	Returns a string representation of this record class.
float	vx()
float	vy()
float	vz()
double	x()	Returns the value of the x record component.
double	y()	Returns the value of the y record component.
double	z()	Returns the value of the z record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IParticleRecord

argOfPericenter, ascendingNode, b, beta, dec, distance, eccentricity, epoch, hip, inclination, isVariable, l, lambda, meanAnomaly, muAlpha, muDelta, nVari, parallax, period, pos, ra, radVel, semiMajorAxis, tEff, variMags, variTimes

Modifier and Type	Method	Description
default double	argOfPericenter()
default double	ascendingNode()
default double	b()
default double	beta()
default double	dec()
default double	distance()
default double	eccentricity()
default double	epoch()
default int	hip()
default double	inclination()
default boolean	isVariable()	Returns whether this particle record has a Variable attached, making it a variable star.
default double	l()
default double	lambda()
default double	meanAnomaly()
default float	muAlpha()
default float	muDelta()
default int	nVari()
default double	parallax()
default double	period()
default Vector3D	pos(Vector3D aux)
default double	ra()
default float	radVel()
default double	semiMajorAxis()
default float	tEff()
default float[]	variMags()
default double[]	variTimes()

Constructor Details

Particle

public Particle(long id,
 String[] names,
 double x,
 double y,
 double z)

Constructor for particles or stars. Pass in the lists directly.

Particle

public Particle(long id,
 String[] names,
 double x,
 double y,
 double z,
 com.badlogic.gdx.utils.ObjectMap<UCD,Object> extra)

Creates an instance of a Particle record class.

Parameters:

id - the value for the id record component

names - the value for the names record component

x - the value for the x record component

y - the value for the y record component

z - the value for the z record component

extra - the value for the extra record component

Method Details

getType

public ParticleType getType()

Description copied from interface: IParticleRecord

Returns the particle record type.

Specified by:

getType in interface IParticleRecord

Returns:

The type.

hasProperMotion

public boolean hasProperMotion()

Specified by:

hasProperMotion in interface IParticleRecord

vx

public float vx()

Specified by:

vx in interface IParticleRecord

vy

public float vy()

Specified by:

vy in interface IParticleRecord

vz

public float vz()

Specified by:

vz in interface IParticleRecord

names

public String[] names()

Returns the value of the names record component.

Specified by:

names in interface IParticleRecord

Returns:

the value of the names record component

namesConcat

public String namesConcat()

Specified by:

namesConcat in interface IParticleRecord

hasName

public boolean hasName(String candidate)

Specified by:

hasName in interface IParticleRecord

hasName

public boolean hasName(String candidate,
 boolean matchCase)

Specified by:

hasName in interface IParticleRecord

setExtraAttributes

public void setExtraAttributes(com.badlogic.gdx.utils.ObjectMap<UCD,Object> e)

Specified by:

setExtraAttributes in interface IParticleRecord

hasExtra

public boolean hasExtra()

Specified by:

hasExtra in interface IParticleRecord

hasExtra

public boolean hasExtra(String name)

Specified by:

hasExtra in interface IParticleRecord

hasExtra

public boolean hasExtra(UCD ucd)

Specified by:

hasExtra in interface IParticleRecord

getExtra

public com.badlogic.gdx.utils.ObjectMap<UCD,Object> getExtra()

Description copied from interface: IParticleRecord

Gets the extra attributes map.

Specified by:

getExtra in interface IParticleRecord

Returns:

The map.

getExtra

public Object getExtra(String name)

Description copied from interface: IParticleRecord

Gets the extra data filed with the given name.

Specified by:

getExtra in interface IParticleRecord

Parameters:

name - The name of the data filed to get.

Returns:

The data field, or null if it does not exist.

getExtra

public Object getExtra(UCD ucd)

Description copied from interface: IParticleRecord

Gets the extra data filed with the given UCD.

Specified by:

getExtra in interface IParticleRecord

Parameters:

ucd - The UCD of the data filed to get.

Returns:

The data field, or null if it does not exist.

getExtraNumber

public double getExtraNumber(String name)

Description copied from interface: IParticleRecord

Gets the extra data filed with the given name, as a double number.

Specified by:

getExtraNumber in interface IParticleRecord

Parameters:

name - The name of the data filed to get.

Returns:

The data field as a double, or NaN if it does not exist or is not a number.

getExtraNumber

public double getExtraNumber(UCD ucd)

Description copied from interface: IParticleRecord

Gets the extra data filed with the given UCD, as a double number.

Specified by:

getExtraNumber in interface IParticleRecord

Parameters:

ucd - The UCD of the data filed to get.

Returns:

The data field as a double, or NaN if it does not exist or is not a number.

extraKeys

public com.badlogic.gdx.utils.ObjectMap.Keys<UCD> extraKeys()

Specified by:

extraKeys in interface IParticleRecord

appMag

public float appMag()

Specified by:

appMag in interface IParticleRecord

absMag

public float absMag()

Specified by:

absMag in interface IParticleRecord

hasColor

public boolean hasColor()

Specified by:

hasColor in interface IParticleRecord

color

public float color()

Specified by:

color in interface IParticleRecord

rgb

public double[] rgb()

Specified by:

rgb in interface IParticleRecord

hasSize

public boolean hasSize()

Specified by:

hasSize in interface IParticleRecord

size

public float size()

Specified by:

size in interface IParticleRecord

radius

public double radius()

Specified by:

radius in interface IParticleRecord

id

public long id()

Returns the value of the id record component.

Specified by:

id in interface IParticleRecord

Returns:

the value of the id record component

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

x

public double x()

Returns the value of the x record component.

Specified by:

x in interface IParticleRecord

Returns:

the value of the x record component

y

public double y()

Returns the value of the y record component.

Specified by:

y in interface IParticleRecord

Returns:

the value of the y record component

z

public double z()

Returns the value of the z record component.

Specified by:

z in interface IParticleRecord

Returns:

the value of the z record component

extra

public com.badlogic.gdx.utils.ObjectMap<UCD,Object> extra()

Returns the value of the extra record component.

Returns:

the value of the extra record component