PoDateFormatMapping Class Reference

Node to define date format and mapping. More...

#include <MeshViz/nodes/PoDateFormatMapping.h>

Inheritance diagram for PoDateFormatMapping:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	PoDateFormatMapping ()
	Constructor.
SbBool	getCoordinate (const char *date, float &coord)
	Returns the coordinate associated to a date.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from PoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFString	date1
	Defines the first date for the association between dates and coordinates (date mapping).
SoSFString	date2
	Defines the second date for the association between dates and coordinates (date mapping).
SoSFFloat	coord1
	Defines the first coordinate for the association between dates and coordinates (date mapping).
SoSFFloat	coord2
	Defines the second coordinate for the association between dates and coordinates (date mapping).
SoSFString	format
	Defines the format for dates.

Detailed Description

Node to define date format and mapping.

This node defines the current date format and mapping for all MeshViz representations which use it. This node is used to define date input format and association between dates and coordinates (date mapping).

Date format is defined by a string of characters consisting of only the following letters: ",',h,H, d,D, m,M, y,Y

     "        the date includes a number of seconds defined by a float
              or integer value
     '        the date includes a number of minutes in 1 or 2 characters
     h or H   the date includes an hour in 2 characters
     D        the date includes a day of the week in 3 characters
     d        the date includes a day of the month in 2 characters
     M        the date includes the month defined by its first 4 letters
     m        the date includes the number of the month in 2 characters
     Y        the date includes the year in 4 characters
     y        the date includes the year in the 20th century in 2 characters
              (the last 2)

The date format is as follows

["] ['] [H | h] [d] [D] [m | M] [y | Y] in any order.

The format may include the letters ", ', H or h (exclusive), d, and D, m or M (exclusive), and y or Y (exclusive), but these letters may be in any order. Each letter may only be used once. If the format is incorrect, an error message is generated and the current date format is not modified.

Examples:

     date format      input date       date obtained

     Ddmy             TUE-10-03-92     Tuesday 10 March 1992
     Ddmy             TUE/10 03 92     Tuesday 10 March 1992
     ymd              92/03/10         10 March 1992
     Ymd              1992.03.10       10 March 1992
     dh               10-23            11 p.m. on the 10th
     Y                1992             1992
     MdY              SEPT.23.1992     23 September 1992

Comments:

• days, months and years may be separated by any number of separating characters (any non-alphanumerical character).
• Graph Master always checks the day of the week in relation to the number of days in the month. If the day does not correspond to the number, Graph Master corrects it.
• Graph Master checks the number of the day in the month. If this number is greater than the number of days in that month, Graph Master only takes the last day of the month (taking leap years into account for the month of February)

FILE FORMAT/DEFAULT

PoDateFormatMapping {

date1	"1-01-70"
date2	"2-01-70"
coord1	0
coord2	1
format	"dmy"

}

Definition at line 106 of file PoDateFormatMapping.h.

Constructor & Destructor Documentation

PoDateFormatMapping()

PoDateFormatMapping::PoDateFormatMapping

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType PoDateFormatMapping::getClassTypeId ( )

static

Returns the type identifier for this class.

getCoordinate()

SbBool PoDateFormatMapping::getCoordinate	(	const char *	date,
		float &	coord
	)

Returns the coordinate associated to a date.

Returns

TRUE is returned if the input date is correct,

FALSE otherwise.

getTypeId()

virtual SoType PoDateFormatMapping::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoNode.

Member Data Documentation

coord1

SoSFFloat PoDateFormatMapping::coord1

Defines the first coordinate for the association between dates and coordinates (date mapping).

Definition at line 132 of file PoDateFormatMapping.h.

coord2

SoSFFloat PoDateFormatMapping::coord2

Defines the second coordinate for the association between dates and coordinates (date mapping).

Definition at line 138 of file PoDateFormatMapping.h.

date1

SoSFString PoDateFormatMapping::date1

Defines the first date for the association between dates and coordinates (date mapping).

date1 corresponds to the coord1 and date2 corresponds to the coord2.

Definition at line 120 of file PoDateFormatMapping.h.

date2

SoSFString PoDateFormatMapping::date2

Defines the second date for the association between dates and coordinates (date mapping).

Definition at line 126 of file PoDateFormatMapping.h.

format

SoSFString PoDateFormatMapping::format

Defines the format for dates.

Definition at line 143 of file PoDateFormatMapping.h.

---

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

• MeshViz/nodes/PoDateFormatMapping.h