Defs.cxx File Reference

#include "dcc/Defs.hxx"

Go to the source code of this file.

Functions
bool	dcc::Defs::decode_address_partition (uint16_t addr14, uint16_t *addr, uint8_t *partition, dcc::TrainAddressType *atype)
	Decodes a 14-bit address (according to S-9.2.1.1) into an address type and a raw address.

Detailed Description

Copyright

Copyright (c) 2024, Balazs Racz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Helper functions for DCC concepts.

Author

Balazs Racz

Date

7 Jan 2024

Definition in file dcc/Defs.cxx.

Function Documentation

decode_address_partition()

bool dcc::Defs::decode_address_partition	(	uint16_t	addr14,
		uint16_t *	addr,
		uint8_t *	partition,
		dcc::TrainAddressType *	atype
	)

Decodes a 14-bit address (according to S-9.2.1.1) into an address type and a raw address.

Parameters

addr14	a 14-bit address according to S-9.2.1.1
addr	the decoded address value (8 to 14 bits)
partition	the partition of the address type (the top byte, max 6 bits, e.g. ADR_MOBILE_SHORT)
atype	address type enum

Returns

true if the decoding is successful, false if the value is not representable.

Definition at line 42 of file dcc/Defs.cxx.